id          = "chdig"
name        = "chdig"
homepage    = "https://github.com/azat/chdig"
description = "Dig into ClickHouse with TUI interface."
executables      = ["chdig"]
platforms   = ["macos", "linux"]

[dotfiles]

# The upstream FAQ documents the chdig layout configuration defaults as
# ~/.config/chdig/config.yaml, then ~/.chdig.yaml, and /etc/chdig/config.yaml.
# The system path is not user-owned; the two home paths are the syncable ones.
# https://github.com/azat/chdig/blob/main/Documentation/FAQ.md#how-to-configure-views-and-panes-layout-like-tmuxinator
paths = ["~/.config/chdig/config.yaml", "~/.chdig.yaml"]
exclude = []
secret = []
side_effect = false

# The same FAQ shows ClickHouse YAML connection profiles with a password, and
# the standard top-level client password field. Keep those fields out of the
# otherwise useful views/layout configuration.
[[dotfiles.secret_paths]]
file   = ["~/.config/chdig/config.yaml", "~/.chdig.yaml"]
format = "yaml"
match  = { key_path = ["password", "connections_credentials.*.password"] }

[commands]
format = 1
label = "Connect to ClickHouse"
description = "Open the chdig TUI against a ClickHouse server. Passwords, TLS options, log limits and per-view subcommands are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "src"
kind = "help"
url = "https://github.com/azat/chdig/blob/main/src/interpreter/options.rs"
revision = "2026-10-27"
evidence = """
-u, --url URL
--host Overrides host in --url (for clickhouse-client compatibility)
--port Overrides port in --url (for clickhouse-client compatibility)
--user Overrides user in --url (for clickhouse-client compatibility)
-C, --connection
-c, --cluster
--database Database with the system tables, e.g. a preserved copy; overrides database in --url
--history Aggregate system.*_log historical data, using merge()
--internal-queries Do not hide internal (spawned by chdig) queries
-d, --delay-interval
"""

[[commands.field]]
id = "url"
label = "Server URL"
type = "string"
option = ["--url", "-u"]
sources = ["src"]

[[commands.field]]
id = "host"
label = "Host"
type = "string"
option = ["--host"]
sources = ["src"]

[[commands.field]]
id = "port"
label = "Port"
type = "integer"
option = ["--port"]
sources = ["src"]

[[commands.field]]
id = "user"
label = "User"
type = "string"
option = ["--user"]
sources = ["src"]

[[commands.field]]
id = "connection"
label = "Named connection"
type = "string"
option = ["--connection", "-C"]
sources = ["src"]

[[commands.field]]
id = "cluster"
label = "Cluster"
description = "Aggregate data from all hosts in the cluster."
type = "string"
option = ["--cluster", "-c"]
sources = ["src"]

[[commands.field]]
id = "database"
label = "System-tables database"
type = "string"
option = ["--database"]
sources = ["src"]

[[commands.field]]
id = "history"
label = "Include historical logs"
type = "boolean"
option = ["--history"]
sources = ["src"]

[[commands.field]]
id = "internal_queries"
label = "Show internal queries"
type = "boolean"
option = ["--internal-queries"]
sources = ["src"]

[[commands.field]]
id = "delay_interval"
label = "Refresh interval (ms)"
type = "integer"
option = ["--delay-interval", "-d"]
sources = ["src"]

[[commands.task]]
id = "connect"
label = "Connect by URL"
fields = ["url", "history"]
required = ["url"]

[[commands.task]]
id = "connect_cluster"
label = "Inspect a cluster"
fields = ["url", "cluster"]
required = ["url", "cluster"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["url", "connection", "cluster", "history"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["host", "port", "user", "database", "internal_queries", "delay_interval"]