📚 Collaborative cheatsheets for console commands

Starccy 7650cf7746 arp: add Chinese translation 6 سال پیش
.github 77924e3ea0 Pull request template: change "folder" to "directory". 6 سال پیش
contributing-guides 872f716fdc Style guide: change "folder" to "directory". 6 سال پیش
pages 1c66acf268 jq: add 'combines multiple filters' example (#2917) 5 سال پیش
pages.it 15e638ca64 cmark: add Italian translation. 6 سال پیش
pages.pt-BR 86139ae4be 7za: improve description and use proper accenting in tokens (#2921) 5 سال پیش
pages.ta 356b346edf cp,ls,mkdir,mv,rm,rmdir: add translations [Tamil] (#2512) 6 سال پیش
pages.zh 7650cf7746 arp: add Chinese translation 5 سال پیش
scripts 697d8b3b78 deploy: use top-level index.json 6 سال پیش
.editorconfig f1d3e87069 Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 9 سال پیش
.gitignore 8ce4c60a44 Update macOS references 7 سال پیش
.markdownlintrc 72196b030d Use NodeJS NPM package markdownlint instead of Ruby gem mdl 9 سال پیش
.travis.yml 47714527a6 TravisCI: don't clean build dir needed for deployment. 6 سال پیش
CLIENT-SPECIFICATION.md fbdc06b742 clieent spec: Add messaage to page resolution section 6 سال پیش
COMMUNITY-ROLES.md de2b04eb49 COMMUNITY-ROLES: fix usage of angle brackets (#2911) 5 سال پیش
CONTRIBUTING.md 5dd4d97a45 Contributing: simplify translation guidelines. 6 سال پیش
GOVERNANCE.md a35641b4ac GOVERNANCE.md: link to the maintainer's guide 6 سال پیش
LICENSE.md 8f1b910ef6 unwrap copyright notice 8 سال پیش
MAINTAINERS.md 6973305bba MAINTAINERS.MD: Add @schneiderl as contributor (#2899) 6 سال پیش
README.md 8a6d334339 Add pacman line for installing tldr-python-client on arch (#2877) 6 سال پیش
package.json 7105f3c20a build-index: generate top-level copy of the index 6 سال پیش
screenshot.png 007ae49340 Updating screenshot (#957) 8 سال پیش

README.md

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors Number of files 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 / macOS / 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! We strive to maintain a welcoming and collaborative community. 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.

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

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 Wikipedia's TL;DR article.