kfatehi / dotclock

command-line oriented multi-project git-aware work timer for one or more people
2 stars 0 forks source link

dotclock

command-line oriented multi-project work timer for one or more people

creates, manages, and maintains time entries in json files (your username being the filename) in a special subdirectory .clock in any directory in which you dotclock in

your identity is maintained by whatever output is gained from querying the current user (e.g. process.env.USER)

Install

install globally with npm -g install dotclock

dotclock provides an executable dotclock

running dotclock by itself is a shortcut for dotclock status

Commands

dotclock status: display current state (clocked in or not, for how long, etc)

dotclock in: clock in

dotclock note: add a note to the current session

dotclock out: clock out

dotclock export: print session details.

dotclock export --git: print all sessions without granular commits (see --granular) but then print all commits made since the start of the first session until the end of the last session

dotclock export --git --granular: print all sessions and include all commits made during the timespan of each session

Gitignore

You may want to add .clock to your global gitignore. e.g.:

echo ".clock" > ~/.gitignore_global
git config --global core.excludesfile ~/.gitignore_global