446 lines
14 KiB
Plaintext
446 lines
14 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2022, The Funkwhale Collective
|
|
# This file is distributed under the same license as the funkwhale package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: funkwhale 1.2.3\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2022-04-04 09:00+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../user_documentation/info/cli.rst:2
|
|
msgid "Funkwhale CLI"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:4
|
|
msgid "`Funkwhale CLI <https://dev.funkwhale.audio/funkwhale/cli/>`_ is a command-line interface you can install on your local computer to interact with any Funkwhale server via the REST API. It's especially useful if you need to do repetitive operations or write scripts that interact with Funkwhale servers."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:8
|
|
msgid "Here is a (non-exhaustive) list of operations you can perform via the CLI:"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:10
|
|
msgid "Manage libraries"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:11
|
|
msgid "Upload local files"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:12
|
|
msgid "Retrieve and search tracks, albums and artists"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:13
|
|
msgid "Download tracks"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:14
|
|
msgid "Manage playlists"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:15
|
|
msgid "Manage favorites"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:17
|
|
msgid "Table of Contents"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:20
|
|
msgid "Installation"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:22
|
|
msgid "We provide a prebuilt binary for Linux::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:27
|
|
msgid "You can also install from source with::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:34
|
|
msgid "Installing from source requires you have Python 3.6 or higher available."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:36
|
|
msgid "You can check the installation was successful by running ``funkwhale --help``. This should output the list of available commands and the CLI description."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:40
|
|
msgid "Basic usage"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:42
|
|
msgid "Here are a couple of commands you can try to get started:"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:56
|
|
msgid "Getting help"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:58
|
|
msgid "The most basic way to get help is to run ``funkwhale --help``. It will list available commands, namespaces and arguments that are common to all commands."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:60
|
|
msgid "You can also append the ``--help`` flag after any command to get more information about its arguments and options, like this: ``funkwhale albums ls --help``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:62
|
|
msgid "The CLI offers nested commands. For instance, ``funkwhale albums`` isn't a valid command in itself, but a namespace for all albums-related commands."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:64
|
|
msgid "To get the help of a specific namespace and list all its available commands, simply run ``funkwhale <namespace> --help``."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:67
|
|
msgid "Authentication"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:69
|
|
msgid "The CLI uses JWT tokens to interact with the API. You can either:"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:71
|
|
msgid "Run ``funkwhale login``, which will ask you your Funkwhale username and password and store a JWT token in your local keyring. This token will be used automatically afterwards."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:72
|
|
msgid "Explicitly pass a token to the command via the ``-t`` flag or the ``FUNKWHALE_TOKEN`` environment variable"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:74
|
|
msgid "If you use ``funkwhale login``, you can delete the local token with ``funkwhale logout``."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:76
|
|
msgid "You can check that you are fully authenticated by running ``funkwhale users me``. It will display information relating to your user profile."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:79
|
|
msgid "Configuration"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:81
|
|
msgid "To work, the CLI needs to be pointed to a Funkwhale server. This can be done in various ways:"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:83
|
|
msgid "Via the ``-H https://funkwhale.domain`` flag when calling the CLI"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:84
|
|
msgid "Via the ``FUNKWHALE_SERVER_URL`` environment variable"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:85
|
|
msgid "Via an env file (see below)"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:88
|
|
msgid "Env file"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:90
|
|
msgid "The CLI will try to read configuration options from a ``.env`` file in the current directory. If this file is not present, it will read the configuration options from ``~/.config/funkwhale/env`` on Linux or ``~/Library/Application Support/funkwhale/env`` on macOS."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:92
|
|
msgid "You can also give it a path to another env file via the ``-e /path/to/.envfile`` flag or the ``ENV_FILE`` environment variable."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:94
|
|
msgid "An env file simply contains a list of variables, using the same syntax as environment variables (comments starting with # are allowed). Example::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:101
|
|
msgid "List of configuration options"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:104
|
|
msgid "CLI Flag"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:104
|
|
msgid "Environment variable"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:104
|
|
msgid "Example value"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:104
|
|
msgid "Description"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:106
|
|
msgid "``-e``, ``--env-file``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:106
|
|
msgid "``ENV_FILE``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:106
|
|
msgid "``~/Music/.env``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:106
|
|
msgid "Path to a local env file to use for configuration"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:108
|
|
msgid "``-H``, ``--url``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:108
|
|
msgid "``FUNKWHALE_SERVER_URL``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:108
|
|
msgid "``https://demo.funkwhale.audio``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:108
|
|
msgid "The URL of the Funkwhale server the CLI should contact"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:110
|
|
msgid "``-t``, ``--token``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:110
|
|
msgid "``FUNKWHALE_TOKEN``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:110
|
|
msgid "``eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:110
|
|
msgid "A JWT token to use for authentication"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:112
|
|
msgid "``--no-login``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:112
|
|
msgid "``FUNKWHALE_NO_LOGIN``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:112
|
|
#: ../../user_documentation/info/cli.rst:117
|
|
msgid "``true``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:112
|
|
msgid "Completely disable authentication and keyring"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:114
|
|
msgid "``-v``, ``--verbosity``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:114
|
|
msgid "One of ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` or ``DEBUG``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:114
|
|
msgid "Control the verbosity (default is INFO)"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:117
|
|
msgid "``-q``, ``--quiet``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:117
|
|
msgid "``FUNKWHALE_QUIET``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:117
|
|
msgid "Completely disable logging"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:121
|
|
msgid "Read commands"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:123
|
|
msgid "All commands that list results - such as ``funkwhale albums ls`` or ``funkwhale tracks ls`` - share similar behaviors and sets of arguments."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:126
|
|
msgid "Filtering"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:128
|
|
msgid "Results can be filtered using the ``-f`` or ``--filter`` flag. Provided values are transmitted directly in the querystring when the requests to the API is made::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:133
|
|
msgid "The flag can be provided multiple times, to add multiple filter conditions::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:140
|
|
msgid "The list of supported fields for filtering depends on the resource being queried, and can be found in our `API documentation`_."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:144
|
|
msgid "Searching"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:146
|
|
msgid "Any text provided after the ``ls`` command will be considered a search query and transmitted to the API::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:153
|
|
msgid "This is technically equivalent to filtering with a ``q`` parameter as described above::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:159
|
|
msgid "Ordering"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:161
|
|
msgid "You can control the ordering of the results with the `-o` or ``--ordering`` flag::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:168
|
|
msgid "Ordering in descending order is supported by prefixing the field name with ``-``, e.g: ``-o -creation_date``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:172
|
|
msgid "The list of supported fields for ordering depends on the resource being queried, and can be found in our `API documentation`_."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:176
|
|
msgid "Pagination"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:178
|
|
msgid "You can retrieve a specific result page using the ``-p`` or ``--page`` flag::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:183
|
|
msgid "You can also alter the size of the pages using the ``-s`` or ``--page-size`` flag::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:188
|
|
msgid "Sometimes, you may want to retrieve multiple pages of results at once. This is supported using the ``-l`` or ``--limit`` flag::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:193
|
|
msgid "You can, of course, combine these flags::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:199
|
|
msgid "Output"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:201
|
|
msgid "While the default output displays a human-readable table, you can customize it."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:203
|
|
msgid "The ``--raw`` flag will simply output the raw JSON payload returned by the API server::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:207
|
|
msgid "The ``-h`` or ``--no-headers`` flag simply removes the table column headers."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:209
|
|
msgid "The ``-t`` or ``--format`` flag alters the rendering of result, depending on the provided value::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:216
|
|
msgid "Available formats are: ``fancy_grid``, ``github``, ``grid``, ``html``, ``jira``, ``latex``, ``latex_booktabs``, ``latex_raw``, ``mediawiki``, ``moinmoin``, ``orgtbl``, ``pipe``, ``plain``, ``presto``, ``psql``, ``rst``, ``simple``, ``textile``, ``tsv``, ``youtrack``"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:218
|
|
msgid "The ``-c`` or ``--column`` flag gives you control on the displayed columns::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:223
|
|
msgid "For a given resource, the list of available columns can be found by running ``funkwhale <resource> ls --help``."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:225
|
|
msgid "The ``-i`` or ``--ids`` flag displays only the IDs of results, one per line::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:229
|
|
msgid "This is especially useful in conjunction with other commands (like deletion commands) and piping. Note that this is also technically equivalent to applying the ``--no-headers``, ``--format plain`` and ``--column ID`` flags."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:233
|
|
msgid "Write commands"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:236
|
|
msgid "Deleting objects"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:238
|
|
msgid "Some resources support deletion, via commands such as ``funkwhale libraries rm`` or ``funkwhale playlists rm``, followed by one or more IDs::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:243
|
|
msgid "By default, the ``rm`` command will ask for confirmation, but you can disable this behavior by providing the ``--no-input`` flag."
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:249
|
|
msgid "Examples"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:252
|
|
msgid "Uploading local files"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:254
|
|
msgid "**Goal**: create a library and upload all MP3 files from ``~/Music`` to it"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:256
|
|
#: ../../user_documentation/info/cli.rst:268
|
|
#: ../../user_documentation/info/cli.rst:284
|
|
#: ../../user_documentation/info/cli.rst:301
|
|
msgid "**Commands**::"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:264
|
|
msgid "Favorite an entire album"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:266
|
|
msgid "**Goal**: retrieve all the tracks from an album and add these to your favorites"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:280
|
|
msgid "Mirror an artist discography locally"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:282
|
|
msgid "**Goal**: Download the discography of an artist locally, in the ``~/Music`` directory, in an ``Artist/Album/Track`` folder hierarchy"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:297
|
|
msgid "Open a remote album in VLC"
|
|
msgstr ""
|
|
|
|
#: ../../user_documentation/info/cli.rst:299
|
|
msgid "**Goal**: Variation of the previous example, but instead of downloading an artist discography, we listen to an album in VLC"
|
|
msgstr ""
|