blob: 1c7e0454d0fa77b4c34718e86a745c4967a911bf (
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
|
* Stitch - Note Composer
Stitch is a minimal grep-based CLI tool for composing and viewing notes and
TODO notes. It is built around the idea of writing notes separately and
then using tags to compose these notes together.
Stitch does not have any opinion about which file format you use for
file capturing, use org, markdown, whatever you want. You can also
customize the grep command to speed up performance.
** FEATURES
- Single binary
- Minimal & fast
- UNIXy
- Work with any file format
** CREDIT
Stitch is based on the note composing system Howm for Emacs.
** USAGE
Run ~stitch --help~ or ~man stitch~ for explanation and how to get started
** INSTALLATION
Chmod +x the binary and put in PATH.
** DEVELOPMENT
To set up the project, easiest way is to just install Nix, direnv and
enable nix flakes. Then to compile:
dune build
And to run:
dune exec -- stitch
To generate man pages, run
dune exec -- stitch --help=groff
* KNOWN ISSUES
- ugrep doesn't correctly handle ordering, meaning that if you sort by
modified date, it doesn't behave correctly. I've waited with implementing it until I've resolved that issue
- File names can not contain :[0-9]:, since it's used to determine where the file starts and ends.
One solution is to force one uniform file name that we can regexp (and also tweak). I am not sure yet what's
best.
* Author
Marc Coquand (https://mccd.space)
|