Simplified and community-driven man pages
npm install tldr
|26||downloads in the last day|
|379||downloads in the last week|
|1 426||downloads in the last month|
|Version||0.0.6 last updated a month ago|
|Keywords||tldr, man, unix, commands|
|Dependencies (10)||ansicolors, ansistyles, async, commander, markit, mkdirp, ms, request, rimraf, unhtml|
What is this?
New to the command-line world? Or just a little rusty?
Or, like me, you can't always remember the arguments to
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.
I'm sure people could benefit from simplified "show me the common usages" man pages. What about:
$ npm install -g tldr
Your favourite command isn't covered? You can think of more examples? New features?
tldr is under MIT license. You're free to modify or redistribute the source and content, but why not contribute over here? :)
The rough guidelines are:
- each command's description should be short and sweet
- give around 5 examples of the most common usages
- when in doubt, keep new command-line users in mind
- To run the tests:
- To try out new fetching/rendering logic locally
npm start npm run example