work-time-calculator/README.adoc

1.3 KiB

Work time calculator

An interactive CLI tool to calculate work time.

Install

You can run this in your terminal

npm i -g work-time-calculator

If you get a permission denied error, you can run the previous command with sudo (not recommended), or you can set a local prefix to npm. Feel free to create the prefix wherever you like, this is just a location I decided to use. The only requirement is that the location needs to be readable and writable by your user.

npm config set prefix '~/.local/share/npm'

After that you can run the installation again. Running the program requires that you have your npm prefix in your $PATH. You can find an example of this in my dotfiles. This configuration file is for ZSH but should also work for bash.

Rationale

This is a highly opinionated CLI tool I built for my specific needs. In time, I will probable make it more generic and configurable. For now, the following assumptions are made.

  • You have an unpaid 30 minute lunch break

TODO

  • ❏ Configuration file for default settings and altering behaviour in interactive mode

  • ❏ Non-interactive mode with CLI arguments parsing