tlrc-tool

Files (1)

• SKILL.md

SKILL.md (first lines)

- Homepage: <https://github.com/tldr-pages/tlrc>
- Documentation: <https://tldr.sh/tlrc/>
- Version: tlrc v1.13.0
- Last updated: 2026-05-15
- This document is generated by deepseek-v4-pro

# tlrc (tldr)

Official tldr client written in Rust. The executable binary is named `tldr`.

TL;DR pages are simplified, community-driven man pages that focus on practical
examples rather than exhaustive documentation.

## Quick start

```bash
tldr tar          # show tldr page for tar
tldr git commit   # show subcommand page (git-commit)
```

If the page exists only for a specific platform, the current OS is used by default.

## Common commands

| Command | Purpose |
|---------|---------|
| `tldr <page>` | Show a tldr page |
| `tldr --update` (`-u`) | Update the local page cache |
| `tldr --list` (`-l`) | List pages for the current platform |
| `tldr --list-all` (`-a`) | List all English pages (all platforms) |
| `tldr --search <keyword>` (`-s`) | Search pages by keyword |
| `tldr --list-platforms` | List available platforms |
| `tldr --info` (`-i`) | Show cache info (path, age, languages, page count) |
| `tldr --render <file>` (`-r`) | Render a local markdown file as a tldr page |
| `tldr --edit` | Print a link to edit the shown page on GitHub |

## Key options

| Option | Purpose |
|--------|---------|
| `-o, --offline` | Never update the cache; error if cache is empty |
| `-c, --compact` | Strip empty lines from output |
| `--no-compact` | Always overrides `--compact` |
| `-R, --raw` | Print pages in raw markdown (no formatting) |
| `--no-raw` | Always overrides `--raw` |
| `--short-options` | Display short options where possible (e.g. `-s` instead of `--long`) |
| `--long-options` | Display long options where possible (default) |
| `-q, --quiet` | Suppress status messages and warnings |
| `--verbose` | Print debug information (use twice for more) |
| `--color <WHEN>` | Control color: `always`, `never`, `auto` (default) |
| `--config <FILE>` | Use an alternative config file |

### `--search`

`--search` searches all platforms by default.

```bash
tldr --search tar
```

## Platform

`--platform` is only needed when looking up commands for a **different** OS.
The current platform is auto-detected, so you normally don't need to set it.

Typical use case: on Windows, looking up commands that will run in WSL2:

```bash
tldr --platform linux tar
```

## Exit codes

| Code | Meaning |
|------|---------|
| 0 | OK |
| 1 | I/O or other errors |
| 2 | Invalid command-line arguments |
| 3 | Config file (TOML) parse error |
| 4 | Cache update errors (e.g. HTTP request failure) |
| 5 | Tldr page syntax error |

## Tips for agents

When an AI agent uses `tldr`:

- **Always use `--offline`** to avoid network requests and stay fast.
- **Always use `--raw`** for raw markdown output - easier to parse than rendered/colored output.

Ideal invocation:

```bash
tldr --offline --raw <page>
```

## Further reference

The homepage (<https://github.com/tldr-pages/tlrc>) and full documentation
(<https://tldr.sh/tlrc/>) cover details this skill intentionally omits to stay
lean. Only consult them when you genuinely need information NOT already in this
skill, such as:

- Installation methods (cargo, npm, Homebrew, etc.)
- Configuration file syntax and all available TOML options
- Cache directory paths per operating system
- Client specification compliance details

From Cologler/Skills, MIT.

More from Cologler/Skills