id          = "navi"
name        = "navi"
homepage    = "https://github.com/denisidoro/navi"
description = "An interactive cheatsheet tool for the command-line."
executables      = ["navi"]

[dotfiles]

# https://github.com/denisidoro/navi/blob/master/docs/configuration/README.md
# documents the compiled default config fallback as ~/.config/navi/config.yaml.
# The same page says the default cheatsheets directory is ~/.local/share/navi/cheats
# and explains that directories-next uses ~/Library/Application Support/navi on
# macOS. The configuration file and user-authored cheatsheets are portable data.
paths = [
  "~/.config/navi/config.yaml",
  "~/.local/share/navi/cheats/",
  "~/Library/Application Support/navi/cheats/",
]

secret  = []

# Navi is a one-shot interactive CLI; it does not maintain a resident process.
side_effect = false

[commands]
format = 1
label = "Browse cheatsheets"
description = "Open navi's interactive cheatsheet finder. Finder overrides and subcommands (widget, repo, fn) 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/denisidoro/navi/blob/master/src/config/cli.rs"
revision = "master (2026-10-27)"
evidence = """/// Colon-separated list of paths containing .cheat files
#[arg(short, long)]
pub path: Option<String>,
/// Instead of executing a snippet, prints it to stdout
#[arg(long)]
pub print: bool,
/// Returns the best match
#[arg(long)]
pub best_match: bool,
/// Searches for cheatsheets using the tldr-pages repository
#[arg(long)]
pub tldr: Option<String>,
/// [Experimental] Comma-separated list that acts as filter for tags. Parts starting with ! represent negation
#[arg(long)]
pub tag_rules: Option<String>,
/// Searches for cheatsheets using the cheat.sh repository
#[arg(long)]
pub cheatsh: Option<String>,
/// Prepopulates the search field
#[arg(short, long, allow_hyphen_values = true)]
pub query: Option<String>,
Resulting flags: -p, --path <PATH>   -q, --query <QUERY>   --print   --best-match   --tldr <TLDR>   --cheatsh <CHEATSH>   --tag-rules <TAG_RULES>"""

[[commands.field]]
id = "path"
label = "Cheat paths"
description = "Colon-separated list of paths containing .cheat files."
type = "string"
option = ["--path", "-p"]
sources = ["src"]

[[commands.field]]
id = "query"
label = "Initial query"
type = "string"
option = ["--query", "-q"]
sources = ["src"]

[[commands.field]]
id = "print"
label = "Print snippet instead of running"
type = "boolean"
option = ["--print"]
sources = ["src"]

[[commands.field]]
id = "best_match"
label = "Return best match"
type = "boolean"
option = ["--best-match"]
sources = ["src"]

[[commands.field]]
id = "tldr"
label = "Search tldr pages"
type = "string"
option = ["--tldr"]
sources = ["src"]

[[commands.field]]
id = "cheatsh"
label = "Search cheat.sh"
type = "string"
option = ["--cheatsh"]
sources = ["src"]

[[commands.field]]
id = "tag_rules"
label = "Tag rules"
description = "Comma-separated tags; prefix with ! to negate. Experimental."
type = "string"
option = ["--tag-rules"]
sources = ["src"]

[[commands.task]]
id = "search"
label = "Search with a query"
fields = ["query", "print", "best_match"]
required = ["query"]

[[commands.task]]
id = "tldr"
label = "Search tldr pages"
fields = ["tldr", "print"]
required = ["tldr"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["query", "print", "best_match", "path"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["tldr", "cheatsh", "tag_rules"]