Go to file
Vítor Henrique 5e6dc70b2c
style-guide: organize content and update sections; *: fix Markdownlint errors (#12148)
* style-guide: organize content and add contents section

* style-guide: fix general writing section title

* style-guide: fix heading level of help and version commands

* style-guide: fix heading level of see also section

* cleanup: update files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* contributing: fix page for markdown lint

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* fix: markdownlint errors across files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: improve documentation about keycaps

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: add info about optional and string placeholders

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: sync changes with recent versions of style guide

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs/style-guide: reword more info links section

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-04-22 09:20:17 +05:30
.github build(deps): bump tj-actions/changed-files from 42.0.5 to 44.0.0 (#12589) 2024-04-01 12:42:18 +05:30
.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: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
images README: replace animation with PNG for accessibility (#8720) 2023-10-23 00:05:43 +05:30
pages medusa: move to common, update link (#12658) 2024-04-21 20:23:48 +02:00
pages.ar pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.bn pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +05:30
pages.bs pages*: update outdated pages (#11821) 2023-12-28 16:48:20 +01:00
pages.ca pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +05:30
pages.cs Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.da pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.de pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.es ppmtouil: add Spanish translation (#12656) 2024-04-20 09:31:09 +05:30
pages.fa caja, bob, atuin: add Farsi translation (#12560) 2024-04-11 13:24:27 +09:00
pages.fi/linux Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.fr pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.hi pages*: sync https://developer.android.com more info links (#12288) 2024-02-22 17:53:50 +05:30
pages.id pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.it pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +05:30
pages.ja pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.ko pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +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 pamfixtrunc: fix styling (#12617) 2024-04-08 13:07:38 +05:30
pages.no pages*: fix brand and technical names (#12145) 2024-01-30 12:46:32 +08:00
pages.pl bash: add Polish translation (#12165) 2024-04-18 18:23:02 +02:00
pages.pt_BR pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.pt_PT pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.ro/common Revert "pages/*: add standard translation and links (#11331)" (#11374) 2023-11-06 14:02:32 +05:30
pages.ru time, date, mkdir, print: add Russian translation (#12584) 2024-04-19 05:17:53 +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*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +05:30
pages.th pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +05:30
pages.tr pages*: use " " instead of "=" to separate the options from their arguments (#11952) 2024-04-18 15:38:25 -03:00
pages.uk pages*: add Ukrainian translation (#12566) 2024-04-20 08:59:23 +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 chore: bump tldr-lint to v0.0.15, update package files (#12605) 2024-04-04 13:35:55 +05:30
pages.zh_TW pages*: fix various proper names, acronyms and initialisms (#12494) 2024-03-14 10:31:06 +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
.markdownlint.json style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
CLIENT-SPECIFICATION.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
COMMUNITY-ROLES.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
CONTRIBUTING.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
GOVERNANCE.md cleanup: fix typos in governance page (#11865) 2023-12-28 16:43:30 +01:00
LICENSE.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
MAINTAINERS.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
README.md style-guide: organize content and update sections; *: fix Markdownlint errors (#12148) 2024-04-22 09:20:17 +05:30
package-lock.json chore: bump tldr-lint to v0.0.15, update package files (#12605) 2024-04-04 13:35:55 +05:30
package.json chore: bump tldr-lint to v0.0.15, update package files (#12605) 2024-04-04 13:35:55 +05:30
pages.en Symlink `pages.en` to `pages` (#11139) 2023-10-21 22:02:19 +02:00
requirements.txt build(deps): bump black from 24.2.0 to 24.3.0 (#12535) 2024-03-21 01:24:57 +00:00

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.