Repolode
Submit
tldr-pages

tldr-pages/tldr

Community-maintained cheatsheets showing practical examples for common command-line tools, as a simpler complement to man pages.

Open-source alternative to:man pages

View on GitHubWebsite
Stars
64,007
Forks
5,500
Open issues
286
Last commit
3 hours ago

What is it?

tldr-pages is a community-maintained collection of help pages for command-line tools. Each page focuses on a handful of common, practical examples rather than listing every option, so developers can quickly recall how to use a command such as tar or lsof.

The pages cover UNIX, Linux, macOS, the BSD family, SunOS, Android, Windows, Cisco IOS and DOS tools. They are written in Markdown and contributed through pull requests, and translations into many languages are maintained alongside the English pages.

Several official clients read these pages, including Python, Rust and Node.js versions, and a web client with offline PWA support lets you browse without installing anything. A PDF edition is also published in releases.

Key features

  • 01Concise examples for common commands instead of exhaustive option lists
  • 02Covers Linux, macOS, BSD, Windows, Android and other platforms
  • 03Pages are plain Markdown and easy to edit via pull requests
  • 04Official Python, Rust and Node.js clients, plus a web client
  • 05Translations available in many languages

Use cases

  • Quickly recalling the right flags for a command you use occasionally
  • Learning unfamiliar command-line tools with practical examples
  • Browsing command help offline via the PDF or PWA web client
  • Contributing examples for tools that lack good quick-reference docs

Quick start

  1. 1

    Install the official Python client with pipx

    pipx install tldr
  2. 2

    Look up a command's cheatsheet, for example tar

    tldr tar

Things to know

  • The metadata license is NOASSERTION, so check the LICENSE file before reuse.
  • The official Node.js client has fallen behind in updates.

Topics

#cheatsheet#command-line#cli#documentation#linux#macos#shell#man-pages#android#bsd

FAQ

What is tldr?
Community-maintained cheatsheets showing practical examples for common command-line tools, as a simpler complement to man pages. tldr-pages is a community-maintained collection of help pages for command-line tools. Each page focuses on a handful of common, practical examples rather than listing every option, so developers can quickly recall how to use a command such as tar or lsof.
Is tldr free to use? What license does it have?
tldr is open source under the Other license. Check the license terms before using it in commercial products.
Is tldr still maintained?
Actively maintained. The last commit to tldr was on Oct 21, 2026.
What can I use tldr for?
Quickly recalling the right flags for a command you use occasionally Learning unfamiliar command-line tools with practical examples Browsing command help offline via the PDF or PWA web client Contributing examples for tools that lack good quick-reference docs
How do I install tldr?
Install the official Python client with pipx: pipx install tldr Look up a command's cheatsheet, for example tar: tldr tar
Where can I get tldr?
The source code and installation instructions are on GitHub: https://github.com/tldr-pages/tldr

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects