Go to file
tassadarliu 8e22590d1a
brew: fix typo in Chinese translation (#4927)
2020-11-05 11:22:44 +00:00
.github Checkout all branches in GitHub Actions (#4437) 2020-10-05 16:23:08 +01:00
contributing-guides Update references to Travis in docs 2020-06-26 18:55:59 +02:00
images Update project motto and improve README 2020-06-11 15:10:47 +01:00
pages ctr: add page (#4928) 2020-11-05 07:09:18 -03:00
pages.bs/common zless: add Bosnian translation 2020-10-24 14:03:27 +01:00
pages.da/common chsh: add Danish translation (#4560) 2020-10-07 21:57:52 +01:00
pages.de git-log: add German translation (#4726) 2020-11-02 12:53:52 -03:00
pages.es mysqldump: fix Spanish translation folder (#4931) 2020-11-05 11:12:01 +00:00
pages.fr awk: add operators match (#4606) 2020-11-01 14:42:00 +00:00
pages.hbs/common sha512sum: add hbs translation 2020-02-07 19:09:33 +00:00
pages.hi/common cat, chsh, false, git-init, time, view: add Hindi translations (#4598) 2020-10-12 22:01:55 +01:00
pages.id hugo, java, ls, mongod, pip, pip3, rm: add Indonesian translation (#4911) 2020-11-01 14:37:12 +00:00
pages.it git*: add Italian translation (#4737) 2020-11-03 08:49:29 +01:00
pages.ja ranger: add Japanese translation 2020-10-24 10:20:29 -03:00
pages.ko/common multiple pages: Use snake_case in token syntax (#4788) 2020-11-01 13:40:05 +00:00
pages.ml/linux added malayalam versions of cal, lsmod and nmcli. (#4676) 2020-10-13 09:00:54 -03:00
pages.nl 7z, adb, bash, cargo, cd: add Dutch translation (#4913) 2020-11-01 14:35:52 +00:00
pages.no/common zless: add Norwegian translation 2020-10-19 17:53:12 +01:00
pages.pl/common xkcdpass: add page (#4919) 2020-11-02 08:52:08 -03:00
pages.pt_BR docker-start: add pt_BR translation 2020-11-04 16:34:58 -03:00
pages.pt_PT batch: add Portuguese translation (#4502) 2020-10-08 14:50:24 -03:00
pages.ru/common adb*, chmod, weasyprint: add Russian translation (#4905) 2020-11-04 16:37:23 -03:00
pages.sv/common go-fix, is-up, kotlin, npm-why, users, vimtutor, yarn-why: add Swedish translation (#4787) 2020-10-24 10:55:45 -03:00
pages.ta git-commit: add Tamil translation 2020-10-12 23:13:40 +01:00
pages.th/common tldr: add Thai translation (#4845) 2020-10-28 17:44:44 +00:00
pages.tr 7z: add Turkish translation (#4916) 2020-11-04 16:34:03 -03:00
pages.zh brew: fix typo in Chinese translation (#4927) 2020-11-05 11:22:44 +00:00
pages.zh_TW/common Bulk change: move double quotes outside tokens (#4431) 2020-10-04 18:33:38 +01:00
scripts Checkout all branches in GitHub Actions (#4437) 2020-10-05 16:23:08 +01:00
.editorconfig Trim .editorconfig (#3678) 2019-12-31 13:39:27 +01:00
.gitignore Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) 2020-05-27 22:22:32 +02:00
.markdownlintrc markdownlint: increase maximum line length to 250 2019-05-07 10:08:35 +02:00
CLIENT-SPECIFICATION.md Revert "(chore) replace master/slave with inclusive language (#4459)" (#4532) 2020-10-06 17:48:57 +01:00
COMMUNITY-ROLES.md Minor formatting fixes 2020-05-27 22:22:32 +02:00
CONTRIBUTING.md GOVERNANCE.md, CONTRIBUTING.md: add inclusive language blurb (#4516) 2020-11-03 19:12:50 +00:00
GOVERNANCE.md GOVERNANCE.md, CONTRIBUTING.md: add inclusive language blurb (#4516) 2020-11-03 19:12:50 +00:00
LICENSE.md Minor formatting fixes 2020-05-27 22:22:32 +02:00
MAINTAINERS.md Update @owenvoke username reference (#4123) 2020-06-23 12:46:24 +02:00
README.md README: replace Wikipedia essay with How-To Geek article (#4923) 2020-11-02 12:00:18 +00:00
package-lock.json chore(npm): bump tldr-lint to 0.0.8 (#4415) 2020-10-02 16:33:06 -03:00
package.json chore(npm): bump tldr-lint to 0.0.8 (#4415) 2020-10-02 16:33:06 -03:00

README.md

tldr-pages

Build status Gitter chat Merged PRs GitHub contributors license

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 lsof, or tar?

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

There seems to be room for simpler help pages, focused on practical examples. How about:

screenshot of the tldr-node-client displaying the tldr page for 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 tar, just like you would write man tar to show its manpage.

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?

All tldr 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!

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.

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