Need help with tldr?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

32.7K Stars 2.6K Forks Other 8.3K Commits 122 Opened issues


📚 Collaborative cheatsheets for console commands

Services available


Need anything else?

Contributors list


[![Build status][github-actions-image]][github-actions-url] [![Gitter chat][gitter-image]][gitter-url] [![Merged PRs][prs-merged-image]][prs-merged-url] [![GitHub contributors][contributors-image]][contributors-url] [![license][license-image]][license-url]

What is tldr-pages?

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 are new to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to

, or

It certainly doesn't help that the first option explained in

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 seems to be room for simpler help pages, focused on practical examples. How about:

animated svg of the tldr client displaying the tar command

This repository is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS and Windows command-line tools.

How do I use it?

A popular and convenient way to access these pages on your computer is to install the Node.js client, which is supported by the tldr-pages project maintainers:

npm install -g tldr

That way you can write

tldr tar
in the terminal to show the tldr page for
, just like you would write
man tar
to show its manpage.

However, if you just want to browse without installing anything, check out the PDF version.

There are also various other clients provided by the community, both for the command line and for other platforms:

There is also a comprehensive list of clients in our Wiki.

How do I contribute?

  • Your favourite command isn't covered?
  • You can think of more examples for an existing command?


pages are kept as Markdown files right here in this repository, so you can edit them directly and submit your changes as pull requests.

All contributions are welcome! We strive to maintain a welcoming and collaborative community. Have a look at the contributing guidelines, and go ahead!

If you'd like to contribute to translations, you can visit to see the current progress of all translations.

Similar projects

  • Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

  • Bro pages are a highly readable supplement to man pages. Bro pages show 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.

  • 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 supports also non-text files.

  • eg provides detailed examples with explanations on the command line. Examples come from the repository, but

    supports displaying custom examples and commands alongside the defaults.
  • devhints Rico's cheatsheets are not just focused on the command line and include a plethora of other cheatsheets related to programming.

What does "tldr" mean?

TL;DR stands for "Too Long; Didn't Read". It originates in 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.