TL;DR — Quick Summary
tealdeer is a fast tldr client that shows simplified, example-driven man pages. Get practical command examples instantly instead of reading through dense man pages.
tealdeer gives you tldr pages — practical, example-driven command reference. Stop scrolling through man pages, get the answer in seconds.
Installation
# macOS
brew install tealdeer
# Arch Linux
sudo pacman -S tealdeer
# Cargo
cargo install tealdeer
# Update pages database
tldr --update
Usage
# Look up any command
tldr tar
tldr git-rebase
tldr docker-run
tldr rsync
tldr ffmpeg
# Update pages
tldr --update
# List all available pages
tldr --list
# Search for a page
tldr --list | grep docker
# Platform-specific pages
tldr --os linux systemctl
tldr --os osx brew
# Show file path
tldr --show-paths
# Custom pages directory
# ~/.config/tealdeer/pages/
Comparison
| Feature | tealdeer | tldr (Node) | man | cheat.sh |
|---|---|---|---|---|
| Language | Rust | Node.js | C | Web |
| Startup | Instant | ~500ms | Instant | Network |
| Offline | Yes | Yes | Yes | No |
| Examples | Community | Community | Official | Community |
| Custom pages | Yes | Yes | No | No |
| Color | Yes | Yes | No | Yes |
Summary
- tealdeer shows simplified, example-driven command reference (tldr pages)
- 2000+ commands covered by community-maintained examples
- Written in Rust — instant startup, zero dependencies
- Offline-first with periodic updates from the tldr-pages project
- Custom pages for internal tools and personal notes