📚 Collaborative cheatsheets for console commands
Go to file
Romain Prieto 79e8896af5 git-stash command 2013-12-09 22:12:24 +11:00
bin initial commit 2013-12-08 19:56:16 +11:00
lib Markdown format closer to the output + highlight replacable tokens 2013-12-09 22:12:16 +11:00
pages/osx git-stash command 2013-12-09 22:12:24 +11:00
test Markdown format closer to the output + highlight replacable tokens 2013-12-09 22:12:16 +11:00
.gitignore initial commit 2013-12-08 19:56:16 +11:00
.tm_properties TextMate configuration 2013-12-08 22:32:25 +11:00
README.md README fix link to pull requests 2013-12-08 20:26:48 +11:00
package.json initial commit 2013-12-08 19:56:16 +11:00
screenshot.png Fix tar example 2013-12-08 21:46:24 +11:00
server.js initial commit 2013-12-08 19:56:16 +11:00

What is this?

New to the command-line world? Or just a little rusty? Or like me 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.

I'm sure people could benefit from simplified "teach me the basics" man pages. What about:

tldr screenshot

Installing

$ npm install -g tldr

Contributing

Your favourite command isn't covered? You can think of more examples?

Just open an issue or send a pull request, it's all Markdown stored right here on Github.

The rough guidelines are:

  • the main description is 2 or 3 bullet points (80 columns)
  • give around 5 examples of the most common usages
  • when in doubt, keep new command-line users in mind