id       = "tlrc"
name     = "tlrc"
homepage = "https://github.com/tldr-pages/tlrc"
description = "Official tldr client written in Rust."
executables   = ["tlrc"]

[dotfiles]

# https://raw.githubusercontent.com/tldr-pages/tlrc/main/src/config.rs
# Config::locate() calls dirs::config_dir(), then appends tlrc/config.toml;
# [appData] is the platform-native config root (and the same directory as the
# XDG root on Linux). TLRC_CONFIG is an explicit override, not a default path.
paths = ["[appData]/tlrc/config.toml"]
secret = []
side_effect = false

[commands]
format = 1
label = "Show a tldr page"
description = "Show a tldr page for a command, or search and update the page cache. Config, cache-clearing and language listing operations 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/tldr-pages/tlrc/blob/main/src/args.rs"
revision = "main 2026-10"
evidence = """
tldr [OPTIONS] [PAGE]...
-u, --update          Update the cache.
-a, --list-all        List all pages.
-s, --search <KEYWORD>   Search for pages containing a keyword.
--platform <PLATFORM>    Specify the platform to use (linux, osx, windows, etc.).
-L, --language <LANGUAGE_CODE>   Specify the languages to use.
-S, --short-options   Display short options wherever possible (e.g. '-s').
-E, --long-options    Display long options wherever possible (e.g. '--long').
-R, --raw             Print pages in raw Markdown instead of rendering them.
"""

[[commands.field]]
id = "page"
label = "Page"
description = "Command name, e.g. tar or git commit."
type = "string"
position = 0
multiple = true
sources = ["src"]

[[commands.field]]
id = "platform"
label = "Platform"
type = "string"
option = ["--platform"]
suggestions = [{ value = "linux", label = "Linux" }, { value = "osx", label = "macOS" }, { value = "windows", label = "Windows" }, { value = "common", label = "Common" }]
sources = ["src"]

[[commands.field]]
id = "language"
label = "Language code"
type = "string"
option = ["--language", "-L"]
sources = ["src"]

[[commands.field]]
id = "short_options"
label = "Prefer short options"
type = "boolean"
option = ["--short-options", "-S"]
sources = ["src"]

[[commands.field]]
id = "long_options"
label = "Prefer long options"
type = "boolean"
option = ["--long-options", "-E"]
sources = ["src"]

[[commands.field]]
id = "raw"
label = "Raw Markdown"
type = "boolean"
option = ["--raw", "-R"]
sources = ["src"]

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

[[commands.field]]
id = "update"
label = "Update the cache"
type = "boolean"
option = ["--update"]
sources = ["src"]

[[commands.field]]
id = "list_all"
label = "List all pages"
type = "boolean"
option = ["--list-all", "-a"]
sources = ["src"]

[[commands.task]]
id = "show"
label = "Show a page"
fields = ["page", "platform", "long_options"]
required = ["page"]

[[commands.task]]
id = "search"
label = "Search pages"
fields = ["search"]
required = ["search"]

[[commands.task]]
id = "update"
label = "Update the cache"
fields = ["update"]
required = ["update"]
set = { update = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["page", "platform", "language", "search", "update", "list_all"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["short_options", "long_options", "raw"]