id       = "ctop"
name     = "ctop"
homepage = "https://github.com/bcicen/ctop"
description = "Top-like interface for container metrics."
executables   = ["ctop"]

[dotfiles]

# Description wording is from ctop's official README.

# ctop's official README says that pressing S writes the user configuration to
# `~/.config/ctop/config` on XDG systems, otherwise `~/.ctop`.
# https://github.com/bcicen/ctop#config-file
paths = [
  "~/.config/ctop/config",
  "~/.ctop",
]
exclude = []
secret = []

# ctop loads the file at startup and writes it only when the user explicitly
# saves settings; each run is a short-lived process.
side_effect = false

[commands]
format = 1
label = "Monitor containers"
description = "Open the ctop container metrics view with an initial filter, sort and connector. Interactive key bindings are not covered."
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://github.com/bcicen/ctop/blob/master/main.go"
revision = "2026-10-27"
evidence = """
Usage of ctop:
  -a  show active containers only
  -connector string  container connector to use (default "docker")
  -f string  filter containers
  -h  display this help dialog
  -i  invert default colors
  -r  reverse container sort order
  -s string  select container sort field
  -v  output version information and exit
(Go flag package also accepts the double-dash spelling --connector)
"""

[[commands.field]]
id = "filter"
label = "Filter"
type = "string"
option = ["-f"]
sources = ["help"]

[[commands.field]]
id = "active_only"
label = "Active containers only"
type = "boolean"
option = ["-a"]
sources = ["help"]

[[commands.field]]
id = "sort"
label = "Sort field"
type = "string"
option = ["-s"]
sources = ["help"]

[[commands.field]]
id = "reverse"
label = "Reverse sort order"
type = "boolean"
option = ["-r"]
sources = ["help"]

[[commands.field]]
id = "invert"
label = "Invert colors"
type = "boolean"
option = ["-i"]
sources = ["help"]

[[commands.field]]
id = "connector"
label = "Connector"
type = "string"
option = ["--connector"]
suggestions = [{ value = "docker", label = "Docker" }]
sources = ["help"]

[[commands.task]]
id = "active"
label = "Active containers"
fields = ["active_only", "sort", "reverse"]
required = []
set = { active_only = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["filter", "active_only", "sort", "reverse"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["invert", "connector"]