What Is the tldr Command
The tldr command is one of those tools I wish I had found years ago. It gives you simplified, community-driven man pages for almost any Linux command. Instead of wading through fifty pages of options you will never use, it shows you practical examples right in your terminal. That is the whole idea.
Think of it as a cheat sheet that lives on your command line. Open a terminal and type tldr tar and you get common tar usage patterns, not a novel about tar format history. Every page comes from the tldr-pages community repository on GitHub, so thousands of people contribute and update these summaries. The project itself is open source under MIT license.
I use tldr constantly when I touch a tool I haven’t used in months. A quick tldr command call saves me from opening a browser or scrolling through a man page for thirty seconds. If you work in a terminal every day, this tool will make your life easier.
Installing tldr on Linux
The easiest way to install tldr is with pipx. Pipx keeps Python tools in isolated environments so they do not mess with your system Python. If you do not have pipx yet, install it first:
sudo apt install pipx
pipx ensurepath
Then install tldr in one line:
pipx install tldr
Close your terminal and open a new one, or run source ~/.bashrc to pick up the new path. Type tldr --version to confirm it works. There are other clients too. The Node.js version is popular. Go and Rust clients exist if you prefer those. But the Python client through pipx is the most mature and well tested option.
On macOS you can use Homebrew: brew install tldr. On Fedora or RHEL, try dnf install tldr. The official tldr.sh site has the full installation guide for every operating system.
Using the tldr Command for Quick Help
Once installed, using the tldr command is straightforward. Type tldr followed by the name of any command you want help with:
tldr tar
tldr find
tldr grep
tldr curl
Each output gives you five to ten common use cases with ready to copy commands. No flags to memorize. No obscure syntax. Just the patterns people actually use. The tldr command pulls these from the community repository, so they reflect real world usage, not theoretical edge cases.
1. Viewing Basic Examples for Any Tool
Try it with a tool you use daily. Run tldr ls and you will see examples for listing files with human readable sizes, sorting by time, and showing hidden files. Here is what the output looks like:
$ tldr ls
ls
List directory contents.
- List files one per line:
ls -1
- List all files, including hidden files:
ls -a
- List all files with trailing / added to directory names:
ls -F
- Long format list of all files:
ls -la
Notice how each entry starts with a clear description and the flag. You do not have to decode what -laF means. The example tells you. That is the practical approach the tldr command takes with every page.
2. Updating the Local Cache
The tldr command caches pages locally so you can use it offline. New commands and updates get added to the GitHub repository all the time. To refresh your cache, run:
tldr --update
This pulls the latest pages from the repository. Run it once a week or whenever you want fresh content. The command itself finishes in a few seconds.
You can also clear your cache entirely: tldr --clear-cache. I do this sometimes when things feel stale and I want a clean refresh. Then tldr fetches pages on demand again. Either way, you always get up to date help when you need it.
3. Finding Specific Pages
Not sure if a command has a tldr page? There is a search feature for that:
tldr --list
tldr --list | grep docker
The first command lists every available page. The second filters for Docker related commands. I use this to discover tools I did not know had tldr pages. Running tldr --list | grep git shows over forty git subcommands with dedicated pages. It is a good way to explore what the tldr command can teach you about your own system.
Customizing tldr Output
Tldr lets you pick the operating system platform for its output. By default it shows Linux pages, but you can switch to macOS, Windows, or SunOS:
tldr -p macos ls
tldr -p windows ipconfig
This is useful if you manage cross platform systems. I sometimes help friends on macOS and the -p macos flag gives me the right syntax without trial and error.
You can also set the platform permanently with an environment variable:
export TLDR_PLATFORM=macos
Add that to your .bashrc or .zshrc if you work on multiple operating systems regularly. Tldr respects this variable on every invocation.
Another handy option is --no-color if you need plain output for scripts or terminal recording tools. The --no-paging flag is useful when piping output into another command.
How tldr Compares to Man Pages
Traditional man pages are thorough. They cover every flag, every edge case, and every historical behavior. That level of detail is valuable when you need deep understanding. But most of the time you just want to remember how to extract a tar file or find files by name.
Tldr strips away everything except the common use cases. It does not replace man. It complements it. I still use man ssh_config when I need to understand a specific configuration option. But for everyday tasks, tldr gets me the answer faster.
Here is a direct comparison for the tar command. Man tar spans hundreds of lines covering POSIX standards, extended headers, and compatibility flags. Tldr tar shows you create an archive, extract an archive, list its contents, and handle compression. That covers ninety percent of what people actually do with tar.
Building a Better Terminal Stack with the tldr Command
I mentioned earlier that I pair tldr with other modern terminal replacements. These tools work together to make the command line faster and more pleasant.
Use bat to read files with syntax highlighting, fzf for fuzzy finding, and the tldr command for quick reminders on syntax. Add ripgrep for fast file searching and you have a terminal that feels nothing like the bare default. Tldr fits naturally into this stack because it solves a specific problem well.
Give it a shot. Install tldr today, run tldr tar or tldr find, and see if you go back to scrolling man pages afterward. I bet you won’t.