Skip to content
K.B.Dharun Krishna edited this page May 1, 2023 · 20 revisions

tldr pages

Simplified and community-driven man pages

Usage

View the live demo or run the command from your terminal.

tldr tar

tldr tar command output

Installation

Install the NodeJS client:

npm install -g tldr

Alternatively, you can also use the Python client:

pip3 install tldr

Or Mac users can also install our C Client using Homebrew:

brew install tldr

You can also try other tldr pages clients.

Contribute

Fork the project's Github repository.

This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / OSX / SunOS commands.

Just edit any pages from the pages/ directory and submit a pull request.

Best practices:

  • Focus on up to 8 of the most common usages.
  • When in doubt, keep new command-line users in mind.
  • Introduce examples gradually, from the simplest to more complex ones.
  • Don't explain general UNIX concepts.
  • Have a look at a few existing pages if you need any help.

Check out the more detailed Contributing Guidelines.

License

MIT License

Clone this wiki locally