1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-11-10 04:02:17 +00:00
supysonic/docs/man/supysonic-cli.rst
2021-01-03 16:34:29 +01:00

70 lines
1.8 KiB
ReStructuredText

=============
supysonic-cli
=============
------------------------------------------------
Python implementation of the Subsonic server API
------------------------------------------------
:Author: Louis-Philippe Véronneau, Alban Féron
:Date: 2019, 2021
:Manual section: 1
Synopsis
========
| ``supysonic-cli`` [`subcommand`]
| ``supysonic-cli help`` [`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. If ran without arguments,
``supysonic-cli`` will open an interactive prompt, with arguments it will run
a single command and exit.
Subcommands
===========
``supysonic-cli`` has three different subcommands:
``help`` [`subcommand`]
When used without argument, displays the list of available subcommands. With
an argument, shows the help and arguments for the given subcommand.
``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)