coffeecup-cli

README

CoffeeCup CLI

[!NOTE] This is a private project! I'm not employed at CoffeeCup. We just happen to use it at our company and I was missing a CLI for it.

I was frustrated with starting/stopping/resuming my timers through the CoffeeCup UI. This repository provides a coffeecup-cli command to interact with CoffeeCup fom the command line.

With this tool you don't need to leave your development environment to update your CoffeeCup time entries. You can now do this:

$ coffeecup-cli start project1 "Task A"
# do some work
$ coffeecup-cli start project1 "Task B"
# do some work
$ coffeecup-cli start project2 "Task C"
# do some work
$ coffeecup-cli stop
# confirm that you've worked enough today
$ coffeecup-cli today
# close your laptop and drink a cup of tea on the couch

[!NOTE] This application goes very well with my VSCode extension for CoffeeCup. Check it out here: https://marketplace.visualstudio.com/items?itemName=fischeversenker.coffeecup

Installation

If you have go installed, you can install the coffeecup-cli like this:

go install github.com/fischeversenker/coffeecup-cli

If you don't have go installed, download a prebuilt binary from the latest release and put it somewhere in your $PATH.

Usage

Login

First you have to login:

coffeecup-cli login

This will ask for your company name, your username, and your password. The coffeecup-cli does not store the credentials that you provide here. It only stores the received token after a successful login. You only need to do this once.

Today's time entries

Once you logged in, you can now get your time entries of today:

coffeecup-cli status # alias: today

This will produce something like this:

$ coffeecup-cli status
Project 1 | ⌛ 01h 15m | 📝 - My Comment for this time entry
Project 2 |    00h 45m | 📝 - Other Comment
total     |    02h 00m

Add --color (or -c) to the command to get a more "colorful" output: coffeecup-cli today -c

Yesterday's time entries

Similar to the status/today command, there is a yesterday command that shows the time entries of yesterday:

coffeecup-cli yesterday

List projects

To get a list of all available projects:

coffeecup-cli projects list

This will print a list of active (non-complete) projects:

$ coffeecup-cli projects list
123      Project 1
124      Project 2
125      Project 3

Set Project Aliases

To be able to start new time entries from the command line, you need to set up project aliases. Use the Project IDs that you got from the coffeecup-cli projects list command.

coffeecup-cli projects alias 123 proj1

Run this to see your currently configured project aliases:

coffeecup-cli projects alias

Start a new time entry

Once you have aliases set up for your current project(s), you can start tracking your time like so:

coffeecup-cli start proj1

This will resume an existing time entry from today if there is one. It will stop any other running time entries. If there is no existing time entry it will start a new one.

You can add comments to your time entry like so:

coffeecup-cli start proj1 "Feature ABC"

Comments will be appended to any previous comment, so after running another start command like this:

coffeecup-cli start proj1 "Feature DEF"

you end up with a today like this:

$ coffeecup-cli today
proj1 | ⌛ 01h 22m | 📝 - Feature ABC - Feature DEF

Help

Run this to get general help

coffeecup-cli help

or add a specific command to get more detailed help:

coffeecup-cli help start

Usage tips

Add an alias for coffeecup-cli to your shell profile to make it easier to interact with Coffeecup. I aliased coffeecup-cli to cc and coffeecup-cli status --color to ccst for very convenient workflows:

Add this to your ~/.bashrc (or ~/.zshrc or similar):

alias cc='coffeecup-cli'
alias ccst='coffeecup-cli status -c'