Go to file
Patrice Denis ca8394dc52
apt-*: add more info links; apt-file: add regex search example (#5710)
2021-04-17 10:26:03 -03:00
.github ci: have stalebot ignore issues with the 'stalebot ignore' label (#5372) 2021-03-16 09:19:52 +00:00
.husky deps: update deps (#5411) 2021-04-07 10:16:21 -04:00
contributing-guides contributing-guides/style-guide: add block device rules (#5036) 2021-03-29 14:21:55 +02:00
images Update project motto and improve README 2020-06-11 15:10:47 +01:00
pages apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.bs/common coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
pages.da/common chsh: add Danish translation (#4560) 2020-10-07 21:57:52 +01:00
pages.de apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.es apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.fa *: trim multiple spaces, fix line endings 2021-04-04 00:44:24 +01:00
pages.fr apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.hi/common *: clean up token syntax delimiters (#5677) 2021-04-03 20:08:57 -04:00
pages.id *: trim multiple spaces, fix line endings 2021-04-04 00:44:24 +01:00
pages.it apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.ja *: trim multiple spaces, fix line endings 2021-04-04 00:44:24 +01:00
pages.ko user*, group*, add*, group*: add more info links (#5738) 2021-04-17 14:19:41 +02:00
pages.ml/linux apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.nl autopep8: add page (#5645) 2021-04-02 14:31:33 -04:00
pages.no/common coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
pages.pl/common coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
pages.pt_BR apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.pt_PT coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
pages.ru/common tar: remove extra example (#5762) 2021-04-15 13:47:37 -04:00
pages.sh/common bash, dash, fish, ksh, rbash, sh, zsh: refresh (#5714) 2021-04-14 16:07:21 +02:00
pages.sv/common coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
pages.ta *: trim multiple spaces, fix line endings 2021-04-04 00:44:24 +01:00
pages.th/common change git to Git on missing pages 2021-01-08 13:09:54 +00:00
pages.tr apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.zh apt-*: add more info links; apt-file: add regex search example (#5710) 2021-04-17 10:26:03 -03:00
pages.zh_TW/common coreutils*: use short more info links (#5658) 2021-04-01 18:54:26 +03:00
scripts set-more-info-link.py: remove leading space in Persian label 2021-04-04 00:44:50 +01:00
.editorconfig Changed indent size for Python files. 2020-12-18 22:40:29 -05:00
.gitattributes Update .gitattributes to force GH linguist to recognize pages (#5663) 2021-04-01 14:32:17 -04: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 Client spec: mention releases in maintainer notes 2021-03-25 00:38:35 +00:00
COMMUNITY-ROLES.md COMMUNITY-ROLES: fix broken links (#5222) 2021-02-12 20:33:19 +00:00
CONTRIBUTING.md CONTRIBUTING: improve wording about example count limit (#5760) 2021-04-15 14:16:25 -03: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 MAINTAINERS: add @Waples to collaborators (#5775) 2021-04-16 15:50:57 -03:00
README.md README: update clients' urls (#5661) 2021-04-02 15:08:05 -04:00
package-lock.json deps: update deps (#5411) 2021-04-07 10:16:21 -04:00
package.json Move husky install to prepare run-script (#5711) 2021-04-08 15:09:05 -04: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.

However, if you just want to browse without installing anything, check out the PDF version.

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!

If you'd like to contribute to translations, you can visit https://lukwebsforge.github.io/tldri18n/ to see the current progress of all translations.

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.