summaryrefslogtreecommitdiff
path: root/doc/src/04020-module-counter.md
blob: 29a819a8100830db141f5191ca824539ccd9d6c6 (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
## Counter {#sec:modules:counter}

The Counter module helps you counting things.

### Description

In its current state the counter module is capable of simple counting. You can
create, list and delete counters which are simply numbers and incremet,
decrement, set and reset them.

Future plans include counting functionality which is able to save date and
possibly timestamp of your increments/decrements, so you can export this and use
(for example) R to visualize this data.

Filters for selecting only certain time ranges when listing/exporting your
counters will be added as well.

### Examples

Here are some examples how to use the counter module:

```bash

imag counter create --name example --initval 42 # or: -n example -i 42
imag counter --inc example # or -i example
imag counter --reset example
imag counter --dec example # or -d example
```

### Backends

<!-- Backends the module supports including links to external resources -->