Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tldr-pages/tldr/llms.txt

Use this file to discover all available pages before exploring further.

tldr-pages is an open-source collection of over 4,500 community-maintained cheatsheet pages for command-line tools. Where traditional man pages can be dense and exhaustive, tldr pages focus on the most practical, real-world usage examples—so you can find what you need in seconds.

Introduction

Learn what tldr-pages is, how it works, and why developers love it

Quick Start

Install a tldr client and look up your first command in minutes

All Clients

Browse official and community clients for every platform

Contributing

Add new pages, improve existing ones, or translate into your language

What makes tldr-pages different?

Instead of exhaustive reference documentation, every tldr page is a focused set of concrete examples. Here’s what a page looks like:
# tar

> Archiving utility.
> Often combined with a compression method, such as `gzip` or `bzip2`.
> More information: <https://www.gnu.org/software/tar/manual/tar.html>.

- [c]reate an archive and write it to a [f]ile:

`tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}`

- [c]reate a g[z]ipped archive and write it to a [f]ile:

`tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}`

- E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:

`tar xvf {{path/to/source.tar[.gz|.bz2|.xz]}}`

- Lis[t] the contents of a tar [f]ile [v]erbosely:

`tar tvf {{path/to/source.tar}}`

Page Anatomy

Understand the structure and format of every tldr page

Placeholder Syntax

Learn how editable values and option variants are represented

Platform Support

Explore how pages are organized across Linux, macOS, Windows, and more

Client Specification

Build a compliant tldr client using the official v2.3 spec

Explore by topic

Style Guide

Formatting rules for writing great tldr pages

Translations

Contribute pages in 40+ supported languages

Subcommands

Document tools with multi-level command hierarchies

Governance

How decisions are made in the tldr-pages community

Community Roles

Contributor, maintainer, and organization member roles

Page Resolution

How clients select the right page for a platform and language

Build docs developers (and LLMs) love