id       = "nvtop"
name     = "nvtop"
homepage = "https://github.com/Syllo/nvtop"
description = "A ncurses-based GPU status viewer for AMD, Intel and NVIDIA GPUs."
executables   = ["nvtop"]

[dotfiles]

# nvtop's official man page says the preferences file follows the XDG Base
# Directory Specification and defaults to ~/.config/nvtop/interface.ini when
# XDG_CONFIG_HOME is not set. It is generated by the F12 save action and has no
# credential fields.
# https://github.com/Syllo/nvtop/blob/master/manpage/nvtop.in
paths = ["[configHome]/nvtop/interface.ini"]
exclude = []
secret = []

[commands]
format = 1
label = "Monitor GPUs"
description = "Open the nvtop GPU viewer, or print a one-off snapshot for scripting."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

[[commands.source]]
id = "man"
kind = "manual"
url = "https://github.com/Syllo/nvtop/blob/master/manpage/nvtop.in"
evidence = """
nvtop(1) COMMAND-LINE OPTIONS (man page source, backslash escapes removed):
-d, --delay=delay  Delay between updates, in tenths of seconds (delay * 0.1s).
-c, --config-file=config-file  Provide a custom config file location to load and save the preferences.
-p, --no-plot
-P, --no-processes  Do not display the process list.
-u, --dynamic-memory-units
-C, --no-color, --no-colour  Monochrome mode.
-f, --freedom-unit  Use fahrenheit as temperature scale.
-i, --gpu-info
-s, --snapshot  Output the current GPU stats without ncurses, then exit (useful for scripting).
-l, --loop  Keep outputting the current GPU stats without ncurses in a loop.
"""

[[commands.field]]
id = "delay"
label = "Update delay"
description = "Delay between updates, in tenths of seconds."
type = "integer"
option = ["--delay", "-d"]
sources = ["man"]

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

[[commands.field]]
id = "no_plot"
label = "Single plot"
type = "boolean"
option = ["--no-plot", "-p"]
sources = ["man"]

[[commands.field]]
id = "no_processes"
label = "Hide process list"
type = "boolean"
option = ["--no-processes", "-P"]
sources = ["man"]

[[commands.field]]
id = "dynamic_memory_units"
label = "Auto-scale memory units"
type = "boolean"
option = ["--dynamic-memory-units", "-u"]
sources = ["man"]

[[commands.field]]
id = "no_color"
label = "Monochrome"
type = "boolean"
option = ["--no-color", "-C"]
sources = ["man"]

[[commands.field]]
id = "fahrenheit"
label = "Fahrenheit"
type = "boolean"
option = ["--freedom-unit", "-f"]
sources = ["man"]

[[commands.field]]
id = "gpu_info"
label = "Dynamic GPU info bar"
type = "boolean"
option = ["--gpu-info", "-i"]
sources = ["man"]

[[commands.field]]
id = "snapshot"
label = "Snapshot and exit"
type = "boolean"
option = ["--snapshot", "-s"]
sources = ["man"]

[[commands.field]]
id = "loop"
label = "Print stats in a loop"
type = "boolean"
option = ["--loop", "-l"]
sources = ["man"]

[[commands.task]]
id = "interactive"
label = "Interactive viewer"
fields = ["delay", "no_processes", "no_color", "fahrenheit", "gpu_info"]
required = []

[[commands.task]]
id = "snapshot"
label = "One-off snapshot"
set = { snapshot = [true] }
lock = ["snapshot"]
fields = ["snapshot", "fahrenheit"]
required = []

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["delay", "snapshot", "loop", "no_processes", "fahrenheit"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["config_file", "no_plot", "dynamic_memory_units", "no_color", "gpu_info"]