Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 1.5 KB

README.md

File metadata and controls

62 lines (33 loc) · 1.5 KB
Raw

Cheat

cheat helps you to recall uncommon shell commands. cheat is super easy to extend and completely self-contained, all code and data is in one Ruby file.

Example Usage

Searching for all cheats that contain "git"

Note the fancy highlighting of search terms.

Installation

$ git clone [email protected]:torsten/cheat.git
$ ln -s path/to/cheat.rb ~/bin/cheat      # Assumes that ~/bin is in your $PATH

Usage

Searching

$ cheat [SEARCHTERM]

If SEARCHTERM is given, cheat lists only cheats that contain this term. Otherwise it will list all cheats.

Executing Cheats

$ `cheat foo`

If there is exactly one cheat matching cheat, cheat will print just the contents so that the backticks can execute the cheat. Thanks @i0rek for suggesting this feature.

Adding Cheats

Adding new cheats is as simple as opening cheat and adding new entries at the end of the file:

$ $EDITOR ~/bin/cheat

Cheats must have a title and content. All content between two titles counts towards the previous cheat. This is an example of a multi-line cheat:

Showing extended file attributes:

  ls -@ video.m4v 
  -rw-r--r--@ 1 torsten   staff   2.7M Nov 17 00:34 video.m4v
  	com.apple.metadata:kMDItemWhereFroms	 157B 
  xattr -p com.apple.metadata:kMDItemWhereFroms video.m4v 

[Next title starts here]

  [Next cheat content goes here]