tlrc CLI
tlrc is a tldr CLI client: downloaded examples remain available offline, with line width settings for narrow terminals.
- 1,081 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The client downloads reference pages and writes them to a local cache.
Install
In your terminal, with SkillFoxx CLI
npx skillfoxx add cli/tlrcDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The client downloads reference pages and writes them to a local cache.
This is third-party code. Review the repository files before installing.
What it does
tlrc is a CLI client for the tldr collection of concise command examples. Users request a tool’s page and read common invocations in the terminal. Pages are downloaded to a local cache and can be refreshed based on their age. Languages are selected through configuration or environment variables, with English always included. TOML settings control appearance, line width and the download mirror. Raw Markdown output is available alongside formatted pages.
Who it is for. Developers and administrators who need concise syntax examples next to their working terminal.
Good fit when
- A developer remembers a command name and wants a common invocation.
- An administrator prepares a local reference cache before working offline.
- A user limits example width to fit a narrow terminal.
- A team redirects reference downloads to its own tldr archive mirror.
Not a fit when
- A specialist needs every flag documented for a specific software version.
- An agent needs to execute an operation but the user has only connected a reference client.
- The device never goes online and no local page cache has been prepared.
Example request
Configure tlrc for reading command examples in a narrow terminal, show the config path and do not execute the examples.Limitations
The first page download and local cache refresh require access to the reference mirror. English is always included, even when other languages are selected in configuration. A custom mirror must expose archives and checksums using the tldr naming scheme; an arbitrary website will not work as a mirror. Installing with `cargo install tlrc --locked` does not install the man page or shell completion files.
How to disable. Stop invoking `tldr`; set `auto_update = false` if retaining the client without automatic cache refreshes. Cache and configuration remain local files.
FAQ
Why is the installed command named tldr?
`tlrc` is the package name, while the client command is `tldr`. `tldr --config-path` prints the configuration path for the current system.
How do I generate an initial configuration?
The README gives `tldr --gen-config > "$(tldr --config-path)"`. It writes defaults to the client’s config path; retain an existing customized file before using it.
How do I read a page without waiting for an update?
Set `defer_auto_update = true` in `[cache]`. The client shows the saved page first and refreshes the cache afterward, so you can read examples before the network request finishes.
How do I turn off automatic updates?
Set `auto_update = false` in `[cache]`. The client stops age-based cache refreshes; retain already downloaded pages for offline reading.
Can I output unformatted Markdown?
Yes. Set `raw_markdown = true` in `[output]`. The client then prints the source page Markdown for use by another program.
Discussion
No questions or reviews yet.
Related
CLI toolsA CLI and skill for Yandex Tracker and Wiki: short output readable by people and agents alike, instead of raw MCP payloads costing thousands of tokens
Skill that reads your prompt history, finds the asks you repeat and turns each into a short command such as /sent
Official Todoist command line with an agent skill: tasks, projects and inbox from the terminal
CLI that sorts a messy folder such as Downloads into places with natural-language rules, while an agent judges the files.
A Python CLI that turns Claude Code JSONL transcripts into readable HTML and Markdown with search, filters and a timeline.
An interactive terminal finder selects files, history commands and entries from long lists by matching parts of their names.
README in short
The client is written in Rust. The guide includes Homebrew for Linux and macOS, plus Winget and Scoop for Windows. Systems without a suitable package can use a Cargo build or a prebuilt GitHub Release.