cli-time-tracker
Installation
Extra Dependencies
- This package depends on
afk
which requiresnode-gyp
to build native modules. - MacOS 10.13 or earlier users need to install the Swift runtime support libraries as
active-win
requires them. - Linux users need to install
libxss-dev
andpkg-config
to allow.
Globally
npm install -g cli-time-tracker
or
npx -p cli-time-tracker timetrack
Locally
npm install cli-time-tracker
Usage
Start tracking
timetrack
or
tt
If using git, run timetrack
inside the repo to allow tracking against a branch name.
It will check the current window and try to extract a Jira ticket number from the title (e.g. FOO-1234). If the current window is VSCode, it will use the ticket number in the branch or the branch name itself of the repo that timetrack
was run in.
Custom Task Patterns
To help track against common tasks, you can create a transforms.json
file in the /path/to/home/tt
directory. This way when you are active on a window with a title matching one of these patterns, it will track against the respective task name. Patterns are used in top-to-bottom priority.
{
".*Foo|Bar.*": "TST-3",
"Word.*": "Uni Work",
".*TMA|EMA.*": "Uni Work",
".*Meet.*": "Meetings"
}
Get time
timetrack --today
timetrack -t
timetrack --all
timetrack -a
Export Time
To export your tracked time in a way that can be imported into Jira timesheets, use the following command. Note, currently there is no way to select certain dates to export so all tracked time will be exported. Once tracked time has been imported into jira, you can delete the xx-xx-xxxx.csv
files in /path/to/home/tt/time_tracking/
.
timetrack --export
timetrack -e
This will export a .csv
file to /path/to/home/tt/export.csv