Terminal Guide
tealdeer
Fast tldr client for simplified command documentation.
Official WebsiteFeatures
FastOffline SupportCustom PagesCaching
Replaces
manInstallation
Homebrew
brew install tealdeerPacman (Arch)
pacman -S tealdeerCargo (Rust)
cargo install tealdeerWhy Use tealdeer?
tealdeer is a fast tldr client that provides practical examples for command-line tools. Instead of reading lengthy man pages, tealdeer gives you quick, real-world examples in seconds.
Lightning Fast
Written in Rust, tealdeer provides instant command lookups without lag or waiting.
Offline Support
Cache pages locally and search even without internet connection after initial download.
Practical Examples
Focused on real-world usage instead of overwhelming technical documentation.
Custom Pages
Create and share your own custom command examples with the community.
Installation
macOS
macOS Installation
# Using Homebrew
brew install tealdeerLinux
Linux Installation
# Using package manager (AUR on Arch)
pacman -S tealdeer
# Or using Cargo
cargo install tealdeerWindows
Windows Installation
# Using Cargo
cargo install tealdeerFirst Run - Update Cache
Initial Setup
# Download and cache all tldr pages (required on first use)
tldr --update
# Verify installation
tldr lsBasic Usage
Look Up Command Examples
Basic Lookups
# Get examples for a command
tldr ls
# Search for a specific command
tldr grep
# Show examples for git
tldr git
# Get examples for tar
tldr tarOutput Example
ls
List directory contents.
More information: https://www.man7.org/linux/man-pages/man1/ls.1.html
- List files one per line:
ls -1
- List all files including hidden:
ls -a
- Long format list with file details:
ls -l
Common Options
| Option | Description | Example |
|---|---|---|
--update | Update the cache with latest pages | tldr --update |
-p, --platform | Specify OS (linux, osx, windows) | tldr -p linux curl |
-l, --list | List all available pages | tldr --list |
-c, --clear-cache | Clear the local cache | tldr --clear-cache |
--raw | Print output without colors | tldr ls --raw |
-s, --search | Search page descriptions | tldr -s copy |
Practical Examples
Common Command Lookups
Popular Commands
# File operations
tldr cp
tldr mv
tldr rm
tldr find
# Text processing
tldr sed
tldr grep
tldr awk
# System commands
tldr ps
tldr kill
tldr chmod
# Network tools
tldr curl
tldr wget
tldr sshSearch for Related Commands
Search Examples
# Search for commands containing "copy"
tldr -s copy
# Search for commands about "compress"
tldr -s compress
# Find all file-related pages
tldr -s filePlatform-Specific Lookup
Platform Selection
# Get Linux-specific examples
tldr -p linux find
# Get macOS-specific examples
tldr -p osx ls
# Get Windows-specific examples
tldr -p windows dirList and Manage Cache
Cache Management
# List all available pages
tldr --list | head -20
# Count total available pages
tldr --list | wc -l
# Clear cache and re-download
tldr --clear-cache
tldr --update
# Check cache location
ls -la ~/.local/share/tealdeer/Configuration
Configuration File
Create a configuration file at ~/.config/tealdeer/config.toml to customize tealdeer behavior.
~/.config/tealdeer/config.toml
# ~/.config/tealdeer/config.toml
# Color output (true or false)
[display]
use_colors = true
# Language preference
language = "en"
# Updates
[updates]
auto_update = true
auto_update_interval = 604800 # 7 days in seconds
# Cache location
[cache]
cache_dir = "~/.local/share/tealdeer"Shell Aliases
Shell Aliases
# ~/.bashrc or ~/.zshrc
# Use tldr as man replacement
alias man='tldr'
# Quick lookup with shorter alias
alias tl='tldr'
# Search with alias
alias tls='tldr --search'
# Get all pages count
alias tlc='tldr --list | wc -l'Custom Pages Directory
Custom Pages Setup
# Create custom pages directory
mkdir -p ~/.local/share/tealdeer/custom_pages
# Example custom page: mycommand.md
cat > ~/.local/share/tealdeer/custom_pages/mycommand.md <<'EOF'
# mycommand
`Custom examples for my personal tool`
- Do something:
`mycommand --option1 value`
- Another example:
`mycommand --option2`
EOF
# List custom pages
ls ~/.local/share/tealdeer/custom_pages/Tips and Tricks
- •Run
tldr --updateregularly to keep examples fresh and up-to-date - •Use
tldr --listto discover useful commands you didn't know about - •Combine with shell aliases like
alias man=tldrfor quick access - •The
--searchflag is helpful when you know what you want to do but not the exact command name - •Works great in shell scripts since it can output raw text with the
--rawflag - •Cache is stored at
~/.local/share/tealdeer/- safe to delete to reclaim space
Comparison with Alternatives
| Feature | man | tldr (online) | tealdeer |
|---|---|---|---|
| Speed | Slower (detailed) | Depends on network | Very fast |
| Offline Support | Built-in | No (web-based) | Cached |
| Practical Examples | Technical | Real-world | Real-world |
| Learning Curve | Steep | Easy | Easy |
| Installation | Usually built-in | Requires browser | Quick install |