id       = "gitmux"
name     = "gitmux"
homepage = "https://github.com/arl/gitmux"
description = "Git status in tmux status bar."
executables   = ["gitmux"]

[dotfiles]

# The project's README shows `gitmux -printcfg > $HOME/.gitmux.conf` and then
# passes that file with -cfg. It is YAML containing the user's symbols, styles,
# layout and display options.
# https://github.com/arl/gitmux#customizing
paths  = ["~/.gitmux.conf"]
exclude = []
secret = []

[commands]
format = 1
label = "Print git status for tmux"
description = "Print the status of a Git working tree as a tmux format string."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.source]]
id = "help"
kind = "help"
url = "https://github.com/arl/gitmux/blob/main/README.md"
revision = "v0.11.5"
evidence = """
Usage: gitmux [options] [dir]
  -cfg FILE       read gitmux config from FILE.
  -printcfg       prints default configuration file.
  -dbg            outputs Git status as JSON and print errors.
  -timeout DUR    exits if still running after given duration (ex: 2s, 500ms).
"""

[[commands.field]]
id = "dir"
label = "Directory"
description = "Defaults to the working directory."
type = "path"
position = 0
path = { kind = "directory", role = "input", must_exist = true }
sources = ["help"]

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

[[commands.field]]
id = "printcfg"
label = "Print default config"
type = "boolean"
option = ["-printcfg"]
sources = ["help"]

[[commands.field]]
id = "dbg"
label = "Debug (JSON status)"
type = "boolean"
option = ["-dbg"]
sources = ["help"]

[[commands.field]]
id = "timeout"
label = "Timeout"
description = "For example 2s or 500ms."
type = "string"
option = ["-timeout"]
sources = ["help"]

[[commands.task]]
id = "status"
label = "Status of a directory"
fields = ["dir", "cfg", "timeout"]
required = []

[[commands.task]]
id = "printcfg"
label = "Print default config"
fields = ["printcfg"]
required = ["printcfg"]
set = { printcfg = [true] }
lock = ["printcfg"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["dir", "cfg", "timeout", "printcfg", "dbg"]