← All open source projects

tldr-pages

tldr-pages/tldr

tldr-pages is a community-maintained collection of short command-line cheatsheets.

Forks 5,323
Author tldr-pages
Language Markdown
License NOASSERTION
Synced 2026-06-27

What it is

tldr-pages is a collection of short cheatsheets for command-line tools. Unlike long man pages, each page focuses on common scenarios and concrete examples.

The name captures the approach: do not read the whole manual when you only need to remember the syntax quickly.

How the format works

Each page is written in simple Markdown: a short description, a documentation link, and examples with explanations. That makes pages easy to read, translate, and review.

The pages are not tied to one client. Python, Rust, Node.js, and other clients can all use the shared page collection.

Page example

This fragment shows the tldr style: a short action description and a command that can be adapted.

Language: Markdown
# tar

> Archiving utility.

- Create an archive from files:

`tar cf {{target.tar}} {{file1}} {{file2}}`

- Extract an archive:

`tar xf {{source.tar}}`

Why it is convenient

Command-line tools often have dozens of flags, while daily work needs a few common combinations. tldr-pages puts those combinations first.

It is especially useful for terminal work, administration, learning, and rare operations around archives, networking, Git, permissions, containers, and system tools.

Strengths

The main strength is speed. Open a command, see an example, run or adapt it.

The community is another strength: examples are improved by people using the commands across systems.

Limits

tldr-pages does not replace official documentation. Full flag semantics and edge cases still require primary docs or man pages.

Short examples can hide dangerous consequences. File deletion, disks, and network changes still require full understanding.