Fabulous cheat

fcheat is for all who cannot remember all the commands ;)

Usage

Specify a location for your cheatsheets (or use default ~/.config/fcheatsheets/):

FCHEAT_CHEATSDIR = ~/.config/my-cheatsheets/

Use fcheat:

  Fabulous cheat sheet

  Usage
    $ fcheat <options>

  Options
    --cheatdir, -c set directory with cheatsheets
                   set permanently via env var FCHEAT_CHEATSDIR
                   default: ~/.config/fcheatsheets/
    --pagesize, -p specify the shown page size (default: 10)
    --nodetails, -n show only command in overview

  Examples
    $ fcheat -p 5

Cheatsheets

You need cheatsheet files as source for fcheat. Use the repo fcheatsheets as starting point.

Development

Before you begin, ensure you have met the following requirements:

• You have installed node.

That's it ;) Admittedly, I didn't test the project on Windows, but it runs fine on Ubuntu and Mac.

Using fcheat

Install all dependencies with

npm install

Start it

npm run start

Contributing to fcheat

To contribute to fcheat, follow these steps:

1. Fork this repository.
2. Create a branch.
3. Make your changes and commit them.
4. Push to the original branch.
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contact

If you want to contact me you can reach me at adam.urban@gmail.com.

License

This project uses the following license: MIT.