aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1a5521e3a60d2e8aead566c4c1f1ce791a4bc39d (plain)
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
# cassiopeia

A simple plaintext time-tracking tool.

## How to use

Cassiopeia works by associating account names with time-spans.
The format for this is generally `account: <start> - <stop>`.
A `<stop>` time can be omitted for open slots. Padding can be
added as desired.

`cass(1)` comes with a few commands

- `--start=` will start tracking for an account
- `--stop=` will stop tracking and error if no open slot exists

You always need to provide a file to work on with `-f` or `--file`.
Also optionally `-r` can be used to round to the nearest 15-minutes.
Line comments are available with `#`.

## State of the project

The project is very alpha and there are many things that should
be improved.

- Better CLI handling (`optparse` is kinda bad)
- Slot descriptors (to add details to what was worked on)
- Automatically pad generated slots
- Generate and export statistics

Contrutions welcome via my [public inbox][1]

[1]: https://lists.sr.ht/~spacekookie/public-inbox