📚 Collaborative cheatsheets for console commands

marchersimon c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
.github 43335905fc PULL_REQUEST_TEMPLATE: fix interline space (#6695) há 3 anos atrás
.husky db46da960d deps: upgrade husky to v7.0.1 (#6207) há 3 anos atrás
contributing-guides 99afbe2cf3 maintainers-guide: refresh (#6397) há 3 anos atrás
images 2ef0f6f73c images: add medium font (#5329) há 3 anos atrás
pages c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.ar c3cf706923 gpasswd: add Arabic translation (#6819) há 3 anos atrás
pages.bn 421da6253b snap: add Bengali translation (#6988) há 3 anos atrás
pages.bs 53dadf1dad *: add Bosnian translation for aliases (#6655) há 3 anos atrás
pages.da 9abb079afb replace `man.archlinux.org` with `manned.org` há 3 anos atrás
pages.de c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.es 854bcfbcf9 snake4scores, ubuntu-bug, vipw: add Spanish translation (#7183) há 3 anos atrás
pages.fa e0442c6f98 wall, watch, whereis, whiptail, wipefs, wmctrl, wodim: add link (#6784) há 3 anos atrás
pages.fr c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.hi e42670fd52 scp, ssh: add Hindi translation (#7062) há 3 anos atrás
pages.id 8f3b2e9f45 date: add Indonesian translation (#7121) há 3 anos atrás
pages.it f9c01797e7 pyenv, pyenv-virtualenv: add Italian translation (#6980) há 3 anos atrás
pages.ja 0ddea62ffb du: fix wrong byte units (#7131) há 3 anos atrás
pages.ko 6da5089d9d echo: add Korean translation (#7045) há 3 anos atrás
pages.ml c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.nl 0ddea62ffb du: fix wrong byte units (#7131) há 3 anos atrás
pages.no ab32209de8 lb: add Norwegian translation (#7171) há 3 anos atrás
pages.pl f91465c49a ack: update polish translation (#6997) há 3 anos atrás
pages.pt_BR c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.pt_PT c49bae7d83 spotify: added pt_PT translation. (#7068) há 3 anos atrás
pages.ro 24ba08b5ed todoist: add page (#6361) há 3 anos atrás
pages.ru 1c07b17a6c 7z, 7za, 7zr: update list of archive formats (#7079) há 3 anos atrás
pages.sh 16e4ed5c89 bash, dash, fish, ksh, rbash, sh, zsh: refresh (#5714) há 3 anos atrás
pages.sr 68c22b8396 cd, echo, git, link, mkdir: add Serbian translation (#6692) há 3 anos atrás
pages.sv 67dd1fab50 rm: add Swedish translation (#6981) há 3 anos atrás
pages.ta 642dbf2e97 *: sync more information links in translations (#6537) há 3 anos atrás
pages.th bd3ab881a0 change git to Git on missing pages há 4 anos atrás
pages.tr c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.uk e717d057ab git-commit*: add Ukrainian translation (#6847) há 3 anos atrás
pages.zh c9b5344150 pacman: add sudo and use long options (#7132) há 3 anos atrás
pages.zh_TW 13cd278e3f dir: add traditional Chinese translation (#7130) há 3 anos atrás
scripts 0920259600 set-more-info-link.py, translation-templates/*: add bn, sr, uk translation tags (#7101) há 3 anos atrás
.editorconfig 080fe1a01f Changed indent size for Python files. há 4 anos atrás
.flake8 3fa29ea1c2 tooling: add black and flake8 for python formatting/linting (#6454) há 3 anos atrás
.gitattributes bc369e36ca Update .gitattributes to force GH linguist to recognize pages (#5663) há 4 anos atrás
.gitignore 42c943d762 Made an oopsie in the venv instructions. há 4 anos atrás
.markdownlintrc aa34bdd68b markdownlint: increase maximum line length to 250 há 5 anos atrás
CLIENT-SPECIFICATION.md 8ebd171d6f *: fix typos reported by Hunspell (#5848) há 3 anos atrás
COMMUNITY-ROLES.md c0109fa46e COMMUNITY-ROLES: fix typo (#5976) há 3 anos atrás
CONTRIBUTING.md 7fcc57d205 CONTRIBUTING: fix link to alias-pages (#6626) há 3 anos atrás
GOVERNANCE.md 0c9f1209d1 GOVERNANCE.md, CONTRIBUTING.md: add inclusive language blurb (#4516) há 4 anos atrás
LICENSE.md a66723d2c5 docs: update references to 'main' branch há 3 anos atrás
MAINTAINERS.md 5c62e303b5 *: shellcheck and fix typos (#6526) há 3 anos atrás
README.md eabcc4847b README: add cheat.sh to similar projects (#6928) há 3 anos atrás
bluetoothctl.md 39d33cae10 bluetoothctl: add Malayalam translation (#7060) há 3 anos atrás
package-lock.json 4939d80350 Update tldr-lint to 0.0.13 há 3 anos atrás
package.json 4939d80350 Update tldr-lint to 0.0.13 há 3 anos atrás
requirements.txt b7337112d0 requirements.txt: add requests dependency (#6469) há 3 anos atrás

README.md

tldr-pages

[![Build status][github-actions-image]][github-actions-url] [![Gitter chat][gitter-image]][gitter-url] [![Merged PRs][prs-merged-image]][prs-merged-url] [![GitHub contributors][contributors-image]][contributors-url] [![license][license-image]][license-url]

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:

animated svg of the tldr client displaying 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

You can also use the fully-featured official Python client which can be installed via pip3.

pip3 install 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.

  • cheat.sh Aggregates cheat sheets from multiple sources (including tldr-pages) into 1 unified interface.

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.