The Linux cheat command

https://opensource.com/article/22/6/linux-cheat-command

by feross • 4 years ago

170 77 4 years ago

cypherus• 4 years ago

I personally have been using tldr for a while now and love it. It works similarly to cheat, but I see in researching about the project there are others as well. I also use zsh-autosuggestions and zsh-autocomplete so it really makes things easier.

barbazoo2• 4 years ago

Unrelated but I'm wondering. Should I switch from bash to zsh, if so, why? It's taken me quite a while to get up to speed with bash, especially scripting. How steep is the learning curve?

bloopernova• 4 years ago

Most bash scripts work fine in zsh. I recommend you switch because your learning curve will be very shallow.

Here's a gist (i.e. no ads) that I wrote to guide people new to zsh through some of the many options available: https://gist.github.com/aclarknexient/0ffcb98aa262c585c49d4b...

Here's a stack exchange post about the differences between zsh and bash: https://apple.stackexchange.com/questions/361870/what-are-th...

dlivingston• 4 years ago

Zsh is a superset of Bash. There's little-to-no learning curve from switching, if you just stick with Bash syntax, and many advantages.

Here is a good overview on Zsh vs. Bash [0].

My favorite Zsh feature is the plugin ecosystem [3]. Oh My Zsh [1] and Starship [2] are awesome.

[0] https://apple.stackexchange.com/questions/361870/what-are-th...

[1] https://ohmyz.sh/

[2] https://starship.rs/

[3] https://github.com/unixorn/awesome-zsh-plugins

ufo• 4 years ago

I'll take this chance to shill for Fish. For interactive use it is a joy to use, with better defaults w.r.t. auto completion and history. Not much learning curve if most of the time you're just entering commands and pressing tab or arrow keys. I still use Posix Shell for scripts though, because it's installed everywhere.

UI_at_80x24• 4 years ago

I'm going to go against the grain a little and disagree with a lot of the comments.

My suggestion is to use the same environment in development that you use in production. If you are running zsh on your servers then run zsh on your workstation.

I run a mix of Linux, FreeBSD, and OpenBSD servers in production; and have found that 99% of the time it didn't matter.

I had been using zsh on my workstation and about 25% of my server fleet. The others were either too old, didn't support it, or whatever.

Of those 75% of servers (over 500 boxes) a small handful encountered occasional problems when running my 'written on ZSH script'; that didn't happen when I re-wrote/tested the script on bash.

We are talking about ~4 errors over the course of a year-and-a-half or so.

It was more annoying then anything else; and nothing broke as a result of it. I just had to manually go do the work that my script was suppose to do.

I like zsh.

bombcar4• 4 years ago

macOS ships with zsh and it was easier to switch all the linux boxes to zsh than to fight homebrew into giving me a relatively recent version of bash.

So far I've no complaints and oh-my-zsh is nice.

But I can't really point to something and say "oh I'd die without this zsh feature".

Datenstrom• 4 years ago

Definitely switch to zsh for interactive use, the differences are minimal enough it will not take any effort to switch. Even forgetting everything else just the superior tab complete is enough to make it worthwhile. Still use bash for scripts they will be more portable.

seemaze• 4 years ago

check out tealdeer, it's a rust implementation of tldr but improves speed (on my machine at least) drastically!

https://github.com/dbrgn/tealdeer

layer8• 4 years ago

I feel that man pages should add a TLDR section after NAME and restrict the bottom EXAMPLES section to more elaborate / less common examples.

yjftsjthsd-h2• 4 years ago

That seems like an unnecessary complication; just put the more simple examples at the top of the section and make them more complex as you proceed down.

lambda_matt• 4 years ago

man -k somestring

barbazoo2• 4 years ago

The page didn't mention it but there is one that can be installed via brew as well.

pc86• 4 years ago

Playing around with it a bit, looks like you need to install some configs after but works as described in the article. Will definitely be helpful for those like me who are trying to expand their command line prowess.

galgot2• 4 years ago

Available via port too, with the option to download the community cheatsheets.

m_x• 4 years ago

As I don't need it that often, I prefer the zero-install `curl cht.sh/tar`.

reidjs• 4 years ago

I use this fairly regularly! If you don't know, you can type almost any command, e.g. `curl cht.sh/ls` and it shows you common usages of `ls` with a short description for each command

Man pages for the lazy.

galgot2• 4 years ago

But sh... sorry "cheat" is easier to remember, maybe.

adamhearn• 4 years ago

I put this in my ZSH profile.

  function cheat() {
      curl cht.sh/$1
  }

repox• 4 years ago

I have a similar setup:

    function cheat() {
        cheatcommand=$1
        shift;
        IFS='+'
        str="$*"
        if [ "$#" -eq 0 ]; then
            curl cht.sh/$cheatcommand
        else
            curl cht.sh/$cheatcommand/$str
        fi
    }

samatman2• 4 years ago

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.

chrisallenlane8• 4 years ago

I'm the author of `cheat`.

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.

samatman2• 4 years ago

Glad I asked! The article (I can see you didn't write it) feels like it comes from a parallel world where tldr is called 'cheat' and is a standard POSIX command, it has maybe a paragraph right at the end about custom sheets.

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!

gaetgu• 4 years ago

Awesome. I was going to ask the same thing, but this answers everything that I was going to ask. Thanks!

giantg2• 4 years ago

If I ever have an interview on a Linux system I'm going to ask the interviewer if I'm allowed to cheat.

At least that's how I plan to get myself to remember this command.

ggerules• 4 years ago

Thanks for making this. It is a very handy tool!

chrisallenlane8• 4 years ago

I didn't link the article, but it's my pleasure. `cheat` was first and foremost a "scratch your own itch" tool. I'm very happy to see that others are finding it useful as well :)

frankhhhhhhhhh• 4 years ago

It's too bad most man pages don't include anything in the EXAMPLES section.

BossingAround• 4 years ago

My biggest pet peeve! I have a feeling that in the past, man pages used to be much more detailed when it comes to actual examples.

JJMcJ3• 4 years ago

The feeling that a single actual example would make the whole thing a million times clearer.

Sometimes there's also an `info` file with more detail.

And one of my pet peeves. Do a search "How to briwyw the gomleqq" and the first one you look at has screen after screen of how to install Linux and everything and then finally at the very bottom it is finally revealed

    gomleqq --briwyw 40 --eiei-dddd 9

and that's the little bit of knowledge that I needed all along, along with that fact that 40 needs to be at least 4 times bigger than 9 or you'll get dropped packets.

marcosdumay• 4 years ago

My impression is that people stopped filling their man pages because the information got into info pages when there was an ongoing campaign to create those (because the format was much more expressible).

And then, the users simply didn't learn how to use info, so developers dropped those and kept only the very short man pages.

gumby• 4 years ago

As a Unix user since around 1980 I can reassure you that man pages these days are far more extensive than they used to be.

chrisallenlane8• 4 years ago

This was essentially my primary motivation for writing `cheat`. The `man` pages are thorough, but often lack examples demonstrating the common use-cases.

I eventually tired of Googling "how to extract a tarball" (because I'm too lazy to read the lengthy manpage), and decided to create some supplemental tooling.

cptnapalm• 4 years ago

In a recent discussion of fzf, I looked through the man page and still didn't know what it was supposed to do. An example might have helped.

t0astbread• 4 years ago

That kinda makes me think if it would be possible to write a tool that patches these cheat sheets into man pages that don't yet have an EXAMPLES section.

kmtrowbr• 4 years ago

A useful, related website: https://explainshell.com/

bombcar4• 4 years ago

Awww I was hoping for some old-tyme preacher explaining hell.

zach_garwood• 4 years ago

It's hot!

dvn8ter• 4 years ago

tldr is already available and cheat looks like a fork of it.

check it out: sudo apt install tldr

imagine that!

chrisallenlane8• 4 years ago

`cheat` is not a fork of `tldr` (I'm the author of `cheat`), though the latter is a lovely tool.

raesene9• 4 years ago

One of the better parts of kubectl's documentation is that there's generally examples like this, so you can get the more common examples in the help and copy/paste/lightly modify, as needed.

0des4• 4 years ago

cheat: command not found

Out of the box, I dont have an OS (or shell) that ships this. I wouldnt call it so much a command, which implies it is inherent to the system, I'd say its a tool, like a step below coreutils in that its not so pervasive.

Arch didnt have it, Debian rolling or stable didnt either, neither does RHEL

(I also tried on MacOS, but that is not Linux)

anyfoo• 4 years ago

Sorry, but that’s kind of a made up definition of “command”. By that definition, gzip is a command on “most” systems, bzip2 on “a lot”, and xz on “some”. And yet they are all entered on the command line.

And what tools a particular system comes with is pretty much arbitrary. The otherwise ubiquitous curl for example is not part of, e.g., coreutils (which is a rather Linux-specific thing, the BSDs have most of the stuff in there as part of their “base”).

0des4• 4 years ago

Sorry, but that’s kind of a made up definition of “command”. By that definition, gzip is a command on “most” systems, bzip2 on “a lot”, and xz on “some”. And yet they are all entered on the command line.
And what tools a particular system comes with is pretty much arbitrary. The otherwise ubiquitous curl for example is not part of, e.g., coreutils (which is a rather Linux-specific thing, the BSDs have most of the stuff in there as part of their “base”).

"I wouldn't call it"...

I might be encouraged to give context for my subjective opinion. If youd rather make fun of my perceived ignorance, thats also your prerogative.

Also, BSD is not Linux.

jandrese2• 4 years ago

If it is not in the repos it isn't going to be used.

Step 1 in getting adoption on the Linux side is making "apt install cheat" and "dnf install cheat" work. Plus whatever the current preferred Mac package manager is.

chrisallenlane8• 4 years ago

I'm the author of `cheat`. Regrettably, I agree with you regarding the lack of `apt` packaging as a major barrier to adoption.

I've looked into creating it previously, but found it to be non-trivial. Like a lot of FOSS maintainers, I'm pretty strapped for time these days, and I simply haven't gotten around to it yet.

The next round of work I want to do on this project is to improve the CI pipeline. My dayjob these days largely involves configuring CI pipelines, and yet the `cheat` workflow for the time being involves me running `make` on my local machine and dragging-and-dropping binaries into the Github UI. It's embarassing.

Once I get the CI squared away, I'll take a look at `apt` packaging.

Seeing this project on Hacker News has given me renewed motivation, however. Perhaps I can free up some time this weekend :)

ElijahLynn2• 4 years ago

Arch has it in the AUR with `yay cheat-bin`. Pow, done!

chrisallenlane8• 4 years ago

Oh, weird.

I'm actually the author of the `cheat` tool. Feel free to ask me if you have any questions about it.

senectus1• 4 years ago

oh man, could you do this for powershell as well? :-P

chrisallenlane8• 4 years ago

`cheat` allows you to create cheatsheets on your local machine, so you can trivially create whichever Powershell cheatsheets you need.

I don't believe we have any Powershell cheatsheets in the upstream community repo yet, but if you create some, please share them! They would surely be appreciated.

de6u99er• 4 years ago

Is it available via brew?

chrisallenlane8• 4 years ago

It is! There's a wonderful community-maintained `brew` package for it:

`brew install cheat`

lenkite• 4 years ago

Thanks for coding! How does your https://github.com/cheat compare to https://github.com/chubin/cheat.sh ?

ElijahLynn2• 4 years ago

Nice!

p.s. Arch Linux is `yay cheat-bin` NOT `yay cheat` (source compile).

LordDragonfang• 4 years ago

Another similar command is the "bro" gem, which provides user sourced and voted examples

http://bropages.org/

Georgelemental• 4 years ago

Unfortunately this is unmaintained

Maursault4• 4 years ago

     cheat

is not a Linux command. It is a shell command. Accuracy is not pedantic. That is all.

[1] https://github.com/cheat/cheat

lupire2• 4 years ago

What are you talking about? It's a Golang program for Linux/Unix

https://github.com/cheat/cheat/blob/master/cmd/cheat/main.go

Maursault4• 4 years ago

Oh, my mistake. I see the program code is written in Linux Go, a programming language for Linux. Right?

No. That's idiotic reasoning. Go is not a Linux programming language no more than C++ or Javascript is. Even if Go was developed on Linux, it still just a programming language; it is not owned by Linux nor is it in kernel space, and it runs on DragonFly BSD, FreeBSD, macOS, NetBSD, OpenBSD, Plan 9, Solaris, and Windows. Why isn't it instead a Windows command? Because no one else does this. No one says, "a BSD command" or what have you. Shell commands run in the shell. Shells run on everything.

Why does everything Linux touches become described as Linux something?

That is what I am talking about, Linux entitlement: if Linux runs it, it is a Linux thing, regardless of whether it was developed 30 years before Linux existed or whether it was ported to every other OS previously or subsequently.

It's a Golang program for Linux/Unix

Anyway, thanks for making my point. Unless you mean that Linux is UNIX, in which case there are some deeper issues here.[1]

[1] https://en.wikipedia.org/wiki/Single_UNIX_Specification

lupire2• 4 years ago

Why do you need this instead of publishing man supplements that append to man files?

The Linux cheat command

Related Stories