tealdeer
A Rust implementation of the tldr client that shows simplified, example-based community man pages.
Tested on Linux
Use it
Linux x86_64
Download static musl release binary to ~/.local/bin/tldr
mkdir -p ~/.local/bin && curl -fsSL https://github.com/tealdeer-rs/tealdeer/releases/latest/download/tealdeer-linux-x86_64-musl -o ~/.local/bin/tldr && chmod +x ~/.local/bin/tldr
Check that it works
tldr --versionThe output should contain “tealdeer 1.9.1”.
First thing to try
mkdir -p ~/.config/tealdeer && cat > ~/.config/tealdeer/config.toml <<'EOF'
[display]
compact = true
use_pager = false
[style.command_name]
foreground = "red"
bold = true
[style.example_code]
foreground = "green"
underline = true
EOFtldr --show-pathsRun tldr --update first to download the pages, then tldr <command> to look one up.
What it does
- Download and cache the tldr pagesTested
How to use it
- Run
tldr --updateto download the pages and store them locally.
- Run
- View pages without a network connectionTested
How to use it
- Run
tldr --updateonce to fill the cache. - Run
tldr <command>, for exampletldr tar, to see short usage examples.
- Run
- Customize highlighting and other settingsNot shown working
How far pickfit got
Linux x86_64
- Installs
- Starts
- 2 of 3 features work
- Works offline
macOS and Windows: the project says it runs there; pickfit hasn’t tried it.
Good for
- look up short example-based usage of a command
How pickfit tested it
Each run starts from a clean machine and follows the steps above. How pickfit verifies
Linux x86_64
Its main function works
- Replayed from scratch
- Works offline
- Checked on 15 Nov 2026
- Version tealdeer 1.9.1
Differences the test machine hit
- README: Release build: cargo build --release
In the test: No Rust toolchain needed: the README also points to static binaries on the GitHub releases page; tealdeer-linux-x86_64-musl from releases/latest works as-is - README: Don't require a network connection for anything besides updating the cache
In the test: Run `tldr --update` once (with network) before viewing pages; the cache starts empty