README

[![Build status][github-actions-image]][github-actions-url]
[![Matrix chat][matrix-image]][matrix-url]
[![Merged PRs][prs-merged-image]][prs-merged-url]
[![GitHub contributors][contributors-image]][contributors-url]
[![license][license-image]][license-url]
[![Mastodon][mastodon-image]][mastodon-url]

[github-actions-url]: https://github.com/tldr-pages/tldr/actions
[github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr/ci.yml?branch=main&label=Build
[matrix-url]: https://matrix.to//tldr-pages:matrix.org
[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=Chat+on+Matrix
[prs-merged-url]: https://github.com/tldr-pages/tldr/pulls?q=is:pr+is:merged
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=Merged+PRs&color=green
[contributors-url]: https://github.com/tldr-pages/tldr/graphs/contributors
[contributors-image]: https://img.shields.io/github/contributors-anon/tldr-pages/tldr.svg?label=Contributors
[license-url]: https://github.com/tldr-pages/tldr/blob/main/LICENSE.md
[license-image]: https://img.shields.io/badge/license-CC_BY_4.0-blue.svg?label=License
[mastodon-url]: https://fosstodon.org/@tldr_pages
[mastodon-image]: https://img.shields.io/badge/Mastodon-6364FF?logo=mastodon&logoColor=fff


 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:

console
$ 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:


    
    
    


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  (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):

shell
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):

shell
brew install tlrc


shell
cargo install tlrc --locked


Windows users can also install the official Rust Client using Winget (or other package managers on oth

Top issues

Discussions

Latest release

Attention maintainers!

We have released a new client specification. In this release we are adding a new client-side syntax to allow the clients to show either shortform or longform options. This should remove a lot of clutter. It would also allow power users to view shortform options by default while showing longform options to new users. The syntax is backwards compatible so there is no need to rush support.

 [!IMPORTANT]
 The old https://tldr.sh domain will stop providing assets at the end of this year.

 Changelog
- Added longform/shortform specifications (15253) (by @Managor)
-