id          = "clifm"
name        = "clifm"
homepage    = "https://github.com/leo-arch/clifm"
description = "Command-line Interface File Manager"
executables      = ["clifm"]

[dotfiles]

# https://github.com/leo-arch/clifm/wiki/Specifics and
# https://github.com/leo-arch/clifm/wiki/Customization — clifm stores its
# profiles, keybindings, colors, actions, bookmarks and other user files below
# $XDG_CONFIG_HOME/clifm (default ~/.config/clifm).
paths = ["[configHome]/clifm/"]

# These are runtime/history state documented by the same wiki, not portable
# preferences. nets.clifm is a remote-mount command file and may contain
# inline mount credentials, so withhold the whole file.
exclude = [
  "[configHome]/clifm/profiles/*/history.clifm",
  "[configHome]/clifm/profiles/*/cmdlogs.clifm",
  "[configHome]/clifm/profiles/*/.last",
  "[configHome]/clifm/profiles/*/log.clifm",
]
secret = ["[configHome]/clifm/profiles/*/nets.clifm"]

[commands]
format = 1
label = "Start clifm"
description = "Start clifm in one or more directories with common listing options. Many further switches exist in the manual."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "help"
kind = "manual"
url = "https://manpages.debian.org/testing/clifm/clifm.1.en.html"
revision = "2026-10-27"
evidence = """
clifm [OPTION]... [DIR]...
-1, --oneline    List one file per line
-a, --show-hidden[=VAL]   Show hidden files (filenames starting with '.').
-A, --no-hidden
-f, --group-dirs=VAL
-l, --long-view
-P, --profile=PROFILE
-S, --stealth-mode
-w, --workspace=NUM
-z, --sort=METHOD
--only-dirs
--list-and-quit
--no-restore-last-path
--icons
--no-suggestions
Positional parameters: If you specify a directory as the first non-option parameter, clifm will start in that directory. Subsequent directory names are used to initialize subsequent workspaces. Up to 8 positional parameters are supported.
"""

[[commands.field]]
id = "dirs"
label = "Start directories"
description = "First is workspace 1, next ones initialise further workspaces."
type = "path"
position = 0
multiple = true
max = 8
path = { kind = "directory", role = "input" }
sources = ["help"]

[[commands.field]]
id = "profile"
label = "Profile"
type = "string"
option = ["--profile", "-P"]
sources = ["help"]

[[commands.field]]
id = "workspace"
label = "Starting workspace"
type = "integer"
option = ["--workspace", "-w"]
sources = ["help"]

[[commands.field]]
id = "sort"
label = "Sort method"
description = "Sort method name or number, as listed in the clifm manual."
type = "string"
option = ["--sort", "-z"]
sources = ["help"]

[[commands.field]]
id = "show_hidden"
label = "Show hidden files"
type = "boolean"
option = ["--show-hidden", "-a"]
sources = ["help"]

[[commands.field]]
id = "no_hidden"
label = "Hide hidden files"
type = "boolean"
option = ["--no-hidden", "-A"]
sources = ["help"]

[[commands.field]]
id = "long_view"
label = "Long view"
type = "boolean"
option = ["--long-view", "-l"]
sources = ["help"]

[[commands.field]]
id = "oneline"
label = "One file per line"
type = "boolean"
option = ["--oneline", "-1"]
sources = ["help"]

[[commands.field]]
id = "only_dirs"
label = "Only directories"
type = "boolean"
option = ["--only-dirs"]
sources = ["help"]

[[commands.field]]
id = "icons"
label = "Show icons"
type = "boolean"
option = ["--icons"]
sources = ["help"]

[[commands.field]]
id = "no_restore"
label = "Do not restore last path"
type = "boolean"
option = ["--no-restore-last-path"]
sources = ["help"]

[[commands.field]]
id = "stealth"
label = "Stealth mode"
description = "Leave no trace on the host system: no files read or written."
type = "boolean"
option = ["--stealth-mode", "-S"]
sources = ["help"]

[[commands.field]]
id = "list_and_quit"
label = "List and quit"
type = "boolean"
option = ["--list-and-quit"]
sources = ["help"]

[[commands.constraint]]
kind = "at_most_one"
fields = ["show_hidden", "no_hidden"]
message = "Choose either show or hide hidden files."

[[commands.task]]
id = "open"
label = "Open directory"
fields = ["dirs", "profile", "show_hidden", "long_view"]
required = ["dirs"]

[[commands.task]]
id = "list"
label = "List once and quit"
set = { list_and_quit = [true] }
lock = ["list_and_quit"]
fields = ["dirs", "list_and_quit", "long_view", "show_hidden", "oneline"]
required = ["dirs"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["dirs", "show_hidden", "long_view", "sort", "profile"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["no_hidden", "oneline", "only_dirs", "icons", "workspace", "no_restore", "stealth", "list_and_quit"]