📚 Collaborative cheatsheets for console commands
Go to file
Eric Nielsen 8d93237d63 vim: Normal mode is the normal mode (#1106)
* vim: Improvements we can can agree on

Remove spaces between keypresses (as it could lead users to think they
should type a space there).
Simplify regexp substitution example.
Add ...then... to search example.
Add quit without saving example.

* vim: Improvements we can can agree on

Move search keystrokes to the example title.
Keep original regexp substitution example. See conversation starting at
ee1472e76f (r82820204)
2016-10-12 05:28:21 +02:00
pages vim: Normal mode is the normal mode (#1106) 2016-10-12 05:28:21 +02:00
scripts Fix build-index.js coding style (#1101) 2016-10-02 10:19:50 +05:30
.editorconfig Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 16:54:05 +02:00
.gitignore clarify .gitignore comments 2016-06-24 13:58:58 +01:00
.lgtm Restoring lgtm.co integration; giving it another go to see if we can make it work this time 2016-09-08 09:18:20 +01:00
.markdownlintrc Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
.travis.yml Setting cache to false (#1095) 2016-10-02 21:40:11 +02:00
CONTRIBUTING.md add badges to contributing.md 2016-10-02 11:08:44 +01:00
LICENSE.md license: mention contributors 2016-09-29 21:10:05 +01:00
MAINTAINERS add @agnivade to the list of maintainers 2016-09-08 09:22:43 +01:00
package.json Removed = from dependencies as they are redundant 2016-10-03 23:47:21 +05:30
README.md Remove CLA badge from README 2016-09-30 13:18:41 +05:30
screenshot.png Updating screenshot (#957) 2016-07-16 09:12:59 +01:00

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors license

A collection of simplified and community-driven man pages.

Install it with npm install -g tldr or try the web client.

What is tldr?

New to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to lsof, or tar?

Maybe it doesn't help that the first option explained in man tar is:

-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.

Surely people could benefit from simplified man pages focused on practical examples. How about:

tldr screenshot

This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / OSX / SunOS commands.

Clients

You can access these pages on your computer using one of the following clients:

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

Contributing

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

Contributions are most welcome! Have a look at the contributing guidelines and go ahead!

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.

What does "tldr" mean?

TL;DR stands for "Too Long; Didn't Read". It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy. Read more in the TLDR article on Wikipedia.