id       = "ncdu"
name     = "ncdu"
homepage = "https://dev.yorhel.nl/ncdu"
description = "An interactive curses-based version of the well-known du(1)."
executables   = ["ncdu"]
platforms = ["macos", "linux"]

[dotfiles]

# https://dev.yorhel.nl/ncdu/man/2_8 — the CONFIGURATION section says the
# user configuration file is `$HOME/.config/ncdu/config` (the system file is
# /etc/ncdu.conf). ncdu documents this literal path rather than an XDG
# variable, so it is intentionally not [configHome].
paths = ["~/.config/ncdu/config"]

exclude = []
secret = []
side_effect = false

[commands]
format = 1
label = "Analyze disk usage"
description = "Open the ncdu disk usage browser on a directory. Sorting, colours, export/import files and the delete command are left out."
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://dev.yorhel.nl/ncdu/man"
revision = "ncdu 2 manual (2026-10-27)"
evidence = """-x, --one-file-system
--cross-file-system
--exclude pattern
-L, --follow-symlinks, --no-follow-symlinks
-t, --threads
-e, --extended,
--enable-delete, --disable-delete
-r
--si, --no-si
--disk-usage, --apparent-size
--show-hidden, --hide-hidden
-q, --slow-ui-updates, --fast-ui-updates"""

[[commands.field]]
id = "directory"
label = "Directory"
type = "path"
path = { kind = "directory", role = "input" }
position = 0
min = 0
sources = ["man"]

[[commands.field]]
id = "one_file_system"
label = "Stay on one filesystem"
type = "boolean"
option = ["--one-file-system", "-x"]
sources = ["man"]

[[commands.field]]
id = "exclude"
label = "Exclude pattern"
type = "string"
option = ["--exclude"]
multiple = true
sources = ["man"]

[[commands.field]]
id = "follow_symlinks"
label = "Follow symlinks"
type = "boolean"
option = ["--follow-symlinks", "-L"]
sources = ["man"]

[[commands.field]]
id = "threads"
label = "Threads"
type = "integer"
option = ["--threads", "-t"]
sources = ["man"]

[[commands.field]]
id = "extended"
label = "Extended information"
type = "boolean"
option = ["--extended", "-e"]
sources = ["man"]

[[commands.field]]
id = "si"
label = "Use powers of 1000 (SI)"
type = "boolean"
option = ["--si"]
sources = ["man"]

[[commands.field]]
id = "apparent_size"
label = "Show apparent size"
type = "boolean"
option = ["--apparent-size"]
sources = ["man"]

[[commands.field]]
id = "read_only"
label = "Read-only (disable deleting)"
type = "boolean"
option = ["-r"]
sources = ["man"]

[[commands.field]]
id = "enable_delete"
label = "Enable file deletion"
type = "boolean"
option = ["--enable-delete"]
effect = "delete"
sources = ["man"]

[[commands.task]]
id = "browse"
label = "Browse a directory"
fields = ["directory", "one_file_system", "exclude", "read_only"]
required = ["directory"]

[[commands.task]]
id = "root"
label = "Scan one filesystem, read-only"
set = { one_file_system = [true], read_only = [true] }
lock = ["read_only"]
fields = ["directory", "one_file_system", "read_only", "exclude"]
required = ["directory"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["directory", "one_file_system", "exclude", "read_only"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["follow_symlinks", "threads", "extended", "si", "apparent_size", "enable_delete"]