Skip to content

Home

Jump to bottom
K.B.Dharun Krishna edited this page Nov 3, 2023 · 21 revisions

tldr pages

Simplified and community-driven manpages

Usage

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

tldr tar

tldr tar command output

Installation

A popular and convenient way to access these pages on your computer is to install the Node.js client, which is supported by the tldr-pages project maintainers:

npm install -g tldr

Alternatively, you can also use the official Python client, which can be installed via pip3.

pip3 install tldr

Or Linux and Mac users can also install the official Rust Client using Homebrew:

brew install tlrc

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