cheat

command module
v0.0.0-...-f5a8101 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2017 License: GPL-3.0 Imports: 16 Imported by: 0

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.

Screenshot

Setup

Install: go get github.com/dufferzafar/cheat

Fetch cheatsheets: cheat fetch

Test: cheat show git

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

cheat fetch - When you feel like updating the sheets.

Todo

  • Autocomplete commands and available cheats for bash and zsh

  • Allow multiple cheat directories

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

  • Or execute a command by, cheat git 12 ?

  • Colors on the AppHelpTemplate.

  • 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?

Places that have sheets

Prior Art

Documentation

Overview

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL