zaagan / glint

Never forget a command again with our cheat sheet application

Glint - A Terminal based Cheat Sheet

Glint is a command-line application that allows you to create, edit, and access your own cheat sheet for programming languages, frameworks, or anything else you might want to keep track of. You can add cheats with a name, description, and code snippet, and then easily search for and view them later.

 

Installation

1. Clone the repository:

  git clone https://github.com/YOUR_USERNAME/glint.git

2. Navigate to the project directory:

cd glint

3. Install dependencies using Bundler:

bundle install

4. Make the bin/glint file executable

chmod +x bin/glint

5. For global use - Add glint to your PATH

export PATH=$PATH:$(pwd)/bin

 

Usage

Initializing the database

Before you can use Glint, you need to initialize the database. Luckily glint initializes itself if you run one of the glint commands. For example

bin/glint list

It creates an SQLite database file named glint.db in the db directory.

 

Adding a cheat

There are two ways to add your own custom cheats

1st Approach:

To add a cheat, use the add command with the cheat's type, name, code snippet and description:

bin/glint add "Create table" "Create a new table in SQL" "CREATE TABLE table_name (
column1 datatype,
column2 datatype,
...
);"

or Create your own .yml file in the seed/ directory. Check out existing samples in the directory. The next time you run a glint command, your cheats get auto inserted to the database.

 

Listing cheats

To list all cheats, use the list command: The type field can be optionally used to dislay only for a certain type.

bin/glint list <type>

This will display a table of all cheats currently stored in the database.

Sample

 

Searching for cheats

To search for a cheat, use the search command with a search term:

bin/glint search "table"

This will display a table of all cheats that include the search term "table" in either the name or description.

Sample

 

Updating a cheat

To update a cheat, use the update command with the cheat's ID, new name, and new code snippet:

bin/glint update 1 "Create a new table in SQL" "CREATE TABLE table_name (
column1 datatype,
column2 datatype,
...
);"

This will update the cheat with ID 1 to have the new name and code snippet.

 

Deleting a cheat

To delete a cheat, use the delete command with the cheat's name:

bin/glint delete <name>

This will delete the cheat with ID 1 from the database.

 

Technical details

• Glint is built using Ruby and SQLite, with the sqlite3 and terminal-table gems for database management and table formatting, respectively.
• The bin directory contains executable scripts for adding, listing, searching, updating, and deleting cheats. These scripts call methods defined in lib/glint.rb to interact with the database.
• The lib directory contains the main Glint class and a module for colorizing output.
• The database schema is defined in db/schema.sql, and the database itself is created and managed using db/database.rb.

 

License

This project is licensed under the MIT License.