cheat

README

cheat

Reimplementation of Chris Lane's cheatsheet script in Go.

I'm mostly doing this as a means of learning Go as it seemed like a nice first project to start with.

Setup

go get github.com/dufferzafar/cheat

For now, you need to download the actual cheatsheets from Chris's repo. Put them in ~/.cheatsheets folder. A future version will have a command that'll do this ;)

Usage

~/.cheatrc - A JSON based config file which stores basic configuration.

cheat show git - Show the git cheatsheet

cheat edit git - Edit the git sheet. A new one will be created if it doesn't already exist.

cheat show git --copy 12 - Copy the 12th cheat from the sheet

Todo

• Allow multiple cheat directories

• cheat fetch command to fetch all the cheatsheets from a repo.

• Find a way of using all the sheets from chris's repo, along with stuff that I've added.

• Colors on the AppHelpTemplate.

• Or execute a command by, cheat git 12 ?

• User's favorite editor, with support for command line parameters.

• Wrap the output to a fit width? like 79 characters?

• Update cheat sheets from chris' repo, cheat --update for updating it the safe way, and cheat --update --force for overwriting all the cheats with the downloaded version.

• Should grep support be added? or can that be achived by grepping things?

Far Future

• Add support for bro pages
• A complete client for http://www.commandlinefu.com/site/api

Prior Art

• /chrisallenlane/cheat in Python
• /jahendrie/cheat in Bash
• /lucaswerkmeister/cheats in Bash
• /defunkt/cheat in Ruby
• /torsten/cheat in Ruby (single file)
• /arthurnn/cheatly in Ruby

Documentation

Overview

Create and view command-line cheatsheets. A Go reimplementation of Chris Lane's python script.