# Install cheat with Homebrew, dnf, MacPorts, Nix, scoop, zypper

Create and view interactive cheat sheets for *nix commands. Version 5.1.0 via Homebrew; verified from local package data.

## Install

```sh
sudo av install brew:cheat
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install cheat
```

  Evidence: local Homebrew formula metadata

- MacPorts (94%):

```sh
sudo port install cheat
```

  Evidence: MacPorts ports tree: devel/cheat/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

### Linux

- dnf (92%):

```sh
sudo dnf install cheat
```

  Evidence: Fedora Rawhide package metadata: cheat from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst

- Nix (92%):

```sh
nix profile install nixpkgs#cheat
```

  Evidence: nixpkgs package indexes: pkgs/by-name/ch/cheat/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

- zypper (92%):

```sh
sudo zypper install cheat
```

  Evidence: openSUSE Tumbleweed package metadata: cheat from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst

### Windows

- Scoop (92%):

```sh
scoop install main/cheat
```

  Evidence: Scoop official bucket manifest trees: bucket/cheat.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

## Package facts

- **Package key:** brew:cheat
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/cheat>
- **Version:** 5.1.0
- **Source summary:** Create and view interactive cheat sheets for *nix commands
- **Homepage:** <https://github.com/cheat/cheat>
- **Repository:** <https://github.com/cheat/cheat>
- **Upstream docs:** <https://github.com/cheat/cheat#readme>
- **License:** MIT
- **Source archive:** <https://github.com/cheat/cheat/archive/refs/tags/5.1.0.tar.gz>
- **Generated:** 2026-07-09T07:20:21+00:00

## Executables

- cheat (cli)
- cheat (alias)

## Build dependencies

- go

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-07-09
- Package-manager version: 5.1.0
- Local data: ok
- Upstream repository: https://github.com/cheat/cheat
- Upstream latest detected: 5.1.0 (current)
- info: No package-manager update timestamp was available.
## Project history and usage

cheat is a command-line cheatsheet viewer and editor for Unix-style command reference, designed for commands that administrators use often enough to need quick reminders but not often enough to memorize.

### Project history

The GitHub repository was created in July 2013. The README describes a CLI that reads plain-text cheatsheets, supports personal and community cheatpaths, can edit sheets, and can search or filter by name, regex, path, and tags.

### Adoption history

cheat grew beyond a single executable into an ecosystem around the cheat/cheatsheets repository, which was created in October 2019 for community-sourced sheets. The official installation guide lists manual binaries, `go install`, and packages for AUR, Homebrew, Docker, Nix, and Snap; the batch input also records MacPorts, Fedora, openSUSE, Scoop, and other package-manager coverage.

### How it is used

Typical use is `cheat tar` or another command name to print examples, `cheat -e` to edit or create a sheet, `cheat -l` or `cheat -b` to list sheets, and `cheat -s` or `cheat -r -s` to search sheet contents.

### Why package nerds care

cheat matters to CLI/package-manager culture because it turns command examples into local, editable, packageable data. Its XDG config, generated shell completions, community sheet repository, and broad package-manager availability make it a familiar small tool in terminal setup lists.

### Timeline

- 2013: GitHub repository created.
- 2019: cheat/cheatsheets repository created for community-sourced sheets.
- 2019: 3.0.0 release published on GitHub.
- 2026: Current installation docs describe 5.0.0 release binaries.

### Related projects

- cheat/cheatsheets provides community-sourced cheatsheets used by the tool.
- Chroma is used for syntax highlighting according to the README.
- The project overlaps culturally with man pages, tldr-style pages, and shell-completion-driven command reference tools.

### Sources

- <https://github.com/cheat/cheat>
- <https://github.com/cheat/cheat/blob/master/INSTALLING.md>
- <https://api.github.com/repos/cheat/cheat>
- <https://api.github.com/repos/cheat/cheatsheets>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals


## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: ~/.config/cheat/conf.yml, path set by CHEAT_CONFIG_PATH
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** cheat
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Conflicts With:** bash-snippets
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable

## Other Package-Manager Records

- Nix - cheat: normalized package name match | nixpkgs package indexes: pkgs/by-name/ch/cheat/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- dnf - cheat - 4.4.2-14.fc44: normalized package name match | Fedora Rawhide package metadata: cheat from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Help for various commands and their use cases | https://github.com/cheat/cheat
- dnf - cheat-bash-completion - 4.4.2-14.fc44: normalized package name match | Fedora Rawhide package metadata: cheat-bash-completion from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Bash completion support for cheat | https://github.com/cheat/cheat
- dnf - cheat-community-cheatsheets - 4.4.2-14.fc44: normalized package name match | Fedora Rawhide package metadata: cheat-community-cheatsheets from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Cheatsheets created by community for cheat | https://github.com/cheat/cheatsheets
- dnf - cheat-fish-completion - 4.4.2-14.fc44: normalized package name match | Fedora Rawhide package metadata: cheat-fish-completion from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Fish completion support for cheat | https://github.com/cheat/cheat
- dnf - cheat-zsh-completion - 4.4.2-14.fc44: normalized package name match | Fedora Rawhide package metadata: cheat-zsh-completion from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Zsh completion support for cheat | https://github.com/cheat/cheat
- zypper - cheat - 5.1.0-2.1: normalized package name match | openSUSE Tumbleweed package metadata: cheat from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Allows you to create and view interactive cheatsheets on the command-line | https://github.com/cheat/cheat
- MacPorts - cheat: normalized package name match | MacPorts ports tree: devel/cheat/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
- Scoop - main/cheat: normalized package name match | Scoop official bucket manifest trees: bucket/cheat.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1


## Related links

- [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [go](https://www.automicvault.com/pkg/brew/go/) - Build dependency declared by Homebrew.
- [gtree](https://www.automicvault.com/pkg/brew/gtree/) - Shares av.db curated category or tags: cli, developer-tools, documentation, go.
- [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [adr-tools](https://www.automicvault.com/pkg/brew/adr-tools/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [adr-viewer](https://www.automicvault.com/pkg/brew/adr-viewer/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [cargo-docset](https://www.automicvault.com/pkg/brew/cargo-docset/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [context7-mcp](https://www.automicvault.com/pkg/brew/context7-mcp/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [cppman](https://www.automicvault.com/pkg/brew/cppman/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [dita-ot](https://www.automicvault.com/pkg/brew/dita-ot/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [docbook-xsl](https://www.automicvault.com/pkg/brew/docbook-xsl/) - Local metadata places this package in an adjacent workflow. Shared terms: cli, create, developer, developer-tools, documentation.
- [github-markdown-toc](https://www.automicvault.com/pkg/brew/github-markdown-toc/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, go.

## Combined YAML source

View the package source record on GitHub. [combined/cheat.yml](https://github.com/automic-vault/db/blob/main/combined/cheat.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph
