twotime

Sync timesheets between Harvest and Targetprocess

Installation

Note that the old, public package (v2.0.0) is deprecated and will be removed at some point. Do not use this version.

Setting up .npmrc

If necessary, set up access to the NewOrbit DevOps artefacts by following the Connect to a feed procedure in Get started with npm packages in Azure Artifacts. A few things in addition to that page:

1. Make sure you have installed the npm package vsts-npm-auth first, by using npm install vsts-npm-auth.
2. Your .npmrc file needs to have these entries:

   registry=https://registry.npmjs.org/
   @neworbit:registry=https://pkgs.dev.azure.com/neworbit/_packaging/NewOrbit/npm/registry/
   always-auth=true
   
3. If vsts-npm-auth -config .npmrc doesn't work, try npx vsts-npm-auth -config .npmrc.
4. If that command fails with a "Couldn't get an authentication token" message, try adding -F to the end of the command to force it.
   • This can also happen if you already have an expired auth token in .npmrc. You can try clearing the contents of the file down to just the above three lines and then retrying the vsts-npm-auth command.

Installing the correct version

Note: You can't finish timers from previous days that were started with the old twotime. Either finish those timers first, or fix up manually in Harvest and TP afterwards.

Uninstall the old version 2.0.0:

npm uninstall -g twotime

Then install the latest twotime from our own feed:

npm install -g @neworbit/twotime

If this command fails:

1. Ensure you have the correct .npmrc file set up as described above.
2. If the installation process cannot get rid of old files, please report this. As a last resort, use --force.

If you are upgrading from version 2.0.0 there should be no need to reauthenticate as v3.x uses the same mechanism and files.

Setup

Once installed, you need to authenticate against Harvest and Targetprocess.

twotime auth

You will need:

• Harvest personal access token and account ID
• Targetprocess username and password

Windows and WSL

If you're using Windows and WSL, you may wish to be able to use twotime in either environment. To avoid having two separate authentication configurations you can symlink the configuration files.

Windows and WSL example

Assuming you've already installed and authenticated your Windows installation of twotime, then head to WSL:

1. Install twotime in WSL

   $ npm -g i twotime

2. symlink the configs, substituting USER_NAME with the value from %USERNAME% in your Windows environment

   $ mkdir -p ~/.config/configstore
   $ ln -s /mnt/c/Users/USER_NAME/.config/configstore/twotime.json ~/.config/configstore/twotime.json
   $ twotime list
   [INFO] Getting config from /home/JohnDoe/.config/configstore/twotime.json
   ╔═══════════════╤══════════════════════════╤═════════════╤════════╗
   ║  Entity Type  │  Title                   │    Hours    │ Status ║

Usage

Please ensure you've authenticated (see Setup) before using twotime.

Time tracking

• Use twotime start to start a timer
• Use twotime finish to finish a timer
• Use twotime pause to pause the currently running timer
• Use twotime resume to resume a paused timer

List your timesheet

Use twotime list to see a summary of a days timesheet.

Past timers

Most commands can be used with past timesheets. You can provide a --date option (or -d for short):

twotime start --date 2018-10-20

Also you can use an offset with --offset (or -o for short) for the number of days in the past. For example an offset of 1 is yesterday:

twotime start -o 1

Finish all

Provide the --all option to finish all of a day's timers at once.

Targetprocess Shortcut

Use the --tp option to start a timer without prompting for a Targetprocess ID:

twotime start --tp 12345

Issue time entries

When a time entry for a TargetProcess Issue is finished, time is booked on the relevant TargetProcess entity based on the value of custom field IssueTime to on the TargetProcess project. Values for this custom field can be as below:

• User story - Issue time is booked on the user story. If the issue is not attached to a user story, no time is booked on TargetProcess.
• Issue - Issue time is booked to the issue.
• none - No issue time is booked on TargetProcess.

Task time entries

When a time entry for a TargetProcess Task is finished, if the time remaining on the task is 0, then it is moved to Done state.

License

(Original public package: Made with 💖 by NewOrbit in Oxfordshire, and licensed under the MIT Licence)