Simplified and community-driven man pages
Node.js based command-line client for tldr.
$ npm install -g tldr
Note: TLDR is still in early versions. We try to minimise breaking changes, but if you run into issues please try to download the latest package again.
To see tldr pages:
tldr <command>show examples for this command
tldr --listshow all available pages
tldr --randomshow a page at random
tldr --random-exampleshow a single random example
The client caches a copy of all pages locally, in
There are more commands to control the local cache:
tldr --updatedownload the latest pages
tldr --clear-cachedelete the entire local cache
As a contributor, you might also need the following commands:
tldr --render <path>render a local page for testing purposes
You can configure the
tldr client by adding a
.tldrrc file in your HOME directory.
This file has to be valid JSON:
As a contributor, you can also point to your own fork or branch:
"repository" : "myfork/tldr"// or"repository" : "myfork/tldr#mybranch"
Contribution are most welcome! Have a look over here for a few rough guidelines.