1
0

📚 Collaborative cheatsheets for console commands

Emily Grace Seville b08a8f2e8c ISSUE_TEMPLATE: add templates (#7743) 2 жил өмнө
.github b08a8f2e8c ISSUE_TEMPLATE: add templates (#7743) 2 жил өмнө
.husky db46da960d deps: upgrade husky to v7.0.1 (#6207) 3 жил өмнө
contributing-guides 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
images 8b531c09bb CONTRIBUTING, git-terminal: explain common contrib issues (#7107) 3 жил өмнө
pages 918891f311 perl: improve matching pattern example, arg consistency, etc. (#8043) 2 жил өмнө
pages.ar 37ab478d79 fastmod: add page (#7815) 3 жил өмнө
pages.bn 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
pages.bs b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.ca 97c6028809 color, dir, nautilus, touch, wal: add Catalan translation (#7965) 2 жил өмнө
pages.da 9abb079afb replace `man.archlinux.org` with `manned.org` 3 жил өмнө
pages.de 9c3619928b tar: fix spelling in German translation (#7964) 2 жил өмнө
pages.es 2ce63b334e brightness, n, open, pbcopy, pbpaste, rename, route, rubocop, softwareupdate, timed, where, while, xed, xip: add link (#7831) 3 жил өмнө
pages.fa 3d4b1168a8 7z: add Persian translation (#7765) 3 жил өмнө
pages.fr fad355136f chromium, code, gimp, powershell : add French translation (#8037) 2 жил өмнө
pages.hi b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.id e684c95af0 bat, gdb: add Indonesian translation (#7745) 3 жил өмнө
pages.it b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.ja b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.ko 263bc24e11 git, git-abort, git-add, git-alias, git-cherry-pick, git-clone: add Korean translation (#8035) 2 жил өмнө
pages.ml 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
pages.ne 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
pages.nl b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.no b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.pl b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.pt_BR 5e6357095b banner: add pt_BR translation (#7864) 3 жил өмнө
pages.pt_PT 2ce63b334e brightness, n, open, pbcopy, pbpaste, rename, route, rubocop, softwareupdate, timed, where, while, xed, xip: add link (#7831) 3 жил өмнө
pages.ro 24ba08b5ed todoist: add page (#6361) 3 жил өмнө
pages.ru 61805c1a25 jq: remove filename dangling quote (#8063) 2 жил өмнө
pages.sh 16e4ed5c89 bash, dash, fish, ksh, rbash, sh, zsh: refresh (#5714) 3 жил өмнө
pages.sr 68c22b8396 cd, echo, git, link, mkdir: add Serbian translation (#6692) 3 жил өмнө
pages.sv c2c16f61ac *: use author link instead of npm package (#7730) 3 жил өмнө
pages.ta 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
pages.th b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.tr 119c84205e ip-neighbour.md : title : the command is "ip" and not "ip-neighbour" (#7973) 2 жил өмнө
pages.uk 87781641f6 dog, dokku: add Ukrainian translation (#8036) 2 жил өмнө
pages.uz b99f3da787 *: update links via set-more-info-link.py (#7611) 3 жил өмнө
pages.zh 9c115e834f fix: Correct a translation error (#8004) 2 жил өмнө
pages.zh_TW 27ff55fc2e *: normalize colons (#7913) 3 жил өмнө
scripts adf4448df8 set-more-info-link.py: add Catalan translation (#7797) 3 жил өмнө
.editorconfig a7724b7c2f .editorconfig: set trim_trailing_whitespace to false (#7958) 2 жил өмнө
.flake8 3fa29ea1c2 tooling: add black and flake8 for python formatting/linting (#6454) 3 жил өмнө
.gitattributes bc369e36ca Update .gitattributes to force GH linguist to recognize pages (#5663) 4 жил өмнө
.gitignore 5980dfdf29 .gitignore: add .idea to ignored files (#8033) 2 жил өмнө
.markdownlintrc aa34bdd68b markdownlint: increase maximum line length to 250 5 жил өмнө
CLIENT-SPECIFICATION.md 9ac1ffd5ca CLIENT-SPECIFICATION: Add entry to unreleased changelog (#7806) 3 жил өмнө
COMMUNITY-ROLES.md 6713d2f2fe COMMUNITY-ROLES: fix link (#7500) 3 жил өмнө
CONTRIBUTING.md 0bbe0c1310 CONTRIBUTING: clarify guideline for new PRs (#7450) 3 жил өмнө
GOVERNANCE.md 0c9f1209d1 GOVERNANCE.md, CONTRIBUTING.md: add inclusive language blurb (#4516) 4 жил өмнө
LICENSE.md a66723d2c5 docs: update references to 'main' branch 3 жил өмнө
MAINTAINERS.md 07612ed011 MAINTAINERS: add @EmilySeville7cfg to org (#8062) 2 жил өмнө
README.md 8e819a17d9 README: add navi project (#7496) 3 жил өмнө
package-lock.json f8d78df90d package-lock.json: bump minimist from 1.2.5 to 1.2.6 (#7928) 3 жил өмнө
package.json 6fe5cd71fd package.json: update dependencies (#7779) 3 жил өмнө
requirements.txt 8f25ac9cf5 fix CI issues (#7937) 3 жил өмнө

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. For a comprehensive list of clients, head over to 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

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

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

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

  • devhints Rico's cheatsheets are not just focused on the command-line and include a plethora of other cheatsheets related to programming.

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

  • 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 also supports non-text files.

  • navi is an interactive cheatsheet tool, which allows you to browse through specific examples or complete commands on the fly.

What does "tldr" mean?

TL;DR stands for "Too Long; Didn't Read". It originated as 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.