CHEAT(1)

okay so bestie, this is CHEAT(1) from the General Commands Manual — your command-line cheatsheet era starts now 💅✨

🌸 NAME 🌸

cheat — create and view command-line cheatsheets

✨ SYNOPSIS ✨

cheat [options] [CHEATSHEET]

💖 DESCRIPTION 💖

okay so cheat lets you create and view interactive cheatsheets right on the command-line. It was literally designed to help remind *nix system administrators about options for commands they use frequently, but not frequently enough to actually remember — we’ve all been there 😭.

💅 OPTIONS 💅

• –init — prints a config file to stdout.
• -c, –colorize — colorizes the output. make it cute ✨
• -d, –directories — lists cheatsheet directories.
• -e, –edit=CHEATSHEET — opens CHEATSHEET for editing.
• -l, –list — lists available cheatsheets.
• -p, –path=PATH — filters so you only see sheets found on PATH.
• -r, –regex — treats search PHRASE as a regular expression.
• -s, –search=PHRASE — searches cheatsheets for PHRASE.
• -t, –tag=TAG — filters so you only see sheets tagged with TAG.
• -T, –tags — lists all tags in use.
• -v, –version — prints the version number.
• –rm=CHEATSHEET — removes (deletes) CHEATSHEET. gone, periodt 💀

🎀 EXAMPLES 🎀

• To view the foo cheatsheet:

cheat foo

• To edit (or create) the foo cheatsheet:

cheat -e foo

• To edit (or create) the foo/bar cheatsheet on the work cheatpath:

cheat -p work -e foo/bar

• To view all cheatsheet directories:

cheat -d

• To list all available cheatsheets:

cheat -l

• To list all cheatsheets whose titles match apt:

cheat -l apt

• To list all tags in use:

cheat -T

• To list available cheatsheets that are tagged as personal:

cheat -l -t personal

• To search for ssh among all cheatsheets, and colorize matches:

cheat -c -s ssh

• To search (by regex) for cheatsheets that contain an IP address:

cheat -c -r -s `(?:[0-9]{1,3}.){3}[0-9]{1,3}'

• To remove (delete) the foo/bar cheatsheet:

cheat –rm foo/bar

📁 FILES 📁

Configuration

cheat is configured via a YAML file that is conventionally named conf.yaml. cheat will search for conf.yaml in varying locations, depending upon your platform:

🐧 Linux, OSX, and other Unixes 🍎

1. CHEAT_CONFIG_PATH
2. XDG_CONFIG_HOME/cheat/conf.yaml
3. $HOME/.config/cheat/conf.yml
4. $HOME/.cheat/conf.yml

🪟 Windows 🪟

1. CHEAT_CONFIG_PATH
2. APPDATA/cheat/conf.yml
3. PROGRAMDATA/cheat/conf.yml

cheat will search in the order specified above. The first conf.yaml encountered will be respected 💖

bestie, the search order is sacred — first one wins, no cap.

If cheat cannot locate a config file, it will ask if you’d like to generate one automatically. Alternatively, you may also generate a config file manually by running cheat –init and saving its output to the appropriate location for your platform.

Cheatpaths

cheat reads its cheatsheets from “cheatpaths”, which are the directories in which cheatsheets are stored. Cheatpaths may be configured in conf.yaml, and viewed via cheat -d.

For detailed instructions on how to configure cheatpaths, please refer to the comments in conf.yml.

Autocompletion

Autocompletion scripts for bash, zsh, and fish are available for download:

• <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
• <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
• <https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>

The bash and zsh scripts provide optional integration with fzf, if the latter is available on your PATH.

The installation process will vary per system and shell configuration, and thus will not be discussed here.

🌈 ENVIRONMENT 🌈

• CHEAT_CONFIG_PATH — the path at which the config file is available. If CHEAT_CONFIG_PATH is set, all other config paths will be ignored.
• CHEAT_USE_FZF — if set, autocompletion scripts will attempt to integrate with fzf.

🦋 RETURN VALUES 🦋

• 0 — Successful termination
• 1 — Application error
• 2 — Cheatsheet(s) not found

😭 BUGS 😭

See GitHub issues: <https://github.com/cheat/cheat/issues>

👑 AUTHOR 👑

Christopher Allen Lane <chris@chris-allen-lane.com>

🔥 SEE ALSO 🔥

fzf(1)

---

and that’s the footer tea, bestie ☕: CHEAT(1) from the General Commands Manual — no separate version number or date was chilling in the original footer, so this is the sparkly sign-off 🫶💖