What does HackerNews think of tldr?
📚 Collaborative cheatsheets for console commands
It lets you check the most commonly used options from your terminal, for example "tldr badblocks".
* https://github.com/jlevy/the-art-of-command-line notes and tips on using the command-line, suitable for both beginners and experienced users
* https://github.com/tldr-pages/tldr collection of community-maintained help pages for command-line tools
* http://www.compciv.org/unix-tools/ examples for most common usecases
* https://devmanual.gentoo.org/tools-reference/bash/index.html Bash reference cheatsheet
Has anyone used them before (or the variants that the repo mentions)? Are they good? Their live demo seems to be producing decent-ish results from playing around with it. Tried a random sampling of non-default programs on my computer and it's got some of them, but not most of them.
Is this a space I should be looking at more, and is there a dominant project that's getting more attention/coverage of obscure programs?
Personally I like tealdeer for a tldr client b/c it's written in Rust and I think the name is fun, but the other tldr clients I've tried all seem fine as well: https://github.com/dbrgn/tealdeer
tldr doesn't do autocomplete, but between fish shell's autocomplete and tldr I feel I'm able to figure out most simple commands in the terminal.
I personally wouldn't touch that, but that's related to my allergies to JS ecosystem and predisposition to panic attacks when I see stuff like that https://github.com/tldr-pages/tldr/blob/master/package-lock.....
- emacs: works for me to code in R, python, connect to remotes, etc
- keyboard shortcuts: got started with them early, and never looked back. Bonus: linux/macOS/emacs text navigation works across all of them (ctrl-f, ctrl-b, ctrl-a, ctrl-k, alt-delete, etc)
- git: managing file versions and file diffs (!)
- GitHub: terrific for project management, even when I'm the only one on the project ;)
- CLI utilities that I love:
- ag, a better "grep"
- fd, a better "find"
- tldr, a better "man"
CLI tools:
https://github.com/ggreer/the_silver_searcher
https://github.com/sharkdp/fd/
https://github.com/tldr-pages/tldr
EDIT: formatting
[0]: https://github.com/tldr-pages/tldr [1]: https://github.com/dbrgn/tealdeer
Usually when the internet says "Run these commands", they either don't tell you what they do, or tell you to just check `man`. The problem is that man pages can be super long, can have a somewhat intimidating syntax, and 1,000 flags that arent your flag. Running `tldr program_name` gives you a way simpler manual with common flags and actual examples.
There's also a web interface, for tar that'd be: https://tldr.ostera.io/tar
Then you only get the line with "bar" in it. (append -C 1 at the end to get 1 line before and 1 after the term you grepped for).
And of course you can pimp your terminal experience by using fish (https://fishshell.com/) as it ships with autosuggestions and other really nice features. (Beware that it will not provide 100% POSIX compliance but if that's an issue you can use ZSH or pimp your bash as well).
Then there is other kind of man pages like TLDR (https://github.com/tldr-pages/tldr) which is curated by community and quite awesome ;-)
I like how this is their #1. In my opinion the best way to do this is with tldr.
https://github.com/tldr-pages/tldr
I'd highly recommend folks create a tldr page for their CLI app. Add 4-8 examples to cover 80%+ of the most common use cases. -h flags, readmes & man pages can cover the other 20%.
I can see that there may be instances where you/your company would like to have internal docs that should not be public and this utility would would work for it
[1] https://github.com/tldr-pages/tldr [2] https://github.com/chubin/cheat.sh
The original cheat does exactly the same thing, has a big following and more stars, and has existed for years.
I've opened an issue re: the name conflict https://github.com/chubin/cheat.sh/issues/34
Afaik these are the big players in the space: - bro: https://github.com/hubsmoke/bro - tldr: https://github.com/tldr-pages/tldr - cheat: https://github.com/chrisallenlane/cheat
$ tldr dd
dd
Convert and copy a file.
- Make a bootable usb drive from an isohybrid file (such like archlinux-xxx .iso):
dd if=file.iso of=/dev/usb_drive
dd if=/dev/source_drive of=/dev/dest_drive bs=4m conv=noerror
dd if=/dev/urandom of=random_file bs=100 count=1
dd if=/dev/zero of=file_1GB bs=1024 count=1000000
It gives actual examples of commands, just like a cheatsheet does.
Speaking of... https://github.com/tldr-pages/tldr/blob/master/pages/common/...
I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular.
But, the page linked in the OP is actually brilliant. It's easy to read, has examples, compartmentalises into sections that are relevant to different people. It's a step in the right direction.
Note: I'm not saying there aren't other pages like OP. There probably are, but the vast majority are not.
Both examples of community driven man pages with examples