Hysen Labs
Open-source project
chubin/cheat.sh avatar
chubin

cheat.sh

the only cheat sheet you need

41,643 stars1,916 forksPythonMIT
01
DEEP OPEN-SOURCE ANALYSIS

cheat.sh: answers for the terminal

The pitch is a cheat sheet that is always there: query with curl and get an answer, no install, no browser, in roughly a hundred milliseconds.

02
DEEP OPEN-SOURCE ANALYSIS

Why build a cheat sheet service at all

The README opens with a thought experiment: what would an ideal cheat sheet look like? Its answer lists seven traits. Concise, only what you need. Fast, usable instantly. Comprehensive, answers for every possible question. Universal, available anywhere with no preparation. Unobtrusive, it should not pull you off your main task. Tutoring, it should teach the subject. And inconspicuous, usable completely unnoticed. cheat.sh is the attempt to build that thing. It covers 56 programming languages, several database systems, and more than a thousand important UNIX and Linux commands, drawing on community-run cheat sheet repositories and StackOverflow.

03
DEEP OPEN-SOURCE ANALYSIS

How you actually use it

The interface is a URL. You query with curl, using either HTTPS or HTTP and either the long cheat.sh name or the short cht.sh one. Give it a command name like tar or rsync and it returns the sheet; if you do not know the name, a keyword search finds it. Programming language sheets live in their own namespaces, with a list query for what is available and learn pages for language basics. When no sheet exists, one is generated on the fly from existing sheets and StackOverflow answers, with no guarantee of a perfect hit. Appending /1 or /2 cycles alternatives, and option flags strip comments or turn off syntax highlighting. A dedicated cht.sh client adds shell mode, query history, clipboard copy, and tab completion for bash, fish, and zsh.

04
DEEP OPEN-SOURCE ANALYSIS

The edges: editors, stealth, self-hosting

Several integrations keep you from leaving your tools. Emacs, Sublime, Vim, and VS Code are supported to varying degrees, and the Vim plugin can feed static-analysis warnings straight into cheat.sh queries. Stealth mode is the odd one: select any text on screen and the matching answer appears, no keystrokes needed, which the README cheerfully frames as strictly for fun and not for coding interviews. For self-hosting, a docker-compose file builds an image with cheatsheets baked in and a Redis instance behind it, served on localhost:8002, an implementation the README itself calls early and unsuitable for production use.

05
DEEP OPEN-SOURCE ANALYSIS

Editorial conclusion

The design bet is that the terminal should already know the answer, and the docs are careful about the cases where it does not, admitting generated sheets can miss and the Docker setup is not production ready.

06
DEEP OPEN-SOURCE ANALYSIS

Official sources

07
Community notes

Community notes