📚 Collaborative cheatsheets for console commands
 
 
 
 
Go to file
K.B.Dharun Krishna 5da4cacd9c
style-guide: update page (#12304)
* style-guide: update page

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
2024-02-23 16:33:59 +05:30
.github MAINTAINERS: add @noraj as collaborator (#12331) 2024-02-22 21:01:09 +01:00
.husky build(deps-dev): bump husky from 8.0.3 to 9.0.7 (#12175) 2024-02-01 16:39:13 +01:00
contributing-guides style-guide: update page (#12304) 2024-02-23 16:33:59 +05:30
images README: replace animation with PNG for accessibility (#8720) 2023-10-23 00:05:43 +05:30
pages pages*: use "an SQL" instead of "a SQL" (#12336) 2024-02-23 13:51:08 +05:30
pages.ar rmdir: fix Arabian more info, ps: fix Chinese more info (#12036) 2024-01-10 09:51:22 +01:00
pages.bn pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.bs pages*: update outdated pages (#11821) 2023-12-28 16:48:20 +01:00
pages.ca youtube-dl: update Catalan and Indonesian translation (#11967) 2024-01-01 20:36:32 +01:00
pages.cs Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.da sed: add {Free,Net,Open}BSD pages (#11897) 2023-12-31 13:58:18 +01:00
pages.de pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.es pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.fa pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.fi/linux Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.fr mktemp: add French translation (#12322) 2024-02-23 00:28:01 +05:30
pages.hi pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.id pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.it pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.ja sed: add {Free,Net,Open}BSD pages (#11897) 2023-12-31 13:58:18 +01:00
pages.ko pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.lo pages.*: fix page title (#11811) 2023-12-22 06:44:48 +01:00
pages.ml cat: remove examples with the option "-u" (#11983) 2024-01-03 09:44:34 +08:00
pages.ne pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.nl pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.no pages*: fix brand and technical names (#12145) 2024-01-30 12:46:32 +08:00
pages.pl pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.pt_BR pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.pt_PT pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.ro/common Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.ru pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.sh/common sh: update Serbian-Croatian translation (#11922) 2023-12-30 15:28:05 +01:00
pages.sr/common mkdir: update Serbian translation (#11921) 2023-12-30 18:35:19 +01:00
pages.sv df, exec, exit, export: fix more info link (#12037) 2024-01-09 14:31:59 +05:30
pages.ta pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.th pages.*: use keith.github.io for builtin man pages (#12168) 2024-01-31 11:20:27 +01:00
pages.tr pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.uk pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.uz/android pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.zh pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.zh_TW pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
scripts scripts: use pathlib and avoid page iteration (#12183) 2024-02-13 19:14:50 +05:30
.editorconfig .editorconfig: set trim_trailing_whitespace to false (#7958) 2022-04-15 23:48:17 -03:00
.flake8 tooling: add black and flake8 for python formatting/linting (#6454) 2021-09-03 12:17:51 -03:00
.gitattributes .gitattributes: specify eol as LF (#9892) 2023-02-26 18:31:31 -03:00
.gitignore chore: ignore venv recursively (#10768) 2023-10-01 14:27:04 +05:30
.markdownlintrc markdownlint: increase maximum line length to 250 2019-05-07 10:08:35 +02:00
CLIENT-SPECIFICATION.md CLIENT-SPECIFICATION: remove redirect indicators, use autolinks (#12133) 2024-02-19 20:58:10 +05:30
COMMUNITY-ROLES.md cleanup: update community roles file (#12115) 2024-01-24 09:15:04 +05:30
CONTRIBUTING.md CONTRIBUTING: use and instead of / when mentioning commit messages and PR titles 2024-02-15 09:56:32 +05:30
GOVERNANCE.md cleanup: fix typos in governance page (#11865) 2023-12-28 16:43:30 +01:00
LICENSE.md docs: update references to 'main' branch 2021-05-01 20:10:05 +01:00
MAINTAINERS.md MAINTAINERS: add @noraj as collaborator (#12331) 2024-02-22 21:01:09 +01:00
README.md feat: add reference to other PDFs (#12311) 2024-02-21 09:07:54 +05:30
package-lock.json build(deps-dev): bump husky from 8.0.3 to 9.0.7 (#12175) 2024-02-01 16:39:13 +01:00
package.json build(deps-dev): bump husky from 8.0.3 to 9.0.7 (#12175) 2024-02-01 16:39:13 +01:00
pages.en Symlink `pages.en` to `pages` (#11139) 2023-10-21 22:02:19 +02:00
requirements.txt build(deps): bump black from 23.12.1 to 24.1.1 (#12178) 2024-02-01 19:51:27 +05:30

README.md

tldr-pages

Build status Matrix 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're new to the command-line world? Perhaps you're just a little rusty or can't always recall the arguments for commands like lsof, or tar?

It certainly doesn't help that, in the past, the first option explained in man tar was:

$ man tar
...
-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 client displaying the tar command in light mode. Screenshot of the tldr client displaying the tar command in dark mode.

This repository is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS, Android and Windows command-line tools.

How do I use it?

[!TIP] For browsing without installing a client on your computer, see the web client at https://tldr.inbrowser.app (with offline support using PWA).

A popular and convenient way to access these pages on your computer is to install the official Node.js client:

npm install -g tldr

Alternatively, you can also use the official Python client, which can be installed via pip3 (or other package managers):

pip3 install tldr

Linux and Mac users can also install the official Rust Client using Homebrew (or other package managers on other operating systems):

brew install tlrc

Then you have direct access to simplified, easy-to-read help for commands, such as tar, accessible through typing tldr tar instead of the standard man tar.

If you don't want to install any software, check out the PDF version instead.

[!NOTE] PDFs for translations are available for most languages. You can find them in the releases assets of the latest release.

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 to tldr-pages?

All contributions are welcome!

Some ways to contribute include:

  • Adding your favorite command which isn't covered.
  • Adding examples or improving the content of an existing page.
  • Adding requested pages from our issues with the help wanted label.
  • Translating pages into different languages.

All tldr pages are written in markdown, so they can be edited quite easily and changes can be submitted in pull requests here using Git on the command-line or using the GitHub web interface.

We strive to maintain a welcoming and collaborative community. If it's your first time contributing, 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 overall progress of all translations, and which translations are missing or outdated.

You are also welcome to join us on the matrix chatroom!

Similar projects

  • Command Line Interface Pages allows you to write standardized help pages for CLI, directories and configs.

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

  • bropages (deprecated) are a highly readable supplement to man pages. It shows 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.

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.