An interactive CLI tool to calculate work time

Find a file

Marko Korhonen 5064cf92f9 Add installation instructions to README		2023-11-14 19:15:33 +02:00
bin	Add binary	2023-11-14 18:05:15 +02:00
src	Fix many issues in calculation and improve output formatting	2023-11-14 17:03:18 +02:00
.editorconfig	Initial commit	2023-11-11 15:13:20 +02:00
.eslintrc.json	Initial commit	2023-11-11 15:13:20 +02:00
.gitignore	Add markdown readme to npmjs	2023-11-14 18:42:06 +02:00
.prettierrc.json	Initial commit	2023-11-11 15:13:20 +02:00
LICENSE.adoc	Add license	2023-11-14 17:30:46 +02:00
Makefile	Add help to Makefile	2023-11-14 18:57:44 +02:00
package-lock.json	0.0.2	2023-11-14 18:37:07 +02:00
package.json	0.0.2	2023-11-14 18:37:07 +02:00
README.adoc	Add installation instructions to README	2023-11-14 19:15:33 +02:00
tsconfig.json	Initial commit	2023-11-11 15:13:20 +02:00

README.adoc

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