dikt-cli 0.1.0__py3-none-macosx_11_0_arm64.whl

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.
Binary file
@@ -0,0 +1,149 @@
1
+ Metadata-Version: 2.4
2
+ Name: dikt-cli
3
+ Version: 0.1.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
+ It is a Rust port of the DIKT blueprint's Python implementation. The behaviour
27
+ and the blueprint's 47 regression scenarios are preserved (see
28
+ [Differences from the blueprint](#differences-from-the-blueprint)).
29
+
30
+ **→ Full guide: [docs/TUTORIAL.md](docs/TUTORIAL.md)**
31
+
32
+ ## Install into a project (uv)
33
+
34
+ Prebuilt wheels for Linux, macOS and Windows are attached to every
35
+ [GitHub release](https://github.com/dark-neonus/dikt/releases), so no Rust
36
+ toolchain is needed. Add the release as a pinned package source in your
37
+ project's `pyproject.toml`:
38
+
39
+ ```toml
40
+ [[tool.uv.index]]
41
+ name = "dikt"
42
+ url = "https://github.com/dark-neonus/dikt/releases/expanded_assets/v0.1.0"
43
+ format = "flat"
44
+ explicit = true
45
+
46
+ [tool.uv.sources]
47
+ dikt-cli = { index = "dikt" }
48
+ ```
49
+
50
+ ```sh
51
+ uv add --dev dikt-cli
52
+ uv run dikt init # create dikt/ + agent skills and instructions
53
+ uv run dikt add task --title "Try DIKT" --tag dikt
54
+ ```
55
+
56
+ > The Python distribution is **`dikt-cli`**. The PyPI package named `dikt` is
57
+ > an unrelated project, so don't `uv add dikt`. The installed command is `dikt`.
58
+
59
+ Other ways to install (details in the [tutorial](docs/TUTORIAL.md#install)):
60
+
61
+ - From source (needs Rust ≥ 1.88): `uv add --dev "dikt-cli @ git+https://github.com/dark-neonus/dikt"`
62
+ - As a global tool: `uv tool install dikt-cli --find-links https://github.com/dark-neonus/dikt/releases/expanded_assets/v0.1.0`
63
+ - As a standalone binary: download `dikt-<version>-<target>.tar.gz`/`.zip` from the releases page
64
+ - With Cargo: `cargo install --git https://github.com/dark-neonus/dikt`
65
+
66
+ `dikt init` writes `uv run dikt` into the generated docs when the binary lives
67
+ in the project's `.venv`, and plain `dikt` otherwise. Override with `--command`.
68
+
69
+ ### What `dikt init` creates
70
+
71
+ | Path | Owner | Purpose |
72
+ |---|---|---|
73
+ | `dikt/dikt.toml` | project | Collection marker used for discovery |
74
+ | `dikt/tags.yaml`, `Inbox.md`, `Scratch.md`, `procedures/*` | project | Starter data, never overwritten |
75
+ | `dikt/tasks/`, `ideas/`, `knowledge/`, `decisions/`, `reports/`, `context/`, `tools/`, `guides/`, `docs/` | project | Item storage and free-form resources |
76
+ | `dikt/README.md`, `STRUCTURE.md`, `AGENTS.md`, `CLAUDE.md`, `.gitignore` | dikt | Managed docs and full agent rules |
77
+ | `.claude/skills/dikt*/SKILL.md` | dikt | Claude Code skills (`--agents claude`) |
78
+ | `.github/skills/dikt*/SKILL.md`, `.github/prompts/dikt-*.prompt.md` | dikt | GitHub Copilot skills and prompts (`--agents copilot`) |
79
+ | Marked section in `AGENTS.md` / `CLAUDE.md` | dikt | Short pointer to the rules (`--agents agents-md`, `claude`) |
80
+
81
+ Running `init` again is safe: it creates anything that is missing and reports
82
+ what differs. `dikt init --refresh` (for example after upgrading dikt) rewrites
83
+ the managed files and the marked `<!-- dikt:start -->…<!-- dikt:end -->`
84
+ sections. It never touches items, reports, `tags.yaml`, procedures, Inbox or
85
+ Scratch. Text outside the marked sections of your `AGENTS.md`/`CLAUDE.md` is
86
+ always preserved.
87
+
88
+ ## Usage
89
+
90
+ ```sh
91
+ dikt add task --title "Fix export" --tag csv-export --priority 2 --due 2026-12-01
92
+ dikt list --query "export" --type task
93
+ dikt update T-00001 --status in_progress --add-check "Reproduce"
94
+ dikt log T-00001 "Reproduced with an empty file"
95
+ dikt close T-00001 --outcome "Fixed; regression test added"
96
+ dikt add knowledge --title "..." --source "Benchmark run 2026-11-20" --tag ...
97
+ dikt add decision --title "..." --tag ... --based-on K-00001 \
98
+ --context "..." --options "..." --decision "..." --consequences "..."
99
+ dikt report week
100
+ dikt validate
101
+ ```
102
+
103
+ The collection is found by walking up from the current directory and looking
104
+ for `dikt.toml` or `dikt/dikt.toml`. You can also pass `--root PATH` (before
105
+ the subcommand) or set `DIKT_ROOT`. The installed `dikt/README.md` has the full
106
+ command contract, lifecycle and tagging policy. `dikt <command> --help` lists
107
+ every option.
108
+
109
+ ## Development
110
+
111
+ ```sh
112
+ cargo test # unit + ported blueprint regression tests
113
+ cargo clippy --all-targets
114
+ uv build # binary wheel + sdist via maturin
115
+ ```
116
+
117
+ Releasing: bump `version` in `Cargo.toml`, commit, then tag and push
118
+ (`git tag v0.2.0 && git push origin v0.2.0`). The `Release` workflow runs the
119
+ tests, builds wheels (Linux glibc x86_64/aarch64, Linux musl x86_64, macOS
120
+ x86_64/arm64, Windows x86_64), an sdist and standalone binaries, and publishes them with
121
+ `SHA256SUMS` as a GitHub release. Then update the `v0.1.0` URLs in this
122
+ README and the tutorial.
123
+
124
+ Layout:
125
+
126
+ ```text
127
+ src/store.rs parsing, validation (hand-written schema), IDs, lifecycle, transactional writes
128
+ src/views.rs backlog, decision review flags, daily/weekly reports
129
+ src/cli.rs clap adapter, projection and filtering
130
+ src/init.rs project installer (templates embedded at compile time)
131
+ src/yaml.rs strict YAML loading and deterministic emitting
132
+ templates/ files installed by `dikt init` ({{DIKT}}, {{ROOT}}, {{UP}} placeholders)
133
+ tests/ ported blueprint tests (store, cli, views) + init tests
134
+ ```
135
+
136
+ Keep the core rules in `store`/`views` independent of the CLI adapter. Update
137
+ templates, tests and this README together.
138
+
139
+ ## Differences from the blueprint
140
+
141
+ - **Implementation:** Rust instead of Python. The JSON Schemas are hand-coded in `store::schema`, and `date-time` fields are actually checked as RFC 3339 (the Python build had no date-time format checker installed).
142
+ - **Packaging:** it installs into any project as a tool (`uv add`, `uv tool install`, `cargo install`) instead of being its own repository. Discovery uses `dikt.toml` instead of `[tool.pm]` in `pyproject.toml`.
143
+ - **New command:** `dikt init` installs the collection and the agent integrations: Claude Code, GitHub Copilot and AGENTS.md.
144
+ - **Renames:** the lock file is `.dikt-write.lock`, and report markers are `<!-- dikt:generated:start/end -->`. Skills are prefixed `dikt-` so they don't collide with the host project's own skills.
145
+ - **Single-line titles:** titles containing any newline are rejected. Python's `$` accepted a single trailing newline.
146
+ - **Starter tags:** `tags.yaml` starts with a small generic vocabulary instead of DIKT-specific tags.
147
+
148
+ The known boundaries are unchanged. Search is ordered by ID with no ranking. Multi-file writes roll back on ordinary failures but are not crash-atomic. The lock serializes local writers only. There is no delete or migration command.
149
+
@@ -0,0 +1,5 @@
1
+ dikt_cli-0.1.0.data/scripts/dikt,sha256=-W99TYRlCnad_PWhCcDWJaMBDdToXNE2oszRT9uss7Y,2603728
2
+ dikt_cli-0.1.0.dist-info/METADATA,sha256=GI_G9oS009As4-H31zPbcc381FxnDjY6i2xMAX6aIc0,7511
3
+ dikt_cli-0.1.0.dist-info/WHEEL,sha256=Fvrs5zUKO4nQbE5Fttn9y8loVOWxn3I3-bRdoW2U0nw,102
4
+ dikt_cli-0.1.0.dist-info/sboms/dikt.cyclonedx.json,sha256=9Nq-tS9XseDUro4dwA_jLCue4nTIv-is3839NAK5jKQ,59039
5
+ dikt_cli-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.16.0)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-macosx_11_0_arm64