The tldr-pages project is a collection of community-maintained help pages
for command-line tools, that aims to be a simpler, more approachable complement
to traditional man pages.
Maybe you're new to the command-line world. Perhaps you're
just a little rusty or can't always recall the arguments for commands
like lsof, or tar?
It certainly doesn't help that, in the past, the first option explained in man tar was:
$ man tar...-b blocksize Specify the block size, in 512-byte records, for tape drive I/O. As a rule, this argument is only needed when reading from or writing to tape drives, and usually not even then as the default block size of 20 records (10240 bytes) is very common....
There is room for simpler help pages focused on practical examples.
How about:
This repository is just that: an ever-growing collection of examples
for the most common UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD,
SunOS, Android, Windows, Cisco IOS, and DOS command-line tools.
How do I use it?
Tip
For browsing without installing a client on your computer,
see the web client at https://tldr.inbrowser.app (with offline support using PWA).
Alternatively, you can also use the official Node.js client, although it has fallen behind in updates:
npm install -g tldr
Then you have direct access to simplified, easy-to-read help for commands, such as tar,
accessible through typing tldr tar instead of the standard man tar.
If you don't want to install any software, check out the PDF version instead.
Note
PDFs for translations are available for most languages. You can find them in the release assets of the latest release.
There are also various other clients provided by the community,
both for the command-line and for other platforms.
For a comprehensive list of clients, head over to our Wiki.
Similar projects
cheat.sh
Aggregates cheat sheets from multiple sources (including tldr-pages)
into 1 unified interface.
devhints
Rico's cheatsheets are not just focused on the command-line and
include a plethora of other cheatsheets related to programming.
eg
provides detailed examples with explanations on the command-line.
Examples come from the repository, but eg supports displaying
custom examples and commands alongside the defaults.
kb
is a minimalist command-line knowledge base manager.
kb can be used to organize your notes and cheatsheets in a minimalist
and clean way. It also supports non-text files.
navi
is an interactive cheatsheet tool, which allows you to browse through
specific examples or complete commands on the fly.
Cheat
allows you to create and view interactive cheatsheets on the command-line.
It was designed to help remind Unix system administrators of options
for commands that they use frequently, but not frequently enough to remember.
bropages (deprecated)
are a highly readable supplement to man pages.
It shows concise, common-case examples for Unix commands.
The examples are submitted by the user base, and can be voted up or down;
the best entries are what people see first when they look up a command.
What does "tldr" mean?
TL;DR stands for "Too Long; Didn't Read".
It originated as Internet slang, where it is used to indicate that a long text
(or parts of it) has been skipped as too lengthy.
Read more in How-To Geek's article.
Open http://localhost:3000 with your browser to see the result. The page auto-updates as you edit the file.
Add New Tools
All tools are located at pages/. To add a new tool, just follow the convention of the exsiting tools. The tech stack is TypeScript + React + CSS Modules.
