mirror of https://github.com/tldr-pages/tldr.git synced 2024-12-26 18:32:41 +03:00

📚 Collaborative cheatsheets for console commands

cheatsheet cheatsheets command-line console documentation examples hacktoberfest help man-page manpages manual shell starred-repo starred-tldr-pages-repo terminal tldr

Go to file

Hayden Schiff d281999eda c99: clearer plurality		2016-02-22 19:35:42 -05:00
pages	c99: clearer plurality	2016-02-22 19:35:42 -05:00
scripts	Fix #717 . Update index.json format	2016-01-24 10:54:27 +02:00
.editorconfig	Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements	2015-12-04 16:54:05 +02:00
.gitignore	Use NodeJS NPM package markdownlint instead of Ruby gem mdl	2016-01-19 22:28:54 +02:00
.markdownlintrc	Use NodeJS NPM package markdownlint instead of Ruby gem mdl	2016-01-19 22:28:54 +02:00
.travis.yml	Use NodeJS NPM package markdownlint instead of Ruby gem mdl	2016-01-19 22:28:54 +02:00
CONTRIBUTING.md	Fix Contributing Guidelines: remove make mentions, add npm mentions	2016-01-29 15:50:48 +02:00
LICENSE.md	New README & CONTRIBUTING that apply to pages only	2014-03-04 23:39:34 +11:00
package.json	Use NodeJS NPM package markdownlint instead of Ruby gem mdl	2016-01-19 22:28:54 +02:00
README.md	Use original Travis badge to avoid downtimes of shields.io	2016-02-13 01:35:09 +02:00
screenshot.png	New README & CONTRIBUTING that apply to pages only	2014-03-04 23:39:34 +11:00

README.md

tldr

A collection of simplified and community-driven man pages.

Install it with npm install -g tldr or try the web client.

What is tldr?

New to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to lsof, or tar?

Maybe it doesn't help that the first option explained in man tar is:

-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.

Surely people could benefit from simplified "show me the common usages" man pages. What about:

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

Clients

You can access these pages on your computer using one of the following clients:

Android clients:
- tldr-viewer, available on Google Play
- tldroid, available on Google Play
Bash client
C++ client: brew install tldr-pages/tldr/tldr
Crystal client: brew install porras/tap/tlcr
Dart client: pub global activate tldr
Elixir client (binaries not yet available)
Emacs client
Go client: go get github.com/pranavraja/tldr (or platform binaries)
iOS clients:
- tldr-man-page, available on App Store
- tldr-pages, available on App Store
Node.js client : npm install -g tldr
Perl5 client: cpanm App::tldr
Python clients:
- tldr-python-client : pip install tldr
- tldr.py: pip install tldr.py
R client: devtools::install_github('kirillseva/tldrrr')
Ruby client: gem install tldrb
Rust clients:
- rust-tldr (online lookup): cargo install tldr
- tldr-rs (offline caching, not yet published)
Web client: https://ostera.github.io/tldr.jsx

There is also a comprehensive list of clients in our Wiki.

Contributing

Your favourite command isn't covered?
You can think of more examples for an existing command?

Contributions are most welcome! Have a look at the contributing guidelines and go ahead!

Similar projects

Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.
Bro pages are a highly readable supplement to man pages. Bro pages show concise, common-case examples for Unix commands.

What does tldr mean?

TL;DR stands for "Too Long; Didn't Read". It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy. Read more in the TLDR article on Wikipedia.