Skip to content

AlanDavd/gig

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gig

Go mod

A CLI application to hold a historic log of done tasks separated by category.

Install

To install the app you can download the source code:

$ git clone git@github.com:AlanDavd/gig.git

Then cd into the gig folder and run:

$ go install .

Also, you can run:

$ go get "github.com/alandavd/gig"

Usage

gig has only one purpose, save done tasks, that's why the usage of it has only two actions, list and add both categories and tasks.

Categories

The command new creates a new category that will hold tasks. Note that you cannot nest categories.

$ gig new "<category name>"

The command list lists all the categories you have created so far.

$ gig list

Since the database gig makes use of is a key-value database, each category is a new bucket that holds key-value entries.

Tasks

The command add creates a new task entry to a selected category.

$ gig add "<category_name>" "task description"

The command list serves both tasks and categories as well, to list tasks of a category you can use it this way:

$ gig list -t "<category_name>"

Export

gig allows you to export all your database history (categories, and their tasks) to a single json file. The export command will create a json file in the directory in which you are calling the command. You can do it with the next command:

$ gig export

Future of the Project

I created this application for my own usage on my daily basis, it has all the functions that I required. I'm currently developing it, and I will develop new features if I required them.

If you are using this project, and you enjoy it, please let me know. You can primarily reach me to alandavidrl11@gmail.com Really hope you find this project helpful :).

About

A CLI application to hold a historic log of done tasks

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages