tldr(1)
Display simple, practical examples for command-line tools from the tldr community.
Synopsis
tldr [OPTION]... COMMANDDescription
tldr is a simplified, crowdsourced man page system that shows practical examples for command-line tools. It fetches curated pages from the tldr-pages project, offering quick lookup without verbose documentation.
Pages are typically much shorter than traditional man pages, focusing on real-world usage patterns and common flags rather than complete technical specifications.
Common options
| Flag | What it does |
|---|---|
-l, --list | show all available pages |
-p, --platform PLATFORM | select page for specific platform (linux, osx, windows, sunos, common) |
-u, --update | download and cache the latest tldr pages |
-c, --clear-cache | delete cached tldr pages |
-r, --random | show a random page |
-s, --search KEYWORD | search for pages matching keyword |
-L, --list-all | show all pages across all platforms |
--cache-dir PATH | set custom cache directory location |
Examples
show practical examples for the ls command
tldr lsshow find command examples specific to macOS
tldr -p osx findlist all available tldr pages in your cache
tldr -lupdate cached pages to the latest version
tldr -usearch for all pages containing 'network'
tldr -s networkdisplay a random command example to learn something new
tldr -rshow common grep usage patterns with examples
tldr grep