aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 73e7cb02771da15ec79423d3169adbfa9f8ed3f3 (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
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
# recit

personal productivity system backed by [recfiles](https://en.wikipedia.org/wiki/Recfiles)

# dependencies

* [recutils](https://www.gnu.org/software/recutils/) (`brew install recutils`)
* uuidgen (included with most systems)
* any perl (included with most systems)

# workflows

You can use `recit` to track things like:

* What needs to be done today?
* What did you do yesterday?
* What did you talk about in that 1:1 a few weeks ago?
* Where did you leave off on that project you started last year?
* What did you do last year?

# usage

    Usage: recit <command> [<args>]

    Some useful recit commands are:
    add-entry    Add entries, optionally for a project and/or a certain time
    add-project  Add Project
    commands     List all recit commands
    edit         Open DB in $EDITOR
    edit-entry   Edit an entry given its UUID
    entries      Display entries, optionally for a project and/or a certain time
    projects     List all Projects
    setup        sets up a new recit database at $HOME/.recit.rec
    today        Show all entries for today
    tomorrow     Show all entries for tomorrow

    See 'recit help <command>' for information on a specific command.

# installation

download the latest releas (or clone the repository) and follow the instructions displayed when running `bin/recit init`.

# getting started

`recit setup` gets you started

## add some entries

`recit add-entry` opens `$EDITOR` to let you add an entry at that moment in time, which is the same
as `recit add-entry now` or `recit add-entry today`. If the notes are short, you can just 
pass it as a 3rd argument, like `recit add-entry now "this is the entry"`

You can also add entries in the future by running `recit add-entry tomorrow` or any date like `recit add-entry 2022-07-22`.



## view entries

`recit today` or `recit tomorrow` (also `recit yesterday`)

## edit entries

you'll notice that `recit add-entry` returns a UUID, you can pass this UUID to `recit edit-entry` 
to edit the entry