id       = "cmus"
name     = "cmus"
homepage = "https://cmus.github.io/"
executables   = ["cmus"]
platforms = ["macos", "linux"]

[dotfiles]

# The cmus manual documents $XDG_CONFIG_HOME/cmus/rc as static user config and
# autosave as generated state. Themes in the same directory are user content;
# autosave is excluded because cmus rewrites it on exit.
# https://manpages.ubuntu.com/manpages/jammy/man1/cmus.1.html
paths = ["[configHome]/cmus/"]
exclude = [
  "[configHome]/cmus/autosave",
]
secret = []

[commands]
format = 1
label = "Start cmus"
description = "Start the cmus music player or list its plugins."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "help"
kind = "manual"
url = "https://github.com/cmus/cmus/blob/master/Doc/cmus.txt"
revision = "2026-10-27"
evidence = """
cmus [options]
--listen ADDR   Listen on ADDR (UNIX socket) instead of $CMUS_SOCKET or $XDG_RUNTIME_DIR/cmus-socket.
--plugins   List available plugins and exit.
--show-cursor   Always display the cursor. This is useful for screen readers.
"""

[[commands.field]]
id = "listen"
label = "Listen address"
description = "UNIX socket or host[:port]. host[:port] is insecure."
type = "string"
option = ["--listen"]
sources = ["help"]

[[commands.field]]
id = "show_cursor"
label = "Always show cursor"
type = "boolean"
option = ["--show-cursor"]
sources = ["help"]

[[commands.field]]
id = "plugins"
label = "List plugins and exit"
type = "boolean"
option = ["--plugins"]
sources = ["help"]

[[commands.task]]
id = "start"
label = "Start player"
fields = ["listen", "show_cursor"]
required = []

[[commands.task]]
id = "plugins"
label = "List plugins"
set = { plugins = [true] }
lock = ["plugins"]
fields = ["plugins"]
required = []

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["listen", "show_cursor", "plugins"]