https://github.com/weakish/cheat

A cheat.rb clone in shell (use git repo to store cheatsheets).
https://github.com/weakish/cheat

Last synced: 7 days ago
JSON representation

A cheat.rb clone in shell (use git repo to store cheatsheets).

• Host: GitHub
• URL: https://github.com/weakish/cheat
• Owner: weakish
• License: other
• Created: 2012-05-08T01:09:07.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2017-07-10T14:25:41.000Z (almost 9 years ago)
• Last Synced: 2025-03-02T05:28:37.966Z (over 1 year ago)
• Language: Shell
• Size: 13.7 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
cheat

=====

A [cheat.rb][] clone in shell (use git repo to store cheatsheets).

[cheat.rb]: http://cheat.errtheblog.com

It uses git repository instead of central website to store cheat-sheets.

[![xkcd1168]](http://xkcd.com/1168/)

[xkcd1168]: http://imgs.xkcd.com/comics/tar.png "xkcd commic 1168 tar bomb"

Install

-------

    git clone git://github.com/weakish/cheat.git

    cd cheat

    # edit config.mk to suit your needs

    make

### Uninstall

    cd cheat

    make uninstall

Usage

-----

    cheat cheat

Or [view it online](https://github.com/weakish/cheat/wiki/cheat).

Cheat-sheets

----------

All cheat-sheets are stored in a git repository.

The path to the git repository is specified in environment variable `CHEAT_REPO`.

There is a git-based [wiki](https://github.com/weakish/cheat/wiki) hosted on GitHub too.

You may clone it to your machine.

All cheat-sheets are licensed under 0BSD, the same license of cheat shell scripts.

Contribute

----------

Fork and send pull requests.

Report issues.

Submit and edit cheatsheets in the following ways:

- Fork the wiki repo and send pull requests, just like its code.

- Edit the wiki through web.

- Edit the wiki through GitHub api.