tom-draper / clockin

A command-line tool for tracking time spent working.

A command-line tool for tracking your working periods. Start and stop the timer with two simple commands, and then open the built-in statistical summary to identify patterns and trends!

Getting Started

Install Dependencies

A local MySQL server is required by clockin to store session data on your machine. During setup, ensure you make note of your MySQL username and password and copy them into the .env file or enter them straight into the command line during the first run of the program.

Download Go dependencies with:

go mod download

Build

Compile the program on your machine with:

go build clockin.go

To make the executable runnable from anywhere, add the directory as a PATH environment variable.

How to Use

Starting a work session

To start recording a new work session, run:

clockin start

You can keep track of multiple work sessions running at once by providing a name identifier:

clockin start homework

Finishing a work session

To finish recording for all currently running work sessions, run:

clockin stop

You can specify a particular work session by its name identifier:

clockin stop homework

Show running sessions

To list all currently running work sessions, run:

clockin running

Reset data

To delete all stored data, run:

clockin reset

Statistics

A statistical summary of how you've spent your time working can be displayed by running:

clockin stats