tldr-pages — Simplified, Community-Driven Man Pages
tldr-pages replaces cryptic man pages with practical examples. Type `tldr tar` and see the 5 commands you actually use — no more scrolling through 50 flags you will never touch.
What it is
tldr-pages is a community-curated collection of simplified command-line documentation. Where man tar shows hundreds of lines of options, tldr tar shows the five common invocations with real-world examples.
tldr-pages targets developers, sysadmins, and anyone who uses the terminal but does not want to read full man pages to find the one flag they need. Pages are available for Linux, macOS, Windows, and platform-specific commands.
How it saves time or tokens
tldr-pages eliminates the time spent scrolling through man pages or searching Stack Overflow for common command usage patterns. For AI agents, tldr-pages provides concise command references that fit within small context windows, reducing token consumption compared to full documentation.
How to use
- Install a tldr client:
# Node.js client
npm install -g tldr
# Rust client (fastest)
brew install tealdeer
# Python client
pip install tldr
- Look up any command:
tldr tar,tldr git commit,tldr ffmpeg.
- Update your local cache:
tldr --update.
Example
$ tldr tar
tar
Archiving utility.
- Create an archive from files:
tar cf target.tar file1 file2 file3
- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3
- Extract an archive in the current directory:
tar xf source.tar
- Extract a gzipped archive:
tar xzf source.tar.gz
- List the contents of an archive:
tar tf source.tar
Related on TokRepo
- Coding Tools -- Developer productivity tools
- Documentation Tools -- Documentation and reference tools
Common pitfalls
- tldr clients cache pages locally. If a page is missing, run
tldr --updateto refresh the cache. - Not every command has a tldr page yet. The project accepts contributions via pull requests to the tldr-pages GitHub repository.
- Different tldr clients (Node, Rust, Python) have slightly different features and update mechanisms. Tealdeer (Rust) is the fastest for local lookups.
Frequently Asked Questions
tldr-pages covers thousands of commands across Linux, macOS, Windows, and common developer tools. The collection grows continuously through community contributions via GitHub pull requests.
Yes. tldr-pages accepts contributions on GitHub. Each page follows a simple Markdown format with a description and 5-8 practical examples. The project has contribution guidelines and a style guide.
man pages are the official system documentation -- comprehensive but dense. tldr pages are community-written summaries showing only the most common usage patterns with practical examples. They complement rather than replace man pages.
Tealdeer (Rust) is the fastest for lookups. The Node.js client (npm tldr) has the widest adoption. The Python client works well in Python-heavy environments. All clients use the same underlying page database.
Yes. tldr clients download and cache pages locally. After an initial tldr --update, all lookups are offline. You only need internet access to update the cache with new pages.
Citations (3)
- tldr-pages GitHub— tldr-pages is a community-curated collection of simplified man pages
- tldr-pages Official Site— tldr client specification and page format
- Tealdeer GitHub— Tealdeer is a fast Rust implementation of the tldr client
Related on TokRepo
Discussion
Related Assets
Conda — Cross-Platform Package and Environment Manager
Install, update, and manage packages and isolated environments for Python, R, C/C++, and hundreds of other languages from a single tool.
Sphinx — Python Documentation Generator
Generate professional documentation from reStructuredText and Markdown with cross-references, API autodoc, and multiple output formats.
Neutralinojs — Lightweight Cross-Platform Desktop Apps
Build desktop applications with HTML, CSS, and JavaScript using a tiny native runtime instead of bundling Chromium.