Project

cheatly

0.03
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
A cheat-sheet cli for a cheat repository
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.3
~> 5.0.8
>= 0

Runtime

~> 0.6.0
~> 2.7.1
~> 1.0.1
~> 3.0.0
~> 0.18.1
 Project Readme

Cheatly

Build Status Code Climate

This is a command line toolset to handle the cheat-sheets repository 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: 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

Installation

$ gem install cheatly

Usage

Help

$ cheatly help

List all cheat sheets

$ cheatly ls

Show a cheat sheet

$ cheatly show gem_release

Contributing

  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.

Testing

You can also run tests using rake test command.