Go to file
Puneetha Pai f45f4dafcb dvc diff: Apply suggestions from code review
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
2020-08-21 23:53:25 +01:00
.github Update to use `actions/stale` instead of Stale Bot (#4143) 2020-07-14 23:28:34 +02: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 dvc diff: Apply suggestions from code review 2020-08-21 23:53:25 +01:00
pages.de/common 7z, ansible-playbook, ansible-vault, plantuml: add german translation (#4234) 2020-08-02 20:47:28 +02:00
pages.es git-diff: remove 9th example (#4204) 2020-07-23 11:06:21 +08:00
pages.fr/common git-add: fix typos (fr; #4249) 2020-08-10 00:17:27 +01:00
pages.hbs/common sha512sum: add hbs translation 2020-02-07 19:09:33 +00:00
pages.it/common git-diff: remove 9th example (#4204) 2020-07-23 11:06:21 +08:00
pages.ja/common tldr: add japanese translation (#3774) 2020-01-22 23:58:26 +00:00
pages.ko/common ack: fix typo (#4196) 2020-07-16 22:33:06 +01:00
pages.pl/common Fix polish grammar in atom (#4109) 2020-06-18 12:31:34 +02:00
pages.pt_BR zip (pt_BR): fix example (#4260) 2020-08-16 16:26:55 +01:00
pages.pt_PT multiple pages: use infinitive in command descriptions of pt-PT pages (#4235) 2020-07-31 15:27:03 +02:00
pages.ta/common ack: fix typo (#4196) 2020-07-16 22:33:06 +01:00
pages.zh dos2unix, mac2unix, unix2dos, unix2mac: add Chinese translations (#4168) 2020-07-17 17:55:40 +01:00
pages.zh_TW/common cat: add Traditional Chinese translation 2020-07-21 22:51:05 +02:00
scripts Fix PULL_REQUEST_ID reference when not set 2020-06-26 18:55:59 +02: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 CLIENT-SPECIFICATION: clarify fallback to english (#4101) 2020-07-21 22:47:30 +02:00
COMMUNITY-ROLES.md Minor formatting fixes 2020-05-27 22:22:32 +02:00
CONTRIBUTING.md Tweak badge colors in README.md and CONTRIBUTING.md (#4110) 2020-06-19 00:38:47 +02:00
GOVERNANCE.md GOVERNANCE.md: link to the maintainer's guide 2018-11-27 17:34:47 +05:30
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: Add link to discord bot (#4258) 2020-08-16 16:26:10 +01:00
package-lock.json build(deps): bump minimist from 1.2.0 to 1.2.5 (#3921) 2020-03-18 21:17:46 +00:00
package.json Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) 2020-05-27 22:22:32 +02: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.

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.