Assorted utilities / CLI for dealing with time trackers. Not sure how much I'm going to be building here; just needed a place to put some assorted personal tools for now.
🚨 Warning: Experimental / built for personal use
This package is available via the NPM registry, under the name jtz-time-tracker-utils
.
You can install it with the NPM or Yarn commands you are used to, but some examples:
# Install globally
npm install -g jtz-time-tracker-utils
jttu --help
For configuring authentication (and possibly other config settings in the future), you will need a JSON file. By default, the CLI will look for one in your home directory, named .jtz-time-tracker-utils.config.json
.
Current possible config values:
Key | Expected Value Type | Description |
---|---|---|
HARVEST_PAT_ACCOUNT_ID |
string | number |
The Account ID associated with a harvest PAT (see section below). |
HARVEST_PAT_TOKEN |
string |
The actual Token value associated with a harvest PAT (see section below). |
All commands are prefixed with the global registered entrypoint for the application:
- Prod:
npx jtz-time-tracker-utils {COMMAND}
-
jttu {COMMAND}
(after installing globally withnpm -g jtz-time-tracker-utils
)
- Locally (dev)
npx tsx ./cli.ts {COMMAND}
Platform | Command | Description |
---|---|---|
harvest ✅ toggl ❌ |
rollup |
Generates a "roll-up" report, by user, client, project, and task. |
harvest ✅ toggl ❌ |
resume |
Resume the previously running time entry, with the start time set to right now. |
harvest ✅ toggl ❌ |
stop |
Stop the currently running time entry. |
harvest ✅ toggl ❌ |
status |
Display timer status / info. |
For any given command, you can use
--help
to see information about the available arguments.
Harvest authentication is done with a Personal Access Token (PAT). Head over to the Harvest Developers page to configure new (or view existing) PATs for your specific account.
Date | Release | Notes |
---|---|---|
3/5/2024 | v1.3.0 |
Split up CLI vs non-CLI export, add new Harvest commands |
1/2/2024 | v1.2.0 |
Start exporting types, open up interfaces, build script fixups. |
9/17/2023 | v1.1.1 |
Add status command for Harvest |
4/30/2023 | v1.0.1 |
Initial release 🚀! Just Harvest supported at this time. |
Dev notes are a WIP.
Most orchestration will be done with the bundled Taskfile.yml
, instead of package.json
scripts.
More About Me (Joshua Tzucker):