README
¶
cheat
cheat allows you to create, view, and edit cheatsheets on the command-line.
This project is a re-implementation of Chris Lane's cheatsheet script in Go along with a few added features and some opinionated formatting & colorization.
Install
Option 1: Binary
Download the latest release from https://github.com/jakewarren/cheat/releases/latest
Option 2: From source
go get github.com/jakewarren/cheat
Usage
Configuring
cheat is configured by a JSON file located at ~/.cheatrc. A default config will be generated for you:
{
"highlight": true,
"cheatdirs": [
"~/.cheat"
],
"editor": "vim"
}
| Configuration Option | Description |
|---|---|
| highlight | controls the colorization of the output |
| cheatdirs | an array of directories to search for cheatsheets in. when a new cheatsheet is created, it will be placed in the first directory specified. |
| editor | specifies the editor to be called when editing a cheat sheet |
Cheatsheets
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 git # file is named "git"
Example cheatsheet syntax (left) and display (right):
Acknowledgements
Changes
All notable changes to this project will be documented in the changelog.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
License
MIT © 2019 Jake Warren
Documentation
¶
There is no documentation for this package.
Source Files