tldr on GitHub (tldr-pages/tldr) — FAQ & Similar Projects · GitHub.Locker

tldr README

The project's README from github.com/tldr-pages/tldr. As one markdown file: README.md.

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 is room for simpler help pages focused on practical examples. How about:

Screenshot 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, FreeBSD, NetBSD, OpenBSD, SunOS, Android, Windows, Cisco IOS, and DOS 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).

There are several official clients available.

Python client

The official Python client can be installed from PyPI via pipx (or other package managers):

pipx install tldr

Rust client

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

brew install tlrc

cargo install tlrc --locked

Windows users can also install the official Rust Client using Winget (or other package managers on other operating systems):

winget install tldr-pages.tlrc

Node.js client

Alternatively, you can also use the official Node.js client, although it has fallen behind in updates:

npm install -g 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 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 release 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 that 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 that 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 and the matrix space that contains all tldr related chatrooms!

Similar projects

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.
Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind Unix system administrators of options for commands that they use frequently, but not frequently enough to remember.
Command Line Interface Pages allows you to write standardized help pages for CLI, directories, and configs.
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.

manual

Searching Database…

64K ·GitHub

What is this?

tldr-pages is a community-maintained collection of simplified help pages for command-line tools, meant as a more approachable complement to traditional man pages.

Is this a single tool or an index of community pages?

It's a repository of plain Markdown example pages for commands; you browse or query them through a separate client (web, CLI, or third-party apps), not through this repo directly.

How do I actually look up a command?

Use the web client to browse without installing anything, or install one of the many community clients (CLI or GUI) listed on the project's Wiki.

Do I need to install anything special to read the pages?

No, the pages themselves are just Markdown files; you only need whichever client you pick (there are many, and they vary in requirements).

Is coverage complete for every command?

No, it's an ever-growing community collection, so some commands or options may be missing until someone contributes them.

Which operating systems' commands are covered?

UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android, Windows, Cisco IOS, and DOS.

Are translated pages available?

Yes, pages are translated into many languages by the community, and PDFs for translations are provided in the release assets of the latest release.

How is tldr different from alternatives like cheat.sh or navi?

tldr-pages is the underlying content source; tools like cheat.sh aggregate it with other sources, while navi, eg, and others are interactive clients built around similar concepts, some of which pull directly from the tldr repository.

What does the name tldr mean?

TL;DR stands for 'Too Long; Didn't Read', internet slang for skipping lengthy text — reflecting the project's goal of short, practical command examples instead of exhaustive man pages.

What are similar projects?

cheat, cheat.sh, navi, python-cheatsheet, bash-guide, learn-python, vim-galore, ipython

Which topics is it in?

manual, cheatsheets, osx, console, examples, cheatsheet, community, bsd, shell, reference, command-line, documentation

Creator: tldr-pages
Size: 63.8 MB
Stars: 64K
Updated: CommitOct 16 Releasev2.3Mar 07
Age: 12y
Commits · 90 Days