id          = "rmpc"
name        = "rmpc"
homepage    = "https://rmpc.mierak.dev/"
description = "A beautiful and configurable TUI client for MPD."
executables      = ["rmpc"]

[dotfiles]

# https://rmpc.mierak.dev/configuration/: rmpc reads RON configuration from
# $XDG_CONFIG_HOME/rmpc/config.ron (or ~/.config/rmpc/config.ron when unset).
# RON is not one of the catalog's structured secret-path formats, and the same
# file can contain the optional MPD password, so the whole file is protected.
paths  = []
secret = ["[configHome]/rmpc/config.ron"]
side_effect = false

[commands]
format = 1
label = "rmpc"
description = "Start rmpc with a custom config, theme or MPD address, or run a quick scripting command (volume, seek, add). Subcommand-specific flags are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "help"
kind = "help"
url = "https://rmpc.mierak.dev/reference/cli-command-mode/"
revision = "v0.11.0"
evidence = """
Usage: rmpc [OPTIONS] [COMMAND]
  volume          Sets volume, relative if prefixed by + or -. Prints current volume if no arguments is given
  seek            Seeks current song(seconds), relative if prefixed by + or -
  add             Add a song to the current queue. Relative to music database root. '/' to add all files to the queue
Options:
  -c, --config <FILE>
  -t, --theme <FILE>
  -a, --address <ADDRESS>      Override the address to connect to. Defaults to value in the config file
  -p, --password <PASSWORD>    Override the MPD password
      --partition <PARTITION>  Partition to connect to at startup
      --autocreate             Automatically create the partition if it does not exist. Requires partition to be set
"""

[[commands.field]]
id = "config"
label = "Config file"
type = "path"
option = ["--config", "-c"]
path = { kind = "file", role = "input" }
sources = ["help"]

[[commands.field]]
id = "theme"
label = "Theme file"
type = "path"
option = ["--theme", "-t"]
path = { kind = "file", role = "input" }
sources = ["help"]

[[commands.field]]
id = "address"
label = "MPD address"
description = "Overrides the address in the config file."
type = "string"
option = ["--address", "-a"]
sources = ["help"]

[[commands.field]]
id = "password"
label = "MPD password"
description = "Visible in shell history; prefer the config file."
type = "string"
option = ["--password", "-p"]
sources = ["help"]

[[commands.field]]
id = "partition"
label = "Partition"
type = "string"
option = ["--partition"]
sources = ["help"]

[[commands.field]]
id = "autocreate"
label = "Create partition if missing"
description = "Requires a partition."
type = "boolean"
option = ["--autocreate"]
sources = ["help"]

[[commands.task]]
id = "launch"
label = "Launch with custom config"
fields = ["config", "theme", "address"]
required = []

[[commands.task]]
id = "partition"
label = "Connect to a partition"
set = { autocreate = [true] }
fields = ["address", "partition", "autocreate"]
required = ["partition"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["config", "theme", "address"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["password", "partition", "autocreate"]

[[commands.subcommand]]
path = ["volume"]
label = "Set or show volume"

[[commands.subcommand.source]]
id = "help"
kind = "help"
url = "https://rmpc.mierak.dev/reference/cli-command-mode/"
revision = "v0.11.0"
evidence = """
  volume          Sets volume, relative if prefixed by + or -. Prints current volume if no arguments is given
"""

[[commands.subcommand.field]]
id = "value"
label = "Volume"
description = "Absolute, or relative with a + or - prefix. Empty prints the current volume."
type = "string"
position = 0
sources = ["help"]

[[commands.subcommand.task]]
id = "volume"
label = "Set volume"
fields = ["value"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["value"]

[[commands.subcommand]]
path = ["seek"]
label = "Seek in the current song"

[[commands.subcommand.source]]
id = "help"
kind = "help"
url = "https://rmpc.mierak.dev/reference/cli-command-mode/"
revision = "v0.11.0"
evidence = """
  seek            Seeks current song(seconds), relative if prefixed by + or -
"""

[[commands.subcommand.field]]
id = "position"
label = "Seconds"
description = "Absolute, or relative with a + or - prefix."
type = "string"
position = 0
sources = ["help"]

[[commands.subcommand.task]]
id = "seek"
label = "Seek"
fields = ["position"]
required = ["position"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["position"]

[[commands.subcommand]]
path = ["add"]
label = "Add songs to the queue"

[[commands.subcommand.source]]
id = "help"
kind = "help"
url = "https://rmpc.mierak.dev/reference/cli-command-mode/"
revision = "v0.11.0"
evidence = """
  add             Add a song to the current queue. Relative to music database root. '/' to add all files to the queue
"""

[[commands.subcommand.field]]
id = "files"
label = "Files"
description = "Paths relative to the MPD music database root; / adds everything."
type = "string"
position = 0
multiple = true
sources = ["help"]

[[commands.subcommand.task]]
id = "add"
label = "Add to queue"
fields = ["files"]
required = ["files"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["files"]