https://github.com/tom-draper/clockin
A command-line tool for tracking time spent working.
https://github.com/tom-draper/clockin
cli-app command-line command-line-tool go golang mysql productivity session-tracking time-management tracking tui
Last synced: 2 months ago
JSON representation
A command-line tool for tracking time spent working.
- Host: GitHub
- URL: https://github.com/tom-draper/clockin
- Owner: tom-draper
- License: mit
- Created: 2022-09-22T12:30:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-09T14:47:15.000Z (over 3 years ago)
- Last Synced: 2025-05-24T17:40:54.379Z (about 1 year ago)
- Topics: cli-app, command-line, command-line-tool, go, golang, mysql, productivity, session-tracking, time-management, tracking, tui
- Language: Go
- Homepage:
- Size: 3.56 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
```bash
go mod download
```
### Build
Compile the program on your machine with:
```bash
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:
```bash
clockin start
```
You can keep track of multiple work sessions running at once by providing a name identifier:
```bash
clockin start homework
```
### Finishing a work session
To finish recording for all currently running work sessions, run:
```bash
clockin stop
```
You can specify a particular work session by its name identifier:
```bash
clockin stop homework
```
### Show running sessions
To list all currently running work sessions, run:
```bash
clockin running
```
### Reset data
To delete all stored data, run:
```bash
clockin reset
```
### Statistics
A statistical summary of how you've spent your time working can be displayed by running:
```bash
clockin stats
```