explaingit

tldr-pages/tldr

Analysis updated 2026-06-20

62,380MarkdownAudience · developerComplexity · 1/5Setup · easy

TLDR

A community-maintained collection of practical, example-focused help pages for command-line tools, a friendlier alternative to man pages that shows you the most common usage patterns immediately, without reading dense documentation.

Mindmap

mindmap
  root((tldr))
    What it does
      Simplified man pages
      Common use cases only
      Practical examples
    Content
      Linux commands
      macOS commands
      Windows commands
      Translated languages
    How to use
      Install a client
      Web browser interface
      type tldr command-name
    Tech
      Markdown files
      Python client
      Rust client
      Node.js client
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Look up the most common usage examples for any command-line tool without reading the full manual.

USE CASE 2

Contribute practical example pages for tools you use regularly to help other developers worldwide.

USE CASE 3

Browse commands across Linux, macOS, and Windows from a single searchable web interface without installing anything.

What is it built with?

MarkdownPythonRustNode.js

How does it compare?

tldr-pages/tldrjaywcjlove/linux-commandoai/openapi-specification
Stars62,38036,00130,902
LanguageMarkdownMarkdownMarkdown
Setup difficultyeasyeasyeasy
Complexity1/52/51/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

In plain English

tldr-pages is a community-maintained collection of simplified, practical help pages for command-line tools, designed as a friendlier complement to traditional man pages. The problem it solves is that the standard manual pages for Unix and Linux commands are often long, dense, and focus on edge cases and obscure options rather than the common everyday usage patterns most users actually need. Someone who just wants to know how to extract a tar archive or list files by modification date has to wade through pages of documentation to find what they need. Each tldr page focuses on the most common use cases for a command, showing practical examples with brief explanations. Rather than documenting every possible flag, a tldr page might show five or six representative examples that cover 90 percent of what people actually do with the command. The pages are written in a simple Markdown format and the entire collection is maintained collaboratively on GitHub, covering commands for Linux, macOS, Windows, BSD, Android, and other systems. To use it you install a client, available in Python, Rust, Node.js, and other languages, and then type tldr followed by a command name instead of man. You can also browse the pages in a web interface without installing anything. The pages are available in many translated languages. You would reach for tldr when you half-remember a command and want the two or three most common usage patterns immediately, without reading a full manual. The repository itself is primarily Markdown files, with clients implemented in various languages available separately.

Copy-paste prompts

Prompt 1
Show me the tldr page for the `tar` command so I can see the most common ways to compress and extract files.
Prompt 2
I want to contribute a new tldr page for a CLI tool I use, what Markdown format do pages follow and how do I submit a pull request?
Prompt 3
How do I install the tldr Python or Node.js client and look up command examples offline on my machine?
Prompt 4
Find me tldr examples for `grep`, `find`, and `awk` so I can quickly filter and process files in the terminal.

Frequently asked questions

What is tldr?

A community-maintained collection of practical, example-focused help pages for command-line tools, a friendlier alternative to man pages that shows you the most common usage patterns immediately, without reading dense documentation.

What language is tldr written in?

Mainly Markdown. The stack also includes Markdown, Python, Rust.

How hard is tldr to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is tldr for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Scan in gitsafehub Deploy in gitdeployhub tldr-pages on gitmyhub

Verify against the repo before relying on details.