Fork it!

About Cheatly

A cheat-sheet cli for a cheat repository

This is a command line toolset to handle the cheat-sheets reposity located at sheets folder.

This gem is not a fork but inspired by defunkt/cheat. However instead of using a full server to store the sheets, it uses github as central repository, making more reliable and easy to add new ones.

Help us! View on Github

Installation

This is fuk** easy, just do:

$ gem install cheatly

Usage

Help

$ cheatly help

List all cheat sheets

$ cheatly ls

Show a cheat sheet

$ cheatly show gem_release

Contributing

Help: Adding a new cheat-sheet

Submit a PR, adding a file to sheets folder, with the cheat-sheet name.

  1. git clone https://github.com/arthurnn/cheatly.git && cd cheatly
  2. cheatly create name (replacing name with name of the sheet)
  3. Replace content of sheets/name.md
  4. cheatly show --local NAME to test your new sheet
  5. Create new Pull Request

Add a new feature

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Build from source

Building from source will allow you to test changes to your code locally before pushing it back to origin.

  1. git clone https://github.com/arthurnn/cheatly.git
  2. cd cheatly
  3. bundle exec rake install

Repeat steps 3-4 to check modified code.