1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-11-14 14:12:17 +00:00
supysonic/docs/man/supysonic-cli.rst

72 lines
1.7 KiB
ReStructuredText

=============
supysonic-cli
=============
-------------------------------------------
Supysonic management command line interface
-------------------------------------------
:Author: Louis-Philippe Véronneau, Alban Féron
:Date: 2019, 2021
:Manual section: 1
Synopsis
========
| ``supysonic-cli --help``
| ``supysonic-cli`` [`subcommand`]
Description
===========
Supysonic is a Python implementation of the Subsonic server API.
Current supported features are:
| * browsing (by folders or tags)
| * streaming of various audio file formats
| * transcoding
| * user or random playlists
| * cover arts (as image files in the same folder as music files)
| * starred tracks/albums and ratings
| * Last.FM scrobbling
| * Jukebox mode
The "Subsonic API" is a set of adhoc standards to browse, stream or download a
music collection over HTTP.
The command-line interface is an interface allowing administration operations
without the use of the web interface.
Options
=======
-h, --help
Shows the help and exits. At top level it only lists the subcommands. To
display the help of a specific subcommand, add the ``--help`` flag *after*
the said subcommand name.
Subcommands
===========
``supysonic-cli`` has two different subcommands:
``user`` `args` ...
User management commands
``folder`` `args` ...
Folder managemnt commands
For more details on the ``user`` and ``folder`` subcommands, see the
``subsonic-cli-user``\ (1), ``subsonic-cli-folder``\ (1) manual pages.
Bugs
====
Bugs can be reported to your distribution's bug tracker or upstream
at https://github.com/spl0k/supysonic/issues.
See Also
========
``supysonic-cli-user``\ (1), ``supysonic-cli-folder``\ (1)