Go to file
Robson Cruz d5b638cf04
pbmtoascii: add page (#11289)
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-26 21:16:24 +02:00
.github CODEOWNERS: sort alphabetically and add @IMHOJEONG for Korean (#11285) 2023-10-26 16:57:26 +02:00
.husky deps: upgrade husky to v7.0.1 (#6207) 2021-07-10 11:16:50 -03:00
contributing-guides adduser, translation-templates/*: add Finnish translation (#11292) 2023-10-27 00:29:53 +05:30
images README: replace animation with PNG for accessibility (#8720) 2023-10-23 00:05:43 +05:30
pages pbmtoascii: add page (#11289) 2023-10-26 21:16:24 +02:00
pages.ar pwd: add Arabic translation (#10512) 2023-08-09 10:58:30 +05:30
pages.bn chrome, date, find: add Bengali translation (#11255) 2023-10-26 20:00:37 +02:00
pages.bs pages.*: add standard translation (#9672) 2022-12-29 08:41:44 +05:30
pages.ca clamav: move to common, update Catalan and Spanish translations (#11283) 2023-10-26 19:33:38 +02:00
pages.cs cd, translation-templates/*: add Czech translation (#10791) 2023-10-08 17:01:17 +05:30
pages.da pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.de pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.es clamav: move to common, update Catalan and Spanish translations (#11283) 2023-10-26 19:33:38 +02:00
pages.fa pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.fi/linux adduser, translation-templates/*: add Finnish translation (#11292) 2023-10-27 00:29:53 +05:30
pages.fr pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.hi add-appxpackage: add Hindi translation; pages.*: remove locale from Microsoft links (#11286) 2023-10-26 23:59:28 +05:30
pages.id pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.it pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.ja ab: add Japanese translation (#10977) 2023-10-21 07:22:01 +02:00
pages.ko pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.lo pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.ml chmod: add Malayalam translation (#10836) 2023-10-08 16:18:18 +05:30
pages.ne bugreportz, cmd: add Nepali translation (#11182) 2023-10-25 22:13:02 +05:30
pages.nl windows/*: add, update PowerShell commands and aliases for Dutch translation (#11277) 2023-10-26 23:08:46 +05:30
pages.no title: add Norwegian translation (#9824) 2023-02-08 21:12:27 +05:30
pages.pl pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.pt_BR pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.pt_PT pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.ro/common todoist: add page (#6361) 2021-08-15 17:52:54 +02:00
pages.ru Move pages in the correct folder (#11163) 2023-10-23 22:27:11 +02:00
pages.sh/common pages*: add backticks to every io stream (#10442) 2023-07-02 18:42:01 +05:30
pages.sr/common cd, echo, git, link, mkdir: add Serbian translation (#6692) 2021-10-06 12:53:25 +02:00
pages.sv pages*: add backticks to every io stream (#10442) 2023-07-02 18:42:01 +05:30
pages.ta add-appxpackage: add Hindi translation; pages.*: remove locale from Microsoft links (#11286) 2023-10-26 23:59:28 +05:30
pages.th add-appxpackage: add Hindi translation; pages.*: remove locale from Microsoft links (#11286) 2023-10-26 23:59:28 +05:30
pages.tr pages*: fix tldr-lint issues (#11288) 2023-10-26 19:31:26 +02:00
pages.uk dmesg,systemctl,uname: add Ukrainian translation (#11115) 2023-10-21 22:42:35 +05:30
pages.uz/android fastboot, cmd, bugreport, bugreportz: update all "more information" links (#11134) 2023-10-21 15:24:32 +02:00
pages.zh lspci, lsblk, lscpi, lsb_release: add Chinese translation (#11144) 2023-10-26 20:44:28 +02:00
pages.zh_TW color: add traditional Chinese translation (#11028) 2023-10-24 09:29:59 +05:30
scripts scripts: use `[[` instead of `[`, fix literal shell globs (#11290) 2023-10-26 22:11:24 +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 docs: use the new `[!NOTE]` syntax (#10959) 2023-10-13 01:26:58 +02:00
COMMUNITY-ROLES.md COMMUNITY-ROLES: fix link to project governance principles (#11206) 2023-10-24 14:59:17 +05:30
CONTRIBUTING.md docs: use the new `[!NOTE]` syntax (#10959) 2023-10-13 01:26:58 +02:00
GOVERNANCE.md Community: Update Gitter links to Matrix, Update Badges, Remove editor extensions (#9898) 2023-03-27 10:44:21 +05:30
LICENSE.md docs: update references to 'main' branch 2021-05-01 20:10:05 +01:00
MAINTAINERS.md MAINTAINERS: add @IMHOJEONG as collaborator (#11250) 2023-10-25 20:07:54 +02:00
README.md README: replace animation with PNG for accessibility (#8720) 2023-10-23 00:05:43 +05:30
package-lock.json build(deps): bump glob from 10.3.4 to 10.3.10 (#10776) 2023-10-01 15:14:38 +05:30
package.json build(deps): bump glob from 10.3.4 to 10.3.10 (#10776) 2023-10-01 15:14:38 +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 23.7.0 to 23.9.1 (#10778) 2023-10-01 15:08:58 +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?

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

Alternatively, you can also use the Python client, which can be installed via pip3.

pip3 install tldr

Or Mac users can also install our C Client using Homebrew.

brew install tldr

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 want an offline version without installing any software, check out the PDF version.

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

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.

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.