A command line tool that you can use to create your own local cheatsheets ✏️ 📓
Node.js: v17.7.2
Please follow these steps to setup setup the Cheat-CLI on your machine:
First fork the project then clone the repo into your HOME directory, then navigate into the .cheat-cli directory and run the following command:
npm run setupOnce the setup is complete you will have access to the cheat command globally on your machine.
The cheat command currently accepts only a single flag at a time. These options are described in the table below.
| Action | Shorthand | Longhand |
|---|---|---|
| Add a new note | -a | --add |
| Browse existing notes | -br | --browse |
| Backup notes | -bk | --backup |
| Search notes | -s | --search |
| Help | -h | --help |
When adding a note you are able to choose from the current topics and techs or create new ones by choosing the "None of the above" option.
Finally you are asked to provide both a tile and a body for the note.
See below for an example:
When searching your notes you are asked to provide the name of the technology you are searching for. Please only search for valid tech names - no characters that aren't in the alphabet!
When you choose to browse your notes you will be asked to choose both the topic and tech that you wish to browse.
The notes will then all be printed to your terminal as shown below:
Finally, something I recommend doing regularly, you have the option to backup your notes. Just in case something goes wrong!
