docs(cli): stop the group descriptions from going stale

Each of the three groups listed its subcommands by hand, and all three lists had
drifted: `get` advertised a `current-file-path` that does not exist while
omitting tracks, outputs, hotkeys and both new volumes; `set` omitted loop,
output and hotkeys; `action` omitted kill, toggle-loop and the hotkey commands.

Replaced the hand-kept lists with a short description of what each group is for.
Clap already prints the real subcommands underneath, so duplicating them in the
parent was guaranteed to rot.

Also `save-daemon-config`, an action, was described as "Daemon configuration",
which says nothing about what it does.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
2026-07-26 21:49:40 +03:00
co-authored by Claude Opus 5
parent 2073a410e8
commit 425c1df61e
+4 -4
View File
@@ -15,17 +15,17 @@ struct Cli {
#[derive(Subcommand, Debug)]
enum Commands {
/// Perform an action (ping, pause, resume, toggle-pause, stop, play)
/// Tell the player to do something: play, stop, pause, manage hotkeys
Action {
#[clap(subcommand)]
action: Actions,
},
/// Get information from the player (is paused, volume, position, duration, state, current-file-path, input, inputs)
/// Read player state: volumes, position, tracks, devices, hotkeys
Get {
#[clap(subcommand)]
parameter: GetCommands,
},
/// Set information in the player (volume, position, input)
/// Change player settings: volumes, position, devices, loop, hotkeys
Set {
#[clap(subcommand)]
parameter: SetCommands,
@@ -69,7 +69,7 @@ enum Actions {
#[clap(short, long)]
id: Option<u32>,
},
/// Daemon configuration
/// Write the daemon's current settings to disk
SaveDaemonConfig,
/// Play a sound by hotkey slot name
PlayHotkey { slot: String },