Go to file
Chris Allen Lane 7908a678df
Merge pull request #742 from cheat/dependabot/go_modules/github.com/cloudflare/circl-1.3.7
chore(deps): bump github.com/cloudflare/circl from 1.3.6 to 1.3.7
2024-01-08 15:34:48 -05:00
.github chore: CI template nits 2022-08-05 07:49:20 -04:00
build Fix Windows 2021-09-29 01:33:59 +09:00
cmd/cheat chore: bump version to 4.4.2 2023-12-15 12:48:39 -05:00
configs chore(docs): improve configuration docs (#656) 2022-08-26 13:55:09 -04:00
doc chore(deps): upgrade dependencies 2023-12-13 08:29:02 -05:00
internal chore(deps): bump chroma to v2 #735 2023-12-13 12:54:32 -05:00
mocks feat(tests): add unit-tests 2020-11-11 19:33:31 -05:00
scripts Fix ZSH autocompletion 2021-06-07 11:42:47 +02:00
vendor chore(deps): bump github.com/cloudflare/circl from 1.3.6 to 1.3.7 2024-01-08 16:53:49 +00:00
.gitignore v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
CONTRIBUTING.md docs: create `HACKING.md` 2022-07-05 15:07:34 -04:00
Dockerfile feat(Docker): create development Docker image 2020-11-07 18:47:24 -05:00
HACKING.md docs: create `HACKING.md` 2022-07-05 15:07:34 -04:00
INSTALLING.md chore: bump version to 4.4.2 2023-12-15 12:48:39 -05:00
LICENSE.txt chore: adds license and contributing file 2019-10-26 16:13:46 -04:00
Makefile chore(build): remove `plan9` support 2023-12-13 09:45:21 -05:00
README.md docs: create `INSTALLING.md` 2022-07-05 11:19:40 -04:00
go.mod chore(deps): bump github.com/cloudflare/circl from 1.3.6 to 1.3.7 2024-01-08 16:53:49 +00:00
go.sum chore(deps): bump github.com/cloudflare/circl from 1.3.6 to 1.3.7 2024-01-08 16:53:49 +00:00


Workflow status


cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

The obligatory xkcd

Use cheat with cheatsheets.


The next time you're forced to disarm a nuclear weapon without consulting Google, you may run:

cheat tar

You will be presented with a cheatsheet resembling the following:

# To extract an uncompressed archive:
tar -xvf '/path/to/foo.tar'

# To extract a .gz archive:
tar -xzvf '/path/to/foo.tgz'

# To create a .gz archive:
tar -czvf '/path/to/foo.tgz' '/path/to/foo/'

# To extract a .bz2 archive:
tar -xjvf '/path/to/foo.tgz'

# To create a .bz2 archive:
tar -cjvf '/path/to/foo.tgz' '/path/to/foo/'


To view a cheatsheet:

cheat tar      # a "top-level" cheatsheet
cheat foo/bar  # a "nested" cheatsheet

To edit a cheatsheet:

cheat -e tar     # opens the "tar" cheatsheet for editing, or creates it if it does not exist
cheat -e foo/bar # nested cheatsheets are accessed like this

To view the configured cheatpaths:

cheat -d

To list all available cheatsheets:

cheat -l

To list all cheatsheets that are tagged with "networking":

cheat -l -t networking

To list all cheatsheets on the "personal" path:

cheat -l -p personal

To search for the phrase "ssh" among cheatsheets:

cheat -s ssh

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

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

Flags may be combined in intuitive ways. Example: to search sheets on the "personal" cheatpath that are tagged with "networking" and match a regex:

cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'


For installation and configuration instructions, see INSTALLING.md.


Cheatsheets are plain-text files with no file extension, and are named according to the command used to view them:

cheat tar     # file is named "tar"
cheat foo/bar # file is named "bar", in a "foo" subdirectory

Cheatsheet text may optionally be preceeded by a YAML frontmatter header that assigns tags and specifies syntax:

syntax: javascript
tags: [ array, map ]
// To map over an array:
const squares = [1, 2, 3, 4].map(x => x * x);

The cheat executable includes no cheatsheets, but community-sourced cheatsheets are available. You will be asked if you would like to install the community-sourced cheatsheets the first time you run cheat.


Cheatsheets are stored on "cheatpaths", which are directories that contain cheatsheets. Cheatpaths are specified in the conf.yml file.

It can be useful to configure cheat against multiple cheatpaths. A common pattern is to store cheatsheets from multiple repositories on individual cheatpaths:

# conf.yml:
# ...
  - name: community                   # a name for the cheatpath
    path: ~/documents/cheat/community # the path's location on the filesystem
    tags: [ community ]               # these tags will be applied to all sheets on the path
    readonly: true                    # if true, `cheat` will not create new cheatsheets here

  - name: personal
    path: ~/documents/cheat/personal  # this is a separate directory and repository than above
    tags: [ personal ]
    readonly: false                   # new sheets may be written here
# ...

The readonly option instructs cheat not to edit (or create) any cheatsheets on the path. This is useful to prevent merge-conflicts from arising on upstream cheatsheet repositories.

If a user attempts to edit a cheatsheet on a read-only cheatpath, cheat will transparently copy that sheet to a writeable directory before opening it for editing.

Directory-scoped Cheatpaths

At times, it can be useful to closely associate cheatsheets with a directory on your filesystem. cheat facilitates this by searching for a .cheat folder in the current working directory. If found, the .cheat directory will (temporarily) be added to the cheatpaths.


Shell autocompletion is currently available for bash, fish, and zsh. Copy the relevant completion script into the appropriate directory on your filesystem to enable autocompletion. (This directory will vary depending on operating system and shell specifics.)

Additionally, cheat supports enhanced autocompletion via integration with fzf. To enable fzf integration:

  1. Ensure that fzf is available on your $PATH
  2. Set an envvar: export CHEAT_USE_FZF=true