Is there a compelling reason to choose this over tldr?
I'd ask the same question in the other direction, it just happens I use tldr already.
I'd ask the same question in the other direction, it just happens I use tldr already.
First of all, `tldr` is a lovely project, and if it's working for you, you should continue to use it.
If there's distinction to draw between the two projects, it's that `tldr` (to my understanding) is primarily a client for serving cheatsheets that are maintained in the upstream Github repository.
By contrast, `cheat` is focused around allowing users to create their own cheatsheets (stored perhaps only on their local filesystem), and is useful for storing cheatsheets in which others may have no interest.
`cheat` also allows you to sort and search these cheatsheets (which are just markdown files) by "cheatpaths", which are named directories in which cheatsheets may be stored. Cheatpaths have specificity rules that are configurable, such that cheatsheets on local cheatpaths may be preferred above those on global cheatpaths.
As a personal example, I run 3 cheatpaths:
- the community cheatsheets (contained on Github)
- personal edits I've made to the above
- cheatsheets for my dayjob
So, as an example, the community `ssh` cheatsheet is on the global cheatpath, and should contain the cheats that everyone should care about.
My personal `ssh` cheatsheet will contain edits I've made to that cheatsheet. Here, I'll store little tricks/tips/whatever relevant to my personal workflow that are useful to me, but will not be useful to others.
The dayjob cheatpath contains cheatsheets regarding how to do various tasks pertaining to my dayjob. How to start an app, or restart the CI server, or whatever.
Another example: I recently moved. I have an `address` cheatsheet that displays my new address, which I have yet to memorize.
So, `cheat` is perhaps better if you're interested in taking personal notes like this, whether of a technical or non-technical nature.
If you're primarily interested in community cheatsheets, you should keep using `tldr`! It's a wonderful project.
I probably wouldn't use the extra features just because I use a password vault for that kind of thing, since a subset of those are, say, a new debit PIN and I need all that kind of thing to be in one place.
If I did more sysadmin stuff I could see that being handy, annotating various incantations would pay off over time, aliases have a way of slipping through the cracks. Thanks!