id       = "superfile"
name     = "superfile"
homepage = "https://superfile.dev"
description = "A modern terminal file manager."
executables   = ["spf"]

[dotfiles]

# The official path reference lists config.toml and hotkeys.toml under the
# Linux XDG config directory, macOS Application Support, and Windows
# LOCALAPPDATA directory. Logs/state are not configuration and are excluded.
# https://superfile.dev/configure/config-file-path/
paths = [
  "~/.config/superfile/config.toml",
  "~/.config/superfile/hotkeys.toml",
  "~/Library/Application Support/superfile/config.toml",
  "~/Library/Application Support/superfile/hotkeys.toml",
  "%LOCALAPPDATA%/superfile/config.toml",
  "%LOCALAPPDATA%/superfile/hotkeys.toml",
]
exclude = [
  "~/.local/state/superfile/",
  "~/Library/Application Support/superfile/*.log",
  "%LOCALAPPDATA%/superfile/*.log",
]
secret = []

[commands]
format = 1
label = "superfile"
description = "Start superfile in one or more directories, optionally with custom config or hotkey files. Maintenance subcommands are not covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = false, short_bundles = false }

[[commands.source]]
id = "docs"
kind = "manual"
url = "https://raw.githubusercontent.com/yorukot/superfile/HEAD/website/src/content/docs/configure/config-file-path.mdx"
revision = "2026-10-27"
evidence = """
You can use the `-c` or `--config-file` flag to specify a different path for the `config.toml` file:
spf -c /path/to/your/config.toml
You can use the `--hotkey-file` flag to specify a different path for the `hotkey.toml` file:
spf --hotkey-file /path/to/your/hotkey.toml
ArgsUsage:   "[PATH]..."
"""

[[commands.field]]
id = "paths"
label = "Start directories"
description = "One or more directories to open as panels."
type = "path"
path = { kind = "directory", role = "input" }
position = 0
multiple = true
sources = ["docs"]

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

[[commands.field]]
id = "hotkey_file"
label = "Hotkey file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--hotkey-file"]
sources = ["docs"]

[[commands.task]]
id = "open"
label = "Open directories"
fields = ["paths"]

[[commands.task]]
id = "custom_config"
label = "Open with custom config"
fields = ["paths", "config_file", "hotkey_file"]
required = ["config_file"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["paths", "config_file", "hotkey_file"]