tldr

This app installs the official tldr-pages client tlrc v1.13.1 on the host and fronts it as typed methods. tldr is *"simplified, community-driven man pages"* — concise, example-first cheat-sheets for ~7,350+ command-line tools, the practical opposite of a dense man page. Instead of scrolling a manual, an agent asks tldr docker and gets the handful of commands it actually needs, each with a one-line description. The bundle is the upstream tlrc binary (sha-pinned per OS/arch, fetched from the Pilot artifact registry at install) plus a tiny wrapper that serves a complete, color-free command-palette reference.

Open source, and every command is tested. The tlrc client is MIT; the pages are written by the tldr-pages community and licensed CC-BY-4.0. The full page catalog (~3 MiB) auto-downloads on first use and then works offline.

Why an agent wants this

- Recall any CLI instantly. tldr <tool> returns the 5–10 invocations that matter — no manual to parse, no web search. The dictionary of man pages, for the whole toolbox an agent builds and deploys with. - Discover tools by task. tldr.search <keyword> does first-class full-text search across the catalog ("compress", "screenshot", "certificate"); tldr.list prints the whole directory of documented commands. - Machine-parseable. tldr.raw returns raw Markdown so an agent can lift the exact example lines programmatically; tldr.get returns clean rendered text for humans-in-the-loop. - Self-contained + offline. One static binary, no dependencies; after the first fetch, lookups need no network. Runs on macOS and Linux (arm64 + amd64). - The complete palette. Every flag is reachable — platform overrides, languages, list/search, render a local page — via curated methods plus a verbatim-argv tldr.exec passthrough.

What it documents (a taste — all verbatim from real tldr pages)

Version control & GitHub - git — Clone a repository: git clone https://example.com/repo.git · View status: git status - gh — Clone a repo: gh repo clone owner/repository · List open issues: gh issue list

Containers, orchestration & IaC - docker — List all containers: docker ps -a · Run a named container: docker run --name name image - kubectl — Wide resource listing: kubectl get pods -o wide · Everything: kubectl get all - terraform — Initialize: terraform init · Format config: terraform fmt - ansible — Ping a host group: ansible group -m ping · Gather facts: ansible group -m setup - helm — Create a chart: helm create chart_name · Add a repo: helm repo add repository_name

Cloud - aws — Configure SSO: aws configure sso · Who am I: aws sts get-caller-identity - ssh — Connect: ssh username@remote_host · With an identity key: ssh username@remote_host -i key

Languages & package managers - npm — Install deps: npm install · A pinned version: npm install package@version - cargo — Install a crate: cargo install crate_name · List installed: cargo install --list - go — Run a file: go run file.go · Build a binary: go build -o executable file.go

Data & text - jq — Pretty-print JSON: jq '.' file.json - sed — Replace text: command | sed 's/apple/mango/g' · First line: command | sed -n '1p' - awk — Print a column: awk '{print $5}' file · Last field, comma-separated: awk -F ',' '{print $NF}' file - grep — Recursive search: grep -rI "pattern" path/to/dir - psql — Connect: psql -h host -p port -U username database

Networking, files & archives - curl — GET a URL: curl https://example.com · Save to a file: curl -O https://example.com/file.zip - rsync — Archive-mode copy: rsync -a path/to/source path/to/destination - tar — Create a gzipped archive: tar czf target.tar.gz file1 file2 - find — By extension: find path/to/dir -name '*.ext' - openssl — Self-signed cert: openssl req -new -x509 -key private.key -out certificate.crt -days 365 - ffmpeg — Extract audio: ffmpeg -i video.mp4 -vn sound.mp3

System & services (Linux) - systemctl — Failed units: systemctl --failed · Manage a service: systemctl start|stop|status unit - journalctl — Follow a unit's logs: journalctl -u unit -f

…and ~7,300 more, across common, linux, osx, windows, android, and sunos.

Methods

• tldr.get — a command's cheat-sheet as clean text.
• tldr.raw — a page as raw Markdown (machine-parseable).
• tldr.search — full-text search across the whole catalog for a keyword.
• tldr.list — the directory of every documented command for this platform.
• tldr.info — cache path / age / languages / page count.
• tldr.update — refresh the local page cache.
• tldr.render — render a local tldr-format .md page.
• tldr.exec — run the client with a verbatim argv (any flag: --platform, -L, --list-all, …) + optional stdin.
• tldr.cli_help — the complete command-palette reference as clean text.
• tldr.version — the delivered client + spec version. tldr.help — the self-describing method list.

How to use it

1. Recall a tool (no setup): tldr.get { "command": "tar" } → the tar cheat-sheet. First call auto-downloads the cache. 2. Multi-word page: tldr.get { "command": "git-commit" } (hyphen-joined) or tldr.exec { "args": ["git","commit"] }. 3. Find a tool by task: tldr.search { "keyword": "compress" } → every page mentioning compression. 4. Browse the catalog: tldr.list → all documented commands for this platform. 5. Anything else: tldr.exec { "args": ["--platform","linux","systemctl"] } to force a platform.

Good to know

- The page cache (~3 MiB, ~7,350+ pages) auto-downloads on first use and refreshes when stale; progress goes to stderr so method output on stdout stays clean. Use tldr.update to refresh, --offline (via tldr.exec) to pin the current cache. - On a non-zero exit the reply is {stdout, stderr, exit} so the caller sees everything the CLI produced. - Runs on macOS and Linux (arm64 + amd64); the binary is fetched from the Pilot artifact registry and sha-pinned on install. Client license MIT (tlrc); pages content CC-BY-4.0, © tldr-pages contributors. - tldr.help lists every method with its latency class — the self-describing discovery contract.

## tldr command palette (tldr.cli_help) ``` tldr — simplified, community-driven man pages (io.pilot.tldr) ================================================================================ Powered by tlrc v1.13.1, the official tldr-pages client (tldr client spec v2.3). tldr gives you concise, example-first help for ~7,350+ command-line tools — a practical cheat-sheet for almost every CLI an agent uses to build, deploy, and operate software. Open source: the tlrc client is MIT; the pages are authored by the tldr-pages community and licensed CC-BY-4.0. Every command below is tested.

USAGE -------------------------------------------------------------------------------- tldr [OPTIONS] [PAGE]...

PAGE The command to look up, e.g. tar, docker, kubectl. Multi-word pages: join with a hyphen -> git-commit, docker-compose, gh-repo (or pass the words as separate arguments via the passthrough method: ["git","commit"]).

OPERATIONS (choose at most one per invocation) -------------------------------------------------------------------------------- <PAGE> Show the tldr page for a command (rendered). -u, --update Update the local page cache (downloads only the languages that changed). Needs network. -l, --list List every page for the current platform (plus the cross-platform common set) — a directory of all documented tools, one name per line. -a, --list-all List every page across ALL platforms. -s, --search <KEYWORD> Search page CONTENTS for a keyword and print each match as language platform page. First-class full-text search across the whole catalog. --list-platforms List the available platforms. --list-languages List the installed languages. -i, --info Show cache info: path, age, installed languages, and total page count. -r, --render <FILE> Render a local tldr page file (.md) — preview a page you are authoring or one you fetched. --clean-cache Interactively delete the cache directory contents. --gen-config Print the default config (TOML) to stdout. --config-path Print the default config path (creates the dir). -v, --version Print the client + spec version. -h, --help Print this complete command-palette reference.

MODIFIERS (change how an operation behaves) -------------------------------------------------------------------------------- -p, --platform <PLATFORM> Force a platform instead of the host's. Values: linux, osx (macOS), windows, android, sunos, common. Default: the OS you are on. -L, --language <CODE> Force a language (repeatable), e.g. -L es, -L fr, -L ja. Default: config, else $LANG. --short-options Prefer short option forms in placeholders (-s). --long-options Prefer long option forms in placeholders (--long). --edit Show a GitHub "edit this page" link for the page. -o, --offline Never touch the network, even if the cache is stale (use the pages already downloaded). -c, --compact Strip empty lines from the output. --no-compact Keep empty lines (overrides --compact). -R, --raw Print the page as raw Markdown (no rendering) — the most machine-parseable form. --no-raw Render instead of raw (overrides --raw). -q, --quiet Suppress status/progress messages and warnings. --verbose Print debug info (repeatable). --color <WHEN> Color output: auto (default), always, never. --config <FILE> Use an alternative config file path.

PLATFORM VALUES -------------------------------------------------------------------------------- common Cross-platform tools (the largest bucket: git, docker, curl, jq, ...) linux Linux-specific pages (systemctl, journalctl, apt, ip, ...) osx macOS-specific pages (brew, pbcopy, launchctl, ...) windows Windows-specific pages (choco, taskkill, ...) android Android tool pages (adb, pm, ...) sunos illumos / SunOS pages

CACHE & OFFLINE -------------------------------------------------------------------------------- The page cache auto-downloads on first use (a ~3 MiB archive of ~7,350+ pages) and thereafter refreshes automatically when it goes stale. After the first fetch, lookups (get, raw, search, list, info, render) are fully local and offline. Progress messages are written to stderr, so method output on stdout stays clean. Use --offline to pin the current cache and --update to refresh on demand. Cache path: tldr --info.

EXAMPLES -------------------------------------------------------------------------------- tldr tar # show the tar cheat-sheet tldr git-commit # multi-word page (hyphen-joined) tldr --raw docker # raw Markdown for docker tldr --search compress # find every page mentioning "compress" tldr --list # directory of all tools for this platform tldr --list-all # every page across all platforms tldr --platform linux systemctl # force the linux page tldr --update # refresh the cache tldr --info # cache path / age / page count

LICENSING -------------------------------------------------------------------------------- Client (tlrc): MIT — https://github.com/tldr-pages/tlrc Pages content: CC-BY-4.0, (c) tldr-pages contributors — https://github.com/tldr-pages/tldr Project home: https://tldr.sh

```