mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-24 19:06:19 +00:00
Updated Command Line Interface (markdown)
parent
73b9300a2b
commit
9a1d4fc1e0
@ -1,37 +1 @@
|
||||
The command-line interface (or CLI, *cli.py*) is Python script allowing administration operations without
|
||||
the use of the web interface. It can either be run in interactive mode (`python cli.py`) or to issue a
|
||||
single command (`python cli.py <arguments>`).
|
||||
|
||||
Command reference
|
||||
-----------------
|
||||
|
||||
* **help**: displays the list of available commands
|
||||
* **help command [..]**: displays the help on a specific command (or subcommand)
|
||||
* **user args...**: User management
|
||||
* **list**: lists users
|
||||
* **add name [-a] [-p pass] [-e email]**: adds a user
|
||||
* **-a/--admin**: gives admin rights to the new user
|
||||
* **-p/--password pass**: specifies the user's password. Will be prompted if omitted.
|
||||
* **-e/--email email**: sets the user's email address
|
||||
* **delete user**: deletes the user
|
||||
* **setadmin user [--off]**: grants/revoke admin rights
|
||||
* **--off**: revokes admin rights if present, grants them otherwise
|
||||
* **changepass user [password]**: changes a user's password
|
||||
* **password**: specifies the new password. Will be prompted if omitted
|
||||
* **folder args**: Folder management
|
||||
* **list**: lists folders
|
||||
* **add name path**: adds a folder
|
||||
* **delete folder**: deletes a folder
|
||||
* **scan [folder [folder ...]]**: runs a scan on specified folders
|
||||
* **folder ...**: folders to be scanned. If none, all folders are scanned.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Examples are given as if issued in interactive mode (including the CLI prompt).
|
||||
|
||||
supysonic> help
|
||||
supysonic> help user
|
||||
supysonic> user add spl0k -a -p MyAwesomePassword
|
||||
supysonic> folder add MyLibrary /home/spl0k/Music
|
||||
supysonic> folder scan MyLibrary
|
||||
Moved to [docs/cli.md](https://github.com/spl0k/supysonic/blob/master/docs/cli.md)
|
Loading…
Reference in New Issue
Block a user