stempel 0.10.1

Track the time you spent working
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# Stempel

[![Build](https://img.shields.io/github/workflow/status/KuabeM/stempel/build-master)](https://github.com/KuabeM/stempel/actions?query=workflow%3Abuild-master)
[![Crates.io](https://img.shields.io/crates/v/stempel.svg)](https://crates.io/crates/stempel)

Small utility to store and calculate the time spent at work.

> :warning: v0.10.0 introduces a new storage file format. Run `stempel migrate`
> to update your json database to the new format.

## Usage

Example for managing one day:

```bash
# start working now
stempel start
# start a break five minutes ago
stempel break start --offset 5m-
# optional: break can be canceled:
stempel cancel
# finish break in one hour (only if not canceled above)
stempel break stop --offset 1h+
# Finish the day
stempel stop
```

For a detailed reference, run `stempel help` or `stempel SUBCOMMAND --help`.
Available subcommands are:

  - `cancel`s the last break, start or does nothing if no break or start in the
    storage,
  - `break`: use `start` or `stop` as subcommand to handle breaks,
  - `migrate`: migrate storage file from old (before 0.10.0) to new format
    (since v0.10.0)
  - `start`: start a working period, aborts if you already started previously,
  - `stats` prints current statistics.
  - `stop`: checks if a `start` entry is in the storage `file` and calculates
    the working time, aborts if no `start` entry is found,

### Options:

#### `--offset`

This option allows to specify a positive or negative offset to the current time.
In other words, giving the option `--offset 10m+` means that the command is
executed with the current time plus 10 minutes, `20s-` stands for current time
minus 20 seconds. The syntax allows `([0-9]*)(h|m|s)(+|-)` where `h|m|s` refers
to hours, minutes and seconds, respectively.

#### `--storage`

Specifiy a path to the storage file where all work entries are written to. The
path defaults to `$HOME/.config/stempel.json` and is created on the first
invocation of the `start` subcommand.

## Features

  - Statistics:
    * [x] statistics of last two months grouped by weeks
    * [ ] allow printing only ranges of stats, e.g. months, years...
    * [ ] display long hours
  - [ ] Tracking: allow to specify start and stop time as cli arg
  - [x] Tracking: cancel started work
  - [x] Specify an offset from current time when starting or stopping
  - [ ] Add more possibilities to offset

## License

MIT