Go to file
Laurent Indermühle d8be3f35a3
sudo: add --login, --shell and --list examples (#5202)
add more information link
2021-01-30 18:04:40 -03:00
.github ci: generate PDF version of tldr pages 2020-12-04 18:48:24 +00:00
contributing-guides rename git to Git 2021-01-08 13:09:54 +00:00
images Update project motto and improve README 2020-06-11 15:10:47 +01:00
pages sudo: add --login, --shell and --list examples (#5202) 2021-01-30 18:04:40 -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 brew-bundle, caffeinate, open and tmutil: add German translation (#5178) 2021-01-24 11:23:41 -05:00
pages.es multiple pages: normalize "more information" labels (#5140) 2021-01-15 14:24:49 -03:00
pages.fa cp: fix Persian translation (#5192) 2021-01-28 07:02:30 -03:00
pages.fr multiple pages: fix French colon punctuation (#5152) 2021-01-30 17:03:18 +00:00
pages.hbs/common rename git to Git 2021-01-08 13:09:54 +00:00
pages.hi/common multiple pages, MAINTAINERS: remove trailing whitespace at line ends (#5151) 2021-01-16 10:33:31 -05:00
pages.id multiple pages: normalize "more information" labels (#5140) 2021-01-15 14:24:49 -03:00
pages.it multiple pages, MAINTAINERS: remove trailing whitespace at line ends (#5151) 2021-01-16 10:33:31 -05:00
pages.ja multiple pages: normalize "more information" labels (#5140) 2021-01-15 14:24:49 -03:00
pages.ko/common cradle-sql: fix page name 2021-01-17 01:35:59 -03:00
pages.ml/linux pacman: add more information link (#5146) 2021-01-19 11:40:16 -03:00
pages.nl dir, find, rmdir, shutdown: add Dutch translation (#4977) 2020-11-22 18:54:46 -03:00
pages.no/common zless: add Norwegian translation 2020-10-19 17:53:12 +01:00
pages.pl/common rename git to Git 2021-01-08 13:09:54 +00:00
pages.pt_BR multiple pages, MAINTAINERS: remove trailing whitespace at line ends (#5151) 2021-01-16 10:33:31 -05:00
pages.pt_PT batch: add Portuguese translation (#4502) 2020-10-08 14:50:24 -03:00
pages.ru/common multiple pages: normalize "more information" labels (#5140) 2021-01-15 14:24:49 -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 multiple pages: normalize "more information" labels (#5140) 2021-01-15 14:24:49 -03:00
pages.th/common change git to Git on missing pages 2021-01-08 13:09:54 +00:00
pages.tr docker, docker-build, docker-compose: translate to Turkish (tr) (#5177) 2021-01-28 17:48:22 +00:00
pages.zh gpg: add Chinese translation (#5193) 2021-01-29 22:16:53 -05:00
pages.zh_TW/common change git to Git on missing pages 2021-01-08 13:09:54 +00:00
scripts ci: add tldr-pages/tldr before commit hash for auto gh linking (#5072) 2021-01-03 21:48:47 +00:00
.editorconfig Changed indent size for Python files. 2020-12-18 22:40:29 -05:00
.gitattributes Add .gitattributes file to normalize line endings 2021-01-12 14:36:36 +00:00
.gitignore Made an oopsie in the venv instructions. 2020-12-04 12:17:52 -05:00
.markdownlintrc markdownlint: increase maximum line length to 250 2019-05-07 10:08:35 +02:00
CLIENT-SPECIFICATION.md Fix changelog links in CLIENT-SPECIFICATION.md (#5059) 2021-01-02 14:33:40 -03:00
COMMUNITY-ROLES.md Improve role change message templates 2020-12-26 15:18:16 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-01-08 13:09:54 +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 multiple pages, MAINTAINERS: remove trailing whitespace at line ends (#5151) 2021-01-16 10:33:31 -05:00
README.md README: change tldr Persian web client address (#5199) 2021-01-29 10:45:09 -03:00
package-lock.json chore(deps): update tldr-lint to 0.0.9 (#5082) 2021-01-04 08:23:17 -05:00
package.json chore(deps): update tldr-lint to 0.0.9 (#5082) 2021-01-04 08:23:17 -05: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.

  • kb is a minimalist command line knowledge base manager. kb can be used to organize your notes and cheatsheets in a minimalist and clean way. It supports also non-text files.

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