⏰ timetrace

timetrace is a simple CLI for tracking your working time.

🔥 New: Reverting edit and delete commands is now possible

Installation

Homebrew

brew tap dominikbraun/timetrace
brew install timetrace

Snap

sudo snap install timetrace --edge --devmode

AUR

yay -S timetrace-bin

Docker

The timetrace Docker image stores all data in the /data directory. To persist this data on disk, you should create a bind mount or named volume like so:

docker container run -v my-volume:/data dominikbraun/timetrace version

Binary

Download the latest release and extract the binary into a directory like /usr/local/bin or C:\Program Files\timetrace. Make sure the directory is in the PATH variable.

Usage example

First, create a project you're working for:

timetrace create project make-coffee

Once the project is created, you're able to track work on that project.

timetrace start make-coffee

You can obtain your currently worked time using timetrace status. When you've finished your work, stop tracking:

timetrace stop

Project modules

To refine what part of a project you're working on, timetrace supports project modules. These are the exact same thing as normal projects, except that they have a key in the form <module>@<project>.

Creating a grind-beans module for the make-coffee project is simple:

timetrace create project grind-beans@make-coffee

The new module will be listed as part of the make-coffee project:

timetrace list projects
+-----+-------------+-------------+
|  #  |     KEY     |   MODULES   |
+-----+-------------+-------------+
|   1 | make-coffee | grind-beans |
+-----+-------------+-------------+

When filtering by projects, for example with timetrace list records -p make-coffee today, the modules of that project will be included.

Command reference

Create a project

Syntax:

timetrace create project <KEY>

Arguments:

Argument	Description
KEY	An unique project key.

Example:

Create a project called make-coffee:

timetrace create project make-coffee

Get a project

Syntax:

timetrace get project <KEY>

Arguments:

Argument	Description
KEY	The project key.

Example:

Display a project called make-coffee:

timetrace get project make-coffee

Get a record

Syntax:

timetrace get record <YYYY-MM-DD-HH-MM>

Arguments:

Argument	Description
YYYY-MM-DD-HH-MM	The start time of the desired record.

Example:

By default, records can be accessed using the 24-hour format, meaning 3:00 PM is 15. Display a record created on May 1st 2021, 3:00 PM:

timetrace get record 2021-05-01-15-00

This behavior can be changed.

List all projects

Syntax:

timetrace list projects

Example:

List all projects stored within the timetrace filesystem:

timetrace list projects
+---+-------------+
| # |     KEY     |
+---+-------------+
| 1 | make-coffee |
| 2 | my-website  |
| 3 | web-shop    |
+---+-------------+

List all records from a date

Syntax:

timetrace list records {<YYYY-MM-DD>|today|yesterday}

Arguments:

Argument	Description
YYYY-MM-DD	The date of the records to list, or today or yesterday.
today	List today's records.
yesterday	List yesterday's records.

Flags:

Flag	Short	Description
--billable	-b	only display billable records.
--project	-p	filter records by project key.

Example:

Display all records created on May 1st 2021:

timetrace list records 2021-05-01
+-----+-------------+---------+-------+------------+
|  #  |   PROJECT   |  START  |  END  |  BILLABLE  |
+-----+-------------+---------+-------+------------+
|   1 | my-website  | 17:30   | 21:00 | yes        |
|   2 | my-website  | 08:31   | 17:00 | no         |
|   3 | make-coffee | 08:25   | 08:30 | no         |
+-----+-------------+---------+-------+------------+

Filter records by the make-coffee project:

timetrace list records 2021-05-01
+-----+-------------+---------+-------+------------+
|  #  |   PROJECT   |  START  |  END  |  BILLABLE  |
+-----+-------------+---------+-------+------------+
|   1 | make-coffee | 08:25   | 08:30 | no         |
+-----+-------------+---------+-------+------------+

This will include records for project modules like grind-beans@make-coffee.

Edit a project

Syntax:

timetrace edit project <KEY>

Arguments:

Argument	Description
KEY	The project key.

Flags:

Flag	Short	Description
--revert	-r	Revert the project to it's state prior to the last edit.

Example:

Edit a project called make-coffee:

timetrace edit project make-coffee

🔥 New: Restore the project to it's state prior to the last edit:

timetrace edit project make-coffee --revert

Edit a record

Syntax:

timetrace edit record {<KEY>|latest}

Arguments:

Argument	Description
KEY	The project key. YYYY-MM-DD-HH-MM by default or YYYY-MM-DD-HH-MMPM if use12hours is set.

Flags:

Flag	Short	Description
--plus	-p	Add the given duration to the record's end time, e.g. --plus 1h 10m
--minus	-m	Subtract the given duration from the record's end time, e.g. --minus 1h 10m
--revert	-r	Revert the record to it's state prior to the last edit.

Example:

Edit the latest record. Specifying no flag will open the record in your editor:

timetrace edit record latest

Add 15 minutes to the end of the record created on May 1st, 3PM:

timetrace edit record 2021-05-01-15-00 --plus 15m

🔥 New: Restore the record to it's state prior to the last edit:

timetrace edit record 2021-05-01-15-00 --revert

Tip: You can get the record key 2021-05-01-15-00 using timetrace list records.

Delete a project

Syntax:

timetrace delete project <KEY>

Arguments:

Argument	Description
KEY	The project key.

Flags:

Flag	Short	Description
--revert	-r	Restore a deleted project.

Example:

Delete a project called make-coffee:

timetrace delete project make-coffee

🔥 New: Restore the project to it's pre-deletion state:

timetrace delete project make-coffee --revert

Delete a record

Syntax:

timetrace delete record <YYYY-MM-DD-HH-MM>

Arguments:

Argument	Description
YYYY-MM-DD-HH-MM	The start time of the desired record.

Flag	Short	Description
--yes		Do not ask for confirmation
--revert	-r	Restore a deleted record.

Example:

Delete a record created on May 1st 2021, 3:00 PM:

timetrace delete record 2021-05-01-15-00

🔥 New: Restore the record to it's pre-deletion state:

timetrace delete record 2021-05-01-15-00 --revert

Start tracking

Syntax:

timetrace start <PROJECT KEY>

Arguments:

Argument	Description
PROJECT KEY	The key of the project.

Flags:

Flag	Short	Description
--billable	-b	Mark the record as billable.

Example:

Start working on a project called make-coffee and mark it as billable:

timetrace start --billable make-coffee

Print current status

Syntax:

timetrace status

Example:

Print the current tracking status:

timetrace status
+-------------------+----------------------+----------------+
|  CURRENT PROJECT  |  WORKED SINCE START  |  WORKED TODAY  |
+-------------------+----------------------+----------------+
| make-coffee       | 1h 15min             | 4h 30min       |
+-------------------+----------------------+----------------+

Stop tracking

Syntax:

timetrace stop

Example:

Stop working on your current project:

timetrace stop

Print version information

Syntax:

timetrace version

Example:

Print your installed timetrace version:

timetrace version

Configuration

You may provide your own configuration in a file called config.yaml within $HOME/.timetrace.

Prefer 12-hour clock for storing records

If you prefer to use the 12-hour clock instead of the default 24-hour format, add this to your config.yaml file:

use12hours: true

This will allow you to view a record created at 3:00 PM as follows:

timetrace get record 2021-05-14-03-00PM

Set your preferred editor

By default, timetrace will open the editor specified in $EDITOR or fall back to vi. You may set your provide your preferred editor like so:

editor: nano

Credits

This project depends on the following packages:

• spf13/cobra
• spf13/viper
• fatih/color
• olekukonko/tablewriter
• enescakir/emoji