Skip to content
Igor Shubovych edited this page Dec 30, 2015 · 20 revisions

TLDR Pages

Simplified and community-driven man pages

Usage

Run in live demo or your terminal.

tldr tar

tldr tar command output

Installation

Install the NodeJS client

npm install -g tldr

You can also try other TLDR clients

Client Installation instruction
Web client try tldr on your browser here!
Node.js client npm install -g tldr
Ruby client gem install tldrb
Python client pip install tldr.py
C++ client brew tap tldr-pages/tldr
brew install tldr
Android client available on Google Play

There are more clients listed in [README.md]({{ site.github }}/blob/master/README.md#clients).

Contribute

Fork project's Github repo.

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

Just edit some page from pages/ folder and submit a pull request.

Best practices:

  • Focus on the 5-6 most common usages.
  • When in doubt, keep new command-line users in mind.
  • Introduce examples gradually, from the simplest to more complex.
  • Don't explain general UNIX concepts.
  • Have a look at a few existing pages.

Check more detailed Contributing Guidelines.

License

MIT License

Clone this wiki locally