UNPKG

workwatch

Version:

A Linux terminal program for honest worktime tracking and billing.

gitlab.com/l0cust/workwatch

48 lines (28 loc) • 1.96 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# WorkWatch WorkWatch is a Linux terminal program for honest worktime tracking and billing. It is a tool for help, not for enforcing anything. It is free software and is distributed under the terms of GNU General Public License. The program's name is a combination of "work" and "stopwatch" words. It really does like a stopwatch but measuring hours and minutes. ## Get Started It is pure JavaScript and Node.js application so you need npm to install. Install it globally for convenient use. ```sh $ npm install -g workwatch ``` It will install the program and create its data directory used for data files. If you are making an update the data directory shouldn't be harmed during procedure. To start your first measurement just type: ```sh $ workwatch start ``` After you finished your work just go to the program's screen and press <kbd>CTRL+C</kbd> to stop measurement. If you want it to be stored in your worklog type the following command: ```sh $ workwatch reset ``` Agree to store it and assign it a project or task you were working on. If you want to view the entire worklog type: ```sh $ workwatch log ``` The program measures time interactively. It measures hours and minutes taking every finished minute into account. You can stop and resume the measurement by pressing <kbd>CTRL+C</kbd> and then calling `workwatch start` again. You can make as many measurements as you can starting from 1-minute long ones up to 23:59 on the given day. You can't make measurements excessing that time. The program will automatically stop at 23:59 and you will be able to continue next day after reseting. ## Documentation For full program usage, see the [Users Guide](https://gitlab.com/l0cust/workwatch/-/blob/master/docs/index.md). For further program development and discussion see the project's issues. ## License Unlike many Node.js packages, I distribute WorkWatch and its documentation under the GNU GPL license version 3 or later.