## Installation Pre-built packages for Windows, macOS, and Linux are found on the [releases](https://github.com/darrikonn/cheat/releases) page. Managed packages are in: * **Homebrew** (*MacOs*) ```bash brew tap darrikonn/formulae brew install darrikonn/formulae/cheat ``` * **Scoop** (*Windows*) ```powerline scoop bucket add app https://github.com/darrikonn/cheat.git scoop install cheat ``` * **Other** (*Linux distros*) ```bash curl -s https://raw.githubusercontent.com/darrikonn/cheat/master/install.sh | bash -s -- -b /usr/local/bin ``` ## Getting started Run `cheat --help` to see possible commands. Here are some to get you started: - Run `cheat` to list all your cheats. - Run `cheat some.*regex` to fetch cheats matching your regex. - Run `cheat some.*regex add` to add a new cheat. ## API Check out the [`api`](https://github.com/darrikonn/cheat/blob/master/API.md). ## Configuring The location of your cheat data and your configuration will depend on these environment variables (in this order): 1. **CHEAT_HOME**: determines where your `cheatsheet.db` and `cheat.yaml` file will live 2. **XDG_CONFIG_HOME**: a fallback if `$CHEAT_HOME` is not set 3. **HOME**: a fallback if `$XDG_CONFIG_HOME` is not set. If `$HOME` is used; all cheat files will be transformed to a dotfile, i.e.`~/.cheatsheet.db` and `~/.cheat.yaml`. ### Editor When adding/editing a cheat, you'll be prompted to edit the cheat's `description` in your preferred editor. You can set your desired editor in the `$CHEAT_HOME/cheat.yaml` config file: ```yaml editor: nvim ``` If no *editor* config is specified, the editor will fallback to your `EDITOR` environment variable. If that can't be found, the default selected editor will be `vi`. ## Tags A neat way to search your cheats, is by describing them with tags. ```txt my summary tags: [awesome, golang] my description ``` That way, you can simply search your cheats by tags, resulting in group like option for your cheats. ```bash cheat 'tags: \[.*golang.*\]' ```cheat is a command line cheat manager,
where you can create and manage your personal cheatsheet
