dikt-cli 0.1.0__tar.gz → 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/Cargo.lock +72 -1
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/Cargo.toml +2 -1
- dikt_cli-0.2.0/PKG-INFO +327 -0
- dikt_cli-0.2.0/README.md +312 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/docs/TUTORIAL.md +165 -116
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/cli.rs +26 -5
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/store.rs +153 -16
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/views.rs +12 -4
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/AGENTS.md +2 -1
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/README.md +16 -5
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/STRUCTURE.md +3 -2
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/root-block.md +1 -1
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/skills/dikt.md +3 -2
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/tests/cli.rs +15 -12
- dikt_cli-0.2.0/tests/collaboration.rs +347 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/tests/init.rs +5 -1
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/tests/store.rs +3 -3
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/tests/views.rs +2 -2
- dikt_cli-0.1.0/PKG-INFO +0 -149
- dikt_cli-0.1.0/README.md +0 -134
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/pyproject.toml +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/error.rs +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/init.rs +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/lib.rs +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/main.rs +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/src/yaml.rs +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/CLAUDE.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/Inbox.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/Scratch.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/dikt.toml +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/gitignore +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/procedures/triage-inbox.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/procedures/weekly-review.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/collection/tags.yaml +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/prompts/triage-inbox.prompt.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/prompts/weekly-review.prompt.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/skills/triage-inbox.md +0 -0
- {dikt_cli-0.1.0 → dikt_cli-0.2.0}/templates/skills/weekly-review.md +0 -0
|
@@ -82,6 +82,15 @@ version = "2.13.2"
|
|
|
82
82
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
83
83
|
checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
|
|
84
84
|
|
|
85
|
+
[[package]]
|
|
86
|
+
name = "block-buffer"
|
|
87
|
+
version = "0.12.1"
|
|
88
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
89
|
+
checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa"
|
|
90
|
+
dependencies = [
|
|
91
|
+
"hybrid-array",
|
|
92
|
+
]
|
|
93
|
+
|
|
85
94
|
[[package]]
|
|
86
95
|
name = "bumpalo"
|
|
87
96
|
version = "3.20.4"
|
|
@@ -163,15 +172,50 @@ version = "1.0.5"
|
|
|
163
172
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
164
173
|
checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
|
|
165
174
|
|
|
175
|
+
[[package]]
|
|
176
|
+
name = "const-oid"
|
|
177
|
+
version = "0.10.3"
|
|
178
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
179
|
+
checksum = "be95d4a884358a21a199689323c29e9256b4a1b315e22f183d155422041d3a9a"
|
|
180
|
+
|
|
166
181
|
[[package]]
|
|
167
182
|
name = "core-foundation-sys"
|
|
168
183
|
version = "0.8.7"
|
|
169
184
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
170
185
|
checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b"
|
|
171
186
|
|
|
187
|
+
[[package]]
|
|
188
|
+
name = "cpufeatures"
|
|
189
|
+
version = "0.3.1"
|
|
190
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
191
|
+
checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566"
|
|
192
|
+
dependencies = [
|
|
193
|
+
"libc",
|
|
194
|
+
]
|
|
195
|
+
|
|
196
|
+
[[package]]
|
|
197
|
+
name = "crypto-common"
|
|
198
|
+
version = "0.2.2"
|
|
199
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
200
|
+
checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453"
|
|
201
|
+
dependencies = [
|
|
202
|
+
"hybrid-array",
|
|
203
|
+
]
|
|
204
|
+
|
|
205
|
+
[[package]]
|
|
206
|
+
name = "digest"
|
|
207
|
+
version = "0.11.3"
|
|
208
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
209
|
+
checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2"
|
|
210
|
+
dependencies = [
|
|
211
|
+
"block-buffer",
|
|
212
|
+
"const-oid",
|
|
213
|
+
"crypto-common",
|
|
214
|
+
]
|
|
215
|
+
|
|
172
216
|
[[package]]
|
|
173
217
|
name = "dikt"
|
|
174
|
-
version = "0.
|
|
218
|
+
version = "0.2.0"
|
|
175
219
|
dependencies = [
|
|
176
220
|
"chrono",
|
|
177
221
|
"clap",
|
|
@@ -181,6 +225,7 @@ dependencies = [
|
|
|
181
225
|
"serde",
|
|
182
226
|
"serde_json",
|
|
183
227
|
"serde_norway",
|
|
228
|
+
"sha2",
|
|
184
229
|
"tempfile",
|
|
185
230
|
"unicode-normalization",
|
|
186
231
|
]
|
|
@@ -272,6 +317,15 @@ version = "0.5.0"
|
|
|
272
317
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
273
318
|
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
|
274
319
|
|
|
320
|
+
[[package]]
|
|
321
|
+
name = "hybrid-array"
|
|
322
|
+
version = "0.4.15"
|
|
323
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
324
|
+
checksum = "27f864f10dfb56725ce5ce5472bc52252c8f93a4ab86327122cebf62c5f59a17"
|
|
325
|
+
dependencies = [
|
|
326
|
+
"typenum",
|
|
327
|
+
]
|
|
328
|
+
|
|
275
329
|
[[package]]
|
|
276
330
|
name = "iana-time-zone"
|
|
277
331
|
version = "0.1.65"
|
|
@@ -516,6 +570,17 @@ dependencies = [
|
|
|
516
570
|
"unsafe-libyaml-norway",
|
|
517
571
|
]
|
|
518
572
|
|
|
573
|
+
[[package]]
|
|
574
|
+
name = "sha2"
|
|
575
|
+
version = "0.11.1"
|
|
576
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
577
|
+
checksum = "47d7069beb7d6ac7b9acd1039986e73443f24234f41074da099d6f994ac9ad19"
|
|
578
|
+
dependencies = [
|
|
579
|
+
"cfg-if",
|
|
580
|
+
"cpufeatures",
|
|
581
|
+
"digest",
|
|
582
|
+
]
|
|
583
|
+
|
|
519
584
|
[[package]]
|
|
520
585
|
name = "shlex"
|
|
521
586
|
version = "2.0.1"
|
|
@@ -575,6 +640,12 @@ version = "1.13.3"
|
|
|
575
640
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
576
641
|
checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee"
|
|
577
642
|
|
|
643
|
+
[[package]]
|
|
644
|
+
name = "typenum"
|
|
645
|
+
version = "1.20.1"
|
|
646
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
647
|
+
checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
|
|
648
|
+
|
|
578
649
|
[[package]]
|
|
579
650
|
name = "unicode-ident"
|
|
580
651
|
version = "1.0.27"
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[package]
|
|
2
2
|
name = "dikt"
|
|
3
|
-
version = "0.
|
|
3
|
+
version = "0.2.0"
|
|
4
4
|
edition = "2024"
|
|
5
5
|
rust-version = "1.88"
|
|
6
6
|
description = "Decisions, ideas, knowledge and tasks as validated local Markdown, for people and AI agents"
|
|
@@ -21,6 +21,7 @@ regex = "1.13.2"
|
|
|
21
21
|
serde = { version = "1.0.229", features = ["derive"] }
|
|
22
22
|
serde_json = { version = "1.0.154", features = ["preserve_order"] }
|
|
23
23
|
serde_norway = "0.9.42"
|
|
24
|
+
sha2 = "0.11.1"
|
|
24
25
|
tempfile = "3.27.0"
|
|
25
26
|
unicode-normalization = "0.1.26"
|
|
26
27
|
|
dikt_cli-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,327 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dikt-cli
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Classifier: Programming Language :: Rust
|
|
5
|
+
Classifier: Environment :: Console
|
|
6
|
+
Classifier: Topic :: Office/Business
|
|
7
|
+
Summary: Decisions, ideas, knowledge and tasks as validated local Markdown, for people and AI agents
|
|
8
|
+
Keywords: knowledge-management,tasks,decisions,ai-agents,cli
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
11
|
+
Project-URL: Documentation, https://github.com/dark-neonus/dikt/blob/main/docs/TUTORIAL.md
|
|
12
|
+
Project-URL: Homepage, https://github.com/dark-neonus/dikt
|
|
13
|
+
Project-URL: Issues, https://github.com/dark-neonus/dikt/issues
|
|
14
|
+
|
|
15
|
+
# dikt
|
|
16
|
+
|
|
17
|
+
**D**ecisions, **i**deas, **k**nowledge and **t**asks as validated local Markdown,
|
|
18
|
+
built for people and AI agents working inside a project.
|
|
19
|
+
|
|
20
|
+
`dikt` is a single Rust binary. It stores items as Markdown files with YAML
|
|
21
|
+
frontmatter, validates every write (schemas, tags, references, lifecycle
|
|
22
|
+
rules), and generates backlogs and daily/weekly activity reports. Agents get
|
|
23
|
+
skills and instructions that tell them to retrieve before reasoning and to
|
|
24
|
+
preserve only verified, reusable results.
|
|
25
|
+
|
|
26
|
+
Highlights:
|
|
27
|
+
|
|
28
|
+
- **Safe writes.** Every change is validated, and invalid writes touch nothing.
|
|
29
|
+
- **Team-friendly IDs.** Items get hash IDs (`T-3f9a1c2e`) and record their author, so branches that each add items [merge without conflicts](#working-in-a-team).
|
|
30
|
+
- **Agent-ready.** `dikt init` installs skills and instructions for Claude Code, GitHub Copilot and `AGENTS.md` readers. See the [recorded example](#example-two-agent-chats).
|
|
31
|
+
|
|
32
|
+
**→ Full guide: [docs/TUTORIAL.md](docs/TUTORIAL.md)**
|
|
33
|
+
|
|
34
|
+
## Install into a project (uv)
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
uv add --dev dikt-cli
|
|
38
|
+
uv run dikt init # create dikt/ + agent skills and instructions
|
|
39
|
+
uv run dikt add task --title "Try DIKT" --tag dikt
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[`dikt-cli`](https://pypi.org/project/dikt-cli/) ships prebuilt binaries for
|
|
43
|
+
Linux, macOS and Windows, so no Rust toolchain is needed.
|
|
44
|
+
|
|
45
|
+
> Install **`dikt-cli`**; the installed command is `dikt`. The PyPI package
|
|
46
|
+
> named `dikt` is an unrelated project, so don't `uv add dikt`.
|
|
47
|
+
|
|
48
|
+
Other ways to install (details in the [tutorial](docs/TUTORIAL.md#install)):
|
|
49
|
+
|
|
50
|
+
- As a global tool: `uv tool install dikt-cli`
|
|
51
|
+
- Without installing: `uvx --from dikt-cli dikt --help`
|
|
52
|
+
- As a standalone binary: download `dikt-<version>-<target>.tar.gz`/`.zip` from the [releases page](https://github.com/dark-neonus/dikt/releases)
|
|
53
|
+
- From source (needs Rust ≥ 1.88): `uv add --dev "dikt-cli @ git+https://github.com/dark-neonus/dikt"` or `cargo install --git https://github.com/dark-neonus/dikt`
|
|
54
|
+
|
|
55
|
+
`dikt init` writes `uv run dikt` into the generated docs when the binary lives
|
|
56
|
+
in the project's `.venv`, and plain `dikt` otherwise. Override with `--command`.
|
|
57
|
+
|
|
58
|
+
### What `dikt init` creates
|
|
59
|
+
|
|
60
|
+
| Path | Owner | Purpose |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| `dikt/dikt.toml` | project | Collection marker used for discovery |
|
|
63
|
+
| `dikt/tags.yaml`, `Inbox.md`, `Scratch.md`, `procedures/*` | project | Starter data, never overwritten |
|
|
64
|
+
| `dikt/tasks/`, `ideas/`, `knowledge/`, `decisions/`, `reports/`, `context/`, `tools/`, `guides/`, `docs/` | project | Item storage and free-form resources |
|
|
65
|
+
| `dikt/README.md`, `STRUCTURE.md`, `AGENTS.md`, `CLAUDE.md`, `.gitignore` | dikt | Managed docs and full agent rules |
|
|
66
|
+
| `.claude/skills/dikt*/SKILL.md` | dikt | Claude Code skills (`--agents claude`) |
|
|
67
|
+
| `.github/skills/dikt*/SKILL.md`, `.github/prompts/dikt-*.prompt.md` | dikt | GitHub Copilot skills and prompts (`--agents copilot`) |
|
|
68
|
+
| Marked section in `AGENTS.md` / `CLAUDE.md` | dikt | Short pointer to the rules (`--agents agents-md`, `claude`) |
|
|
69
|
+
|
|
70
|
+
Running `init` again is safe: it creates anything that is missing and reports
|
|
71
|
+
what differs. `dikt init --refresh` (for example after upgrading dikt) rewrites
|
|
72
|
+
the managed files and the marked `<!-- dikt:start -->…<!-- dikt:end -->`
|
|
73
|
+
sections. It never touches items, reports, `tags.yaml`, procedures, Inbox or
|
|
74
|
+
Scratch. Text outside the marked sections of your `AGENTS.md`/`CLAUDE.md` is
|
|
75
|
+
always preserved.
|
|
76
|
+
|
|
77
|
+
## Usage
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
dikt add task --title "Fix export" --tag csv-export --priority 2 --due 2026-12-01
|
|
81
|
+
dikt list --query "export" --type task
|
|
82
|
+
dikt update T-3f9a1c2e --status in_progress --add-check "Reproduce"
|
|
83
|
+
dikt log T-3f9a1c2e "Reproduced with an empty file"
|
|
84
|
+
dikt close T-3f9a1c2e --outcome "Fixed; regression test added"
|
|
85
|
+
dikt add knowledge --title "..." --source "Benchmark run 2026-11-20" --tag ...
|
|
86
|
+
dikt add decision --title "..." --tag ... --based-on K-7d21b0a4 \
|
|
87
|
+
--context "..." --options "..." --decision "..." --consequences "..."
|
|
88
|
+
dikt report week
|
|
89
|
+
dikt validate
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
`add` prints the new item's ID (here `T-3f9a1c2e` is only an example); use the ID it
|
|
93
|
+
returns. `dikt list` shows the oldest items first.
|
|
94
|
+
|
|
95
|
+
The collection is found by walking up from the current directory and looking
|
|
96
|
+
for `dikt.toml` or `dikt/dikt.toml`. You can also pass `--root PATH` (before
|
|
97
|
+
the subcommand) or set `DIKT_ROOT`. The installed `dikt/README.md` has the full
|
|
98
|
+
command contract, lifecycle and tagging policy. `dikt <command> --help` lists
|
|
99
|
+
every option.
|
|
100
|
+
|
|
101
|
+
## Example: two agent chats
|
|
102
|
+
|
|
103
|
+
This is a real, unedited recording of two separate Claude Code sessions
|
|
104
|
+
(Claude Sonnet 5.5, started with `claude -p`) in a fresh project where dikt 0.2.0
|
|
105
|
+
was installed (a local build) and `uv run dikt init` had been run. Nothing else was set up: the
|
|
106
|
+
agent found the `dikt` skill and the project instructions by itself. The
|
|
107
|
+
sessions could run `dikt`, read files and edit them, and use a few read-only
|
|
108
|
+
shell commands. The subject is a cat.
|
|
109
|
+
|
|
110
|
+
### Chat 1: saving things
|
|
111
|
+
|
|
112
|
+
Prompt:
|
|
113
|
+
|
|
114
|
+
```text
|
|
115
|
+
I am owner of cat.
|
|
116
|
+
|
|
117
|
+
I have next tasks: feed him this evening, go buy him new toy tommorow
|
|
118
|
+
|
|
119
|
+
I have an idea of finding him a friend
|
|
120
|
+
|
|
121
|
+
After a few playtimes with him I get to know that my cat like pink color, this knowledge can be used when buying him stuff
|
|
122
|
+
|
|
123
|
+
Also I decided to move his bowl with food to kitchen because in living room it made mess
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Response:
|
|
127
|
+
|
|
128
|
+
> I searched the project records first and found nothing on your cat, so I saved everything as new records. `uv run dikt validate` passes.
|
|
129
|
+
>
|
|
130
|
+
> | ID | Type | Content |
|
|
131
|
+
> |---|---|---|
|
|
132
|
+
> | T-431db8c8 | Task | Feed the cat this evening (due 2026-11-20) |
|
|
133
|
+
> | T-e7e9a721 | Task | Buy the cat a new toy, preferably pink (due 2026-11-21) |
|
|
134
|
+
> | I-fded8849 | Idea | Find the cat a friend |
|
|
135
|
+
> | K-b9329026 | Knowledge | The cat likes pink, from your playtime observations. I marked it informal, not rigorously verified. |
|
|
136
|
+
> | D-524ab929 | Decision | Move the food bowl to the kitchen, because the living room got messy |
|
|
137
|
+
>
|
|
138
|
+
> I saved the bowl decision as accepted because you said you decided it. I also registered six new tags in `dikt/tags.yaml`: `cat`, `cat-feeding`, `cat-toys`, `cat-food-bowl`, `cat-companion` and `pink`.
|
|
139
|
+
>
|
|
140
|
+
> Nothing is committed. If you want a commit, I can make one.
|
|
141
|
+
|
|
142
|
+
What ended up on disk (`uv run dikt list`; oldest first):
|
|
143
|
+
|
|
144
|
+
```text
|
|
145
|
+
T-431db8c8 [todo] Feed the cat this evening
|
|
146
|
+
T-e7e9a721 [todo] Buy the cat a new toy
|
|
147
|
+
I-fded8849 [open] Find the cat a friend
|
|
148
|
+
K-b9329026 [active] Cat likes the color pink
|
|
149
|
+
D-524ab929 [accepted] Move the cat's food bowl to the kitchen
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
The decision, as the agent stored it (`uv run dikt get D-524ab929 --full`):
|
|
153
|
+
|
|
154
|
+
```markdown
|
|
155
|
+
---
|
|
156
|
+
schema_version: 1
|
|
157
|
+
id: D-524ab929
|
|
158
|
+
type: decision
|
|
159
|
+
title: Move the cat's food bowl to the kitchen
|
|
160
|
+
author: Alex Morgan
|
|
161
|
+
tags:
|
|
162
|
+
- cat
|
|
163
|
+
- cat-food-bowl
|
|
164
|
+
- cat-feeding
|
|
165
|
+
created: "2026-11-20T13:50:03.486248+02:00"
|
|
166
|
+
updated: "2026-11-20T13:50:03.486248+02:00"
|
|
167
|
+
links:
|
|
168
|
+
jira: []
|
|
169
|
+
mr: []
|
|
170
|
+
commits: []
|
|
171
|
+
confluence: []
|
|
172
|
+
items: []
|
|
173
|
+
status: accepted
|
|
174
|
+
decided: "2026-11-20"
|
|
175
|
+
revisit: null
|
|
176
|
+
revisit_when: The kitchen location causes problems for the cat or the household
|
|
177
|
+
based_on: []
|
|
178
|
+
supersedes: []
|
|
179
|
+
superseded_by: null
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## Description
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
## Context
|
|
186
|
+
The cat's food bowl was in the living room, where eating made a mess.
|
|
187
|
+
|
|
188
|
+
## Options
|
|
189
|
+
Keep the bowl in the living room; move it to the kitchen.
|
|
190
|
+
|
|
191
|
+
## Decision
|
|
192
|
+
Move the cat's food bowl to the kitchen.
|
|
193
|
+
|
|
194
|
+
## Consequences
|
|
195
|
+
Less mess in the living room. The cat must be fed in the kitchen from now on.
|
|
196
|
+
|
|
197
|
+
## Log
|
|
198
|
+
- 2026-11-20T13:50:03.486295+02:00 [created] Move the cat's food bowl to the kitchen
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Chat 2: using what was saved
|
|
202
|
+
|
|
203
|
+
A new chat, with no memory of chat 1. Prompt:
|
|
204
|
+
|
|
205
|
+
```text
|
|
206
|
+
Hello, I want buy my cat a toy, what would you suggest? Why?
|
|
207
|
+
|
|
208
|
+
Also I have found my cats bowl in kitchen, butI remember that it was in my living room, do you have any idea why is it there?
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Response:
|
|
212
|
+
|
|
213
|
+
> **The bowl:** You moved it yourself. Your project records have an accepted decision, D-524ab929, dated today (2026-11-20). It says to move the cat's food bowl from the living room to the kitchen, because eating in the living room made a mess. So the kitchen is now the bowl's permanent spot. Feed the cat there from now on. The decision says to revisit it if the kitchen causes problems for the cat or the household.
|
|
214
|
+
>
|
|
215
|
+
> **The toy:** Your records already have a task for this, T-e7e9a721, due tomorrow (2026-11-21). It says to prefer pink, because you noticed the cat seems to like that color (K-b9329026). That's an informal observation, not a verified one.
|
|
216
|
+
>
|
|
217
|
+
> I'd suggest a **pink feather wand or a pink crinkle ball**, for these reasons:
|
|
218
|
+
> - **Feather wand:** It gets you playing with the cat. That gives the cat exercise and bonding time, and you're already watching what it responds to during playtimes. It also satisfies the pink preference.
|
|
219
|
+
> - **Crinkle ball or small plush mouse:** It's cheap and light, and the cat can bat it around alone. That helps on days you aren't around.
|
|
220
|
+
> - **Pink as a tiebreaker only:** Cats see color much less vividly than people do, so pink may not be what draws the cat in. Motion, sound and texture matter more. I'd choose by how the toy moves, then pick pink within that.
|
|
221
|
+
>
|
|
222
|
+
> You could also buy two cheap toys and see which one the cat prefers. The result would be a useful note for the records.
|
|
223
|
+
>
|
|
224
|
+
> I haven't changed anything in the records. Once you've bought the toy, I can mark the task done and log which toy and how the cat reacted.
|
|
225
|
+
|
|
226
|
+
The agent searched DIKT before answering, found the bowl decision and the toy
|
|
227
|
+
task, and cited them by ID. It also treated the pink preference as an informal
|
|
228
|
+
observation rather than a fact, because that is how it was recorded. It wrote
|
|
229
|
+
nothing: every item's `created` and `updated` timestamps are still identical.
|
|
230
|
+
|
|
231
|
+
**How reliable is the search?** The agent decides whether to look. With the
|
|
232
|
+
first wording of the instructions, 2 of 6 repeats of chat 2 searched DIKT and
|
|
233
|
+
the rest answered generically. After the instructions were changed to say that
|
|
234
|
+
everyday questions count too ("Search before you answer"), 6 of 6 repeats
|
|
235
|
+
searched. The final recording above was made with that wording. Check your own
|
|
236
|
+
setup with a fresh chat (see the [tutorial](docs/TUTORIAL.md#12-working-with-ai-agents)).
|
|
237
|
+
|
|
238
|
+
You can repeat this yourself (needs dikt 0.2.0 or newer):
|
|
239
|
+
|
|
240
|
+
```sh
|
|
241
|
+
mkdir cat-owner && cd cat-owner && git init && uv init --python 3.14
|
|
242
|
+
uv add --dev dikt-cli && uv run dikt init
|
|
243
|
+
claude # then paste the chat 1 prompt, start a new chat, paste the chat 2 prompt
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## Working in a team
|
|
247
|
+
|
|
248
|
+
Item IDs are short hashes of the type, title, first ten tags, creation time
|
|
249
|
+
and author. Two people who each add an item on their own branch therefore get
|
|
250
|
+
different IDs and different files, and Git merges the branches cleanly. Here
|
|
251
|
+
both Ada and Grace added a task titled "Update the README" on separate clones,
|
|
252
|
+
then Grace pulled. First with dikt 0.1.0 (sequential IDs):
|
|
253
|
+
|
|
254
|
+
```console
|
|
255
|
+
$ git pull --no-rebase
|
|
256
|
+
Auto-merging dikt/tasks/T-00001-update-the-readme.md
|
|
257
|
+
CONFLICT (add/add): Merge conflict in dikt/tasks/T-00001-update-the-readme.md
|
|
258
|
+
Automatic merge failed; fix conflicts and then commit the result.
|
|
259
|
+
$ dikt validate
|
|
260
|
+
Error: Invalid YAML: could not find expected ':' at line 8 column 1, while scanning a simple key at line 7 column 1
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
And with the current version:
|
|
264
|
+
|
|
265
|
+
```console
|
|
266
|
+
$ git pull --no-rebase
|
|
267
|
+
Merge made by the 'ort' strategy.
|
|
268
|
+
dikt/tasks/T-9c7055c3-update-the-readme.md | 29 +++++++++++++++++++++++++++++
|
|
269
|
+
1 file changed, 29 insertions(+)
|
|
270
|
+
$ dikt validate
|
|
271
|
+
Valid: 2 items
|
|
272
|
+
$ dikt list
|
|
273
|
+
T-9c7055c3 [todo] Update the README
|
|
274
|
+
T-c7a4b990 [todo] Update the README
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
Every new item records its `author` (`--author`, else `$DIKT_AUTHOR`, else
|
|
278
|
+
`git config user.name`), and `dikt list --author "Ada"` filters by it. IDs from
|
|
279
|
+
0.1.0 stay valid. Two people editing the *same* item, adding tags at the same
|
|
280
|
+
spot in `tags.yaml`, or generating the same day's report can still conflict in
|
|
281
|
+
Git; see [Git and teams](docs/TUTORIAL.md#14-git-and-teams).
|
|
282
|
+
|
|
283
|
+
## Development
|
|
284
|
+
|
|
285
|
+
```sh
|
|
286
|
+
cargo test # unit and integration tests
|
|
287
|
+
cargo clippy --all-targets
|
|
288
|
+
uv build # binary wheel + sdist via maturin
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
Releasing: bump `version` in `Cargo.toml`, commit, then tag and push
|
|
292
|
+
(`git tag v0.2.0 && git push origin v0.2.0`). The `Release` workflow runs the
|
|
293
|
+
tests, builds wheels (Linux glibc x86_64/aarch64, Linux musl x86_64, macOS
|
|
294
|
+
x86_64/arm64, Windows x86_64), an sdist and standalone binaries, and publishes them with
|
|
295
|
+
`SHA256SUMS` as a GitHub release, then uploads the wheels and sdist to PyPI
|
|
296
|
+
as `dikt-cli`.
|
|
297
|
+
|
|
298
|
+
PyPI upload uses [trusted publishing](https://docs.pypi.org/trusted-publishers/)
|
|
299
|
+
(no API token). One-time setup on pypi.org → *Your account → Publishing →
|
|
300
|
+
Add a new pending publisher*: PyPI project `dikt-cli`, owner `dark-neonus`,
|
|
301
|
+
repository `dikt`, workflow `release.yml`, environment `pypi`. To upload an
|
|
302
|
+
already-built release, run *Actions → Release → Run workflow* with its tag.
|
|
303
|
+
|
|
304
|
+
Layout:
|
|
305
|
+
|
|
306
|
+
```text
|
|
307
|
+
src/store.rs parsing, validation (hand-written schema), IDs, lifecycle, transactional writes
|
|
308
|
+
src/views.rs backlog, decision review flags, daily/weekly reports
|
|
309
|
+
src/cli.rs clap adapter, projection and filtering
|
|
310
|
+
src/init.rs project installer (templates embedded at compile time)
|
|
311
|
+
src/yaml.rs strict YAML loading and deterministic emitting
|
|
312
|
+
templates/ files installed by `dikt init` ({{DIKT}}, {{ROOT}}, {{UP}} placeholders)
|
|
313
|
+
tests/ store, cli, views, collaboration and init tests
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
Keep the core rules in `store`/`views` independent of the CLI adapter. Update
|
|
317
|
+
templates, tests and this README together.
|
|
318
|
+
|
|
319
|
+
## Limits
|
|
320
|
+
|
|
321
|
+
- Search is substring matching, listed oldest first. There is no ranking or index.
|
|
322
|
+
- Multi-file writes roll back on ordinary failures but are not crash-atomic.
|
|
323
|
+
- The write lock serializes writers on one machine only, not separate clones.
|
|
324
|
+
- There is no delete command and no schema migration command.
|
|
325
|
+
- Tags must be registered by editing `tags.yaml`; there is no tag command yet.
|
|
326
|
+
- Whether an agent searches DIKT or follows the saving rules is up to the agent. The instructions make it likely, and a fresh-chat check confirms it for your setup.
|
|
327
|
+
|