ai-wiki-toolkit-linux-arm64 0.1.16
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.
- package/LICENSE +21 -0
- package/README.md +427 -0
- package/bin/aiwiki-toolkit +0 -0
- package/package.json +29 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Bocheng Yin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,427 @@
|
|
|
1
|
+
# ai-wiki-toolkit-linux-arm64
|
|
2
|
+
|
|
3
|
+
This package contains the `aiwiki-toolkit` executable for `linux-arm64-glibc`.
|
|
4
|
+
It is published as the platform-specific binary package for `ai-wiki-toolkit` `0.1.16`.
|
|
5
|
+
Most users should install `ai-wiki-toolkit` instead of using this package directly.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Below is the current root project README:
|
|
10
|
+
|
|
11
|
+
# ai-wiki-toolkit
|
|
12
|
+
|
|
13
|
+
**Agents keep repeating the same trial-and-error loops — across tasks, across developers, and across agents.**
|
|
14
|
+
|
|
15
|
+
What they need is not more prompts.
|
|
16
|
+
They need a **memory harness**.
|
|
17
|
+
|
|
18
|
+
`ai-wiki-toolkit` is a **repository-native agent memory harness** for coding workflows.
|
|
19
|
+
|
|
20
|
+
It provides a persistent, structured memory layer inside the repo,
|
|
21
|
+
along with a workflow that lets agents continuously write back what they learn.
|
|
22
|
+
|
|
23
|
+
It is inspired by Andrej Karpathy's LLM Wiki idea: a persistent Markdown knowledge base that an agent can keep organized over time instead of rediscovering from scratch on every task.
|
|
24
|
+
|
|
25
|
+
Reference inspiration:
|
|
26
|
+
|
|
27
|
+
- Karpathy's X post: https://x.com/karpathy/status/2039805659525644595
|
|
28
|
+
- Karpathy's gist: https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f
|
|
29
|
+
|
|
30
|
+
## The Problem
|
|
31
|
+
|
|
32
|
+
Teams doing vibe coding usually hit the same problems:
|
|
33
|
+
|
|
34
|
+
- durable project knowledge ends up scattered across chats, review comments, and individual memory
|
|
35
|
+
- agents have to relearn repo conventions, past mistakes, and operating rules over and over
|
|
36
|
+
- raw file uploads or ad hoc RAG help answer one question, but they do not leave behind a maintained project memory
|
|
37
|
+
- shared instruction files are easy to drift or overwrite when multiple people and multiple agents touch them
|
|
38
|
+
|
|
39
|
+
The result is that useful knowledge exists, but it does not compound.
|
|
40
|
+
|
|
41
|
+
## The Flywheel
|
|
42
|
+
|
|
43
|
+
The point of an AI wiki is not just to answer one more question today. It is to create a compounding loop where each completed task can leave behind better repo context for the next one.
|
|
44
|
+
|
|
45
|
+
As you accumulate more constraints, workflows, decisions, review patterns, and draft notes, the agent starts each task with a better prior. Over time it becomes more familiar with your repository, your development habits, and the kinds of mistakes you want to avoid. That usually means less re-explaining, fewer repeated errors, and noticeably faster execution.
|
|
46
|
+
|
|
47
|
+
## What This Tool Does
|
|
48
|
+
|
|
49
|
+
`ai-wiki-toolkit` applies a harness engineering approach to agent work: make the repo memory, prompt wiring, and reusable workflow checks explicit enough that agents can reliably follow them without rediscovering them from scratch.
|
|
50
|
+
|
|
51
|
+
Instead of trying to solve the problem with a server, embeddings, or hidden state, it turns the harness itself into repo-visible artifacts:
|
|
52
|
+
|
|
53
|
+
- repo-local AI wiki files
|
|
54
|
+
- home-level cross-project AI wiki files
|
|
55
|
+
- managed prompt blocks
|
|
56
|
+
- repo-local Codex skills for repeatable end-of-task reuse and update checks
|
|
57
|
+
|
|
58
|
+
That gives the repo and the user a stable Markdown place to accumulate knowledge without turning the package into a knowledge platform.
|
|
59
|
+
|
|
60
|
+
For small teams, the AI wiki is also a shared coding-memory layer.
|
|
61
|
+
|
|
62
|
+
It helps agents reuse:
|
|
63
|
+
|
|
64
|
+
- team conventions
|
|
65
|
+
- PR review learnings
|
|
66
|
+
- feature clarifications
|
|
67
|
+
- durable decisions
|
|
68
|
+
- past debugging solutions
|
|
69
|
+
- personal draft observations that may later be promoted
|
|
70
|
+
|
|
71
|
+
It creates two isolated namespaces:
|
|
72
|
+
|
|
73
|
+
- `repo/ai-wiki/` for project-specific AI wiki files
|
|
74
|
+
- `~/ai-wiki/system/` for reusable cross-project AI wiki files
|
|
75
|
+
|
|
76
|
+
It also adds a managed instruction block to your agent prompt file so the agent knows where to read from and where to write back durable notes.
|
|
77
|
+
|
|
78
|
+
## How It Fits Coding Agents
|
|
79
|
+
|
|
80
|
+
`ai-wiki-toolkit` is not meant to be a standalone end-user app by itself.
|
|
81
|
+
|
|
82
|
+
It is a scaffold layer for coding-agent workflows. The point is to give tools like Claude Code, Codex, and similar repo agents a stable place to read project memory from and a stable place to write durable lessons back to.
|
|
83
|
+
|
|
84
|
+
In practice, the toolkit becomes useful when an agent is already working inside a git repository and needs shared instructions plus persistent repo memory.
|
|
85
|
+
|
|
86
|
+
That is why the installer manages both wiki files and prompt wiring together:
|
|
87
|
+
|
|
88
|
+
- `ai-wiki/` and `~/ai-wiki/system/` hold the durable Markdown memory
|
|
89
|
+
- `AGENT.md`, `AGENTS.md`, or `CLAUDE.md` tell the agent to read that memory and follow the workflow
|
|
90
|
+
- `.agents/skills/ai-wiki-reuse-check/` and `.agents/skills/ai-wiki-update-check/` provide repeatable end-of-task checks for Codex-style agent runs
|
|
91
|
+
- `.agents/skills/ai-wiki-clarify-before-code/` and `.agents/skills/ai-wiki-capture-review-learning/` help agents clarify ambiguous requests and preserve reusable review feedback
|
|
92
|
+
|
|
93
|
+
The toolkit does not replace coding agents. It gives them a shared repo-local memory layer so they can avoid repeating the same review issues, misunderstanding the same requirements, or rediscovering the same fixes.
|
|
94
|
+
|
|
95
|
+
## Prompt File Integration
|
|
96
|
+
|
|
97
|
+
Many coding-agent setups already create one of these repo-shared prompt files:
|
|
98
|
+
|
|
99
|
+
- `CLAUDE.md` for Claude Code style workflows
|
|
100
|
+
- `AGENTS.md` or `AGENT.md` for Codex or other agent bootstraps
|
|
101
|
+
|
|
102
|
+
`ai-wiki-toolkit` does not expect you to choose all of them manually.
|
|
103
|
+
|
|
104
|
+
When you run `aiwiki-toolkit install`, it looks for supported prompt files in the repository root and updates whichever ones already exist. It only manages the `aiwiki-toolkit` block inside those files, so your surrounding user-written instructions stay in place.
|
|
105
|
+
|
|
106
|
+
If none of those files exist yet, the toolkit creates `AGENT.md` as a generic default so the repo still has one stable prompt entrypoint.
|
|
107
|
+
|
|
108
|
+
## Why The Files Look Like This
|
|
109
|
+
|
|
110
|
+
The AI wiki structure is deliberately inspired by how `SKILL.md` files work well: keep a small stable entrypoint, then fan out into focused references.
|
|
111
|
+
|
|
112
|
+
Each wiki namespace starts with an `index.md` and then links to narrower files such as `constraints.md`, `conventions/`, `workflows.md`, `decisions.md`, `review-patterns/`, `problems/`, `features/`, `trails/`, and personal `drafts/`. The package-managed start-of-task routing lives in `ai-wiki/_toolkit/system.md`, while repo-owned indexes stay stable maps that humans can customize without turning them into package upgrade surfaces.
|
|
113
|
+
|
|
114
|
+
## Current Scope
|
|
115
|
+
|
|
116
|
+
The current scope is intentionally strict about compatibility:
|
|
117
|
+
|
|
118
|
+
- initialize the repo and home AI wiki folders
|
|
119
|
+
- create starter Markdown files only if they do not already exist
|
|
120
|
+
- create managed `_toolkit/` files that package updates are allowed to refresh
|
|
121
|
+
- create `conventions/`, `review-patterns/`, `problems/`, `features/`, and `people/<handle>/drafts/` scaffolding
|
|
122
|
+
- create repo-local `.agents/skills/ai-wiki-reuse-check/`, `.agents/skills/ai-wiki-update-check/`, `.agents/skills/ai-wiki-clarify-before-code/`, and `.agents/skills/ai-wiki-capture-review-learning/` skills only when files are missing
|
|
123
|
+
- create a managed `_toolkit/schema/team-memory-v1.md` guide for lightweight team coding memory
|
|
124
|
+
- update managed instruction blocks inside `AGENT.md`, `AGENTS.md`, and `CLAUDE.md`
|
|
125
|
+
- avoid rewriting existing user-owned `ai-wiki/**/*.md` documents outside `_toolkit/`
|
|
126
|
+
|
|
127
|
+
## Install
|
|
128
|
+
|
|
129
|
+
For end users, the simplest install paths are Homebrew on macOS/Linux and npm on macOS/Linux/Windows. The npm distribution now splits supported Linux targets by `glibc` versus `musl` where needed, so the installed platform package can match the published release asset family.
|
|
130
|
+
|
|
131
|
+
### Homebrew
|
|
132
|
+
|
|
133
|
+
1. Install the command:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
brew tap BochengYin/tap
|
|
137
|
+
brew install aiwiki-toolkit
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Or in one command:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
brew install BochengYin/tap/aiwiki-toolkit
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
2. Enter the target git repository and initialize the wiki scaffolding:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
cd /path/to/your/repo
|
|
150
|
+
aiwiki-toolkit install
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### npm
|
|
154
|
+
|
|
155
|
+
1. Install the command:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
npm install -g ai-wiki-toolkit
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
The Homebrew formula and npm distribution both consume the same versioned GitHub Release assets.
|
|
162
|
+
|
|
163
|
+
The npm package is a thin meta package that installs the matching platform-specific binary package for the current machine. It does not fetch release assets during `postinstall`.
|
|
164
|
+
|
|
165
|
+
2. Enter the target git repository and initialize the wiki scaffolding:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
cd /path/to/your/repo
|
|
169
|
+
aiwiki-toolkit install
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Local development
|
|
173
|
+
|
|
174
|
+
1. Install the command from this repository checkout:
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
pip install -e .
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
This remains the simplest contributor workflow inside the repository.
|
|
181
|
+
|
|
182
|
+
2. Enter the target git repository and initialize the wiki scaffolding:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
cd /path/to/your/repo
|
|
186
|
+
aiwiki-toolkit install
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## Recommendations
|
|
190
|
+
|
|
191
|
+
Recommended before running `install`:
|
|
192
|
+
|
|
193
|
+
- initialize the repository with git
|
|
194
|
+
- configure `git user.name` and `git user.email` so the toolkit can derive a stable handle
|
|
195
|
+
- if you already ran Claude Code, Codex, or another agent bootstrap and already have `AGENT.md`, `AGENTS.md`, or `CLAUDE.md`, the toolkit will update the managed `aiwiki-toolkit` block in that file instead of replacing the whole file
|
|
196
|
+
|
|
197
|
+
Claude Code / Codex init is not required. If no supported prompt file exists, `ai-wiki-toolkit` creates `AGENT.md` automatically.
|
|
198
|
+
|
|
199
|
+
## Update
|
|
200
|
+
|
|
201
|
+
For npm installs, use npm itself to update both the meta package and the matching platform binary:
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
npm update -g ai-wiki-toolkit
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Or install the latest version explicitly:
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
npm install -g ai-wiki-toolkit@latest
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
`aiwiki-toolkit` does not implement a self-update command. The package manager remains the source of truth for install and upgrade state.
|
|
214
|
+
|
|
215
|
+
## Customizing Your AI Wiki
|
|
216
|
+
|
|
217
|
+
`ai-wiki-toolkit` ships a starter structure, not a locked schema.
|
|
218
|
+
|
|
219
|
+
- Files under `ai-wiki/_toolkit/**` and `~/ai-wiki/system/_toolkit/**` are package-managed.
|
|
220
|
+
- Files such as `ai-wiki/index.md`, `ai-wiki/workflows.md`, and other docs you add under `ai-wiki/` are user-owned.
|
|
221
|
+
- `ai-wiki/_toolkit/system.md` is the managed entrypoint for package-managed repo guidance and evolving read order.
|
|
222
|
+
- `ai-wiki/index.md` is a repo-owned map, not a package upgrade surface.
|
|
223
|
+
- `ai-wiki/_toolkit/workflows.md` carries the managed baseline workflows that package upgrades can refresh.
|
|
224
|
+
- Agents should extend user-owned workflow docs instead of editing `_toolkit/**`.
|
|
225
|
+
|
|
226
|
+
After upgrading the package, refresh the managed layer and then check for missing starter docs, stale managed prompt blocks, or rule drift:
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
aiwiki-toolkit install
|
|
230
|
+
aiwiki-toolkit doctor --strict
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
If `doctor` reports missing starter pointers, print the latest suggested starter content with:
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
aiwiki-toolkit doctor --suggest-index-upgrade
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## Usage
|
|
240
|
+
|
|
241
|
+
Run inside a git repository:
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
aiwiki-toolkit install
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
Override the detected handle only when you need to:
|
|
248
|
+
|
|
249
|
+
```bash
|
|
250
|
+
aiwiki-toolkit install --handle your-handle
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Or use the backward-compatible alias:
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
aiwiki-toolkit init
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
`install` will:
|
|
260
|
+
|
|
261
|
+
- create `ai-wiki/` inside the current repository
|
|
262
|
+
- create `~/ai-wiki/system/`
|
|
263
|
+
- create starter indexes such as `ai-wiki/conventions/index.md`, `ai-wiki/review-patterns/index.md`, `ai-wiki/problems/index.md`, `ai-wiki/features/index.md`, `ai-wiki/trails/index.md`, and `ai-wiki/people/<handle>/index.md`
|
|
264
|
+
- create `ai-wiki/conventions/`, `ai-wiki/review-patterns/`, `ai-wiki/problems/`, `ai-wiki/features/`, `ai-wiki/people/<handle>/drafts/`, `ai-wiki/metrics/`, and repo/home `_toolkit/`
|
|
265
|
+
- generate package-managed `_toolkit/index.md`, `_toolkit/workflows.md`, `_toolkit/catalog.json`, `_toolkit/schema/reuse-v1.md`, `_toolkit/schema/team-memory-v1.md`, and `_toolkit/metrics/*.json`
|
|
266
|
+
- upsert a managed `.gitignore` block that ignores AI wiki telemetry and generated aggregate snapshots so routine agent use does not dirty `git status`
|
|
267
|
+
- create `.agents/skills/ai-wiki-reuse-check/`, `.agents/skills/ai-wiki-update-check/`, `.agents/skills/ai-wiki-clarify-before-code/`, and `.agents/skills/ai-wiki-capture-review-learning/` if the repo-local skills do not already exist
|
|
268
|
+
- update `AGENT.md`, `AGENTS.md`, and/or `CLAUDE.md` with a managed instruction block that reads `ai-wiki/_toolkit/system.md`
|
|
269
|
+
|
|
270
|
+
If no supported prompt file exists, it creates `AGENT.md`.
|
|
271
|
+
|
|
272
|
+
If `--handle` is not passed, the tool resolves a handle from:
|
|
273
|
+
|
|
274
|
+
1. `AIWIKI_TOOLKIT_HANDLE`
|
|
275
|
+
2. local or global git config
|
|
276
|
+
3. `unknown`
|
|
277
|
+
|
|
278
|
+
The tool works best when `git user.name` and `git user.email` are configured first.
|
|
279
|
+
|
|
280
|
+
If repo-local skill files already exist under `.agents/skills/`, the installer does not overwrite them. It skips those files and prints a manual merge URL back to this repository so you can compare and resolve changes yourself.
|
|
281
|
+
|
|
282
|
+
`init` remains as a backward-compatible alias for `install`. The actual scaffold creation does not happen at package install time; it happens when you run `aiwiki-toolkit install` or `aiwiki-toolkit init` inside a git repository.
|
|
283
|
+
|
|
284
|
+
To append one explicit knowledge-reuse observation and refresh managed aggregates:
|
|
285
|
+
|
|
286
|
+
```bash
|
|
287
|
+
aiwiki-toolkit record-reuse \
|
|
288
|
+
--doc-id review-patterns/shared-prompt-files-must-be-user-agnostic \
|
|
289
|
+
--task-id release-followup \
|
|
290
|
+
--retrieval-mode lookup \
|
|
291
|
+
--evidence-mode explicit \
|
|
292
|
+
--reuse-outcome resolved \
|
|
293
|
+
--reuse-effect avoided_retry \
|
|
294
|
+
--saved-tokens 1200 \
|
|
295
|
+
--saved-seconds 45
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
This appends to the user-owned `ai-wiki/metrics/reuse-events/<handle>.jsonl` shard and refreshes the package-managed aggregate views under `ai-wiki/_toolkit/metrics/`. The installer ignores both the shard and the generated aggregate views by default so these telemetry updates stay local.
|
|
299
|
+
|
|
300
|
+
Only record user-owned AI wiki knowledge docs with `record-reuse`.
|
|
301
|
+
|
|
302
|
+
Managed control-plane docs under `_toolkit/**` should still be cited in user-facing notes when they affect behavior, but they should not be logged as knowledge-reuse events.
|
|
303
|
+
|
|
304
|
+
To record that a completed task was checked for AI wiki reuse, even when no wiki docs were needed:
|
|
305
|
+
|
|
306
|
+
```bash
|
|
307
|
+
aiwiki-toolkit record-reuse-check \
|
|
308
|
+
--task-id release-followup \
|
|
309
|
+
--check-outcome wiki_used
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
This appends to the user-owned `ai-wiki/metrics/task-checks/<handle>.jsonl` shard and refreshes the package-managed aggregate views under `ai-wiki/_toolkit/metrics/`. The installer ignores both the shard and the generated aggregate views by default so these telemetry updates stay local.
|
|
313
|
+
|
|
314
|
+
Both metrics logs are sharded by handle under:
|
|
315
|
+
|
|
316
|
+
- `ai-wiki/metrics/reuse-events/<handle>.jsonl`
|
|
317
|
+
- `ai-wiki/metrics/task-checks/<handle>.jsonl`
|
|
318
|
+
|
|
319
|
+
These logs are intended as local telemetry by default, not merge-heavy source files.
|
|
320
|
+
|
|
321
|
+
If you need a fresh local telemetry snapshot, regenerate package-managed aggregate views such as `ai-wiki/_toolkit/catalog.json` or `ai-wiki/_toolkit/metrics/*.json` with:
|
|
322
|
+
|
|
323
|
+
```bash
|
|
324
|
+
aiwiki-toolkit refresh-metrics
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
To diagnose missing starter pointers, stale managed prompt blocks, or rule drift and print copy-paste upgrade starters:
|
|
328
|
+
|
|
329
|
+
```bash
|
|
330
|
+
aiwiki-toolkit doctor --suggest-index-upgrade
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
This command does not rewrite user-owned repo docs. It prints which paths need attention and the latest starter content for those files so you can merge or copy it into:
|
|
334
|
+
|
|
335
|
+
- `ai-wiki/workflows.md`
|
|
336
|
+
- `ai-wiki/conventions/index.md`
|
|
337
|
+
- `ai-wiki/review-patterns/index.md`
|
|
338
|
+
- `ai-wiki/problems/index.md`
|
|
339
|
+
- `ai-wiki/features/index.md`
|
|
340
|
+
- `ai-wiki/trails/index.md`
|
|
341
|
+
- `ai-wiki/people/<handle>/index.md`
|
|
342
|
+
- `ai-wiki/metrics/index.md`
|
|
343
|
+
|
|
344
|
+
It also checks whether the managed `.gitignore` block is present and whether telemetry paths are still tracked in the git index from older versions. If those paths are still tracked, `doctor` prints a one-time `git rm --cached` command to untrack them.
|
|
345
|
+
|
|
346
|
+
To remove the managed layer while keeping your user-owned wiki documents:
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
aiwiki-toolkit uninstall
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
This removes:
|
|
353
|
+
|
|
354
|
+
- managed prompt blocks from `AGENT.md` / `AGENTS.md` / `CLAUDE.md`
|
|
355
|
+
- the managed `.gitignore` block for AI wiki telemetry
|
|
356
|
+
- `ai-wiki/_toolkit/**`
|
|
357
|
+
- `~/ai-wiki/system/_toolkit/**`
|
|
358
|
+
- the `aiwikiToolkit` key from `opencode.json`
|
|
359
|
+
|
|
360
|
+
Your user-owned `ai-wiki/**/*.md` and `~/ai-wiki/system/**/*.md` documents are preserved by default.
|
|
361
|
+
|
|
362
|
+
To also remove repo-local user-owned docs, you must opt in explicitly:
|
|
363
|
+
|
|
364
|
+
```bash
|
|
365
|
+
aiwiki-toolkit uninstall --purge-user-docs --yes
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
Even with `--purge-user-docs --yes`, the shared home wiki under `~/ai-wiki/system/` is preserved.
|
|
369
|
+
|
|
370
|
+
## Compatibility rules
|
|
371
|
+
|
|
372
|
+
- Existing user-owned `ai-wiki/**/*.md` files are treated as stable data.
|
|
373
|
+
- `install`/`init` only create missing starter files; they do not merge or overwrite existing user wiki documents.
|
|
374
|
+
- Starter indexes such as `ai-wiki/index.md`, `conventions/index.md`, `review-patterns/index.md`, `problems/index.md`, `features/index.md`, `trails/index.md`, `people/<handle>/index.md`, and `metrics/index.md` become user-owned once created and are not rewritten by future package updates.
|
|
375
|
+
- `ai-wiki/_toolkit/**` and `~/ai-wiki/system/_toolkit/**` are package-managed and may be refreshed by future versions.
|
|
376
|
+
- `ai-wiki/index.md` is a repo-owned map and is not treated as a starter-drift upgrade target by `doctor`.
|
|
377
|
+
- `ai-wiki/workflows.md` remains user-owned; package-managed workflow updates land in `ai-wiki/_toolkit/workflows.md` instead of rewriting the repo-owned file.
|
|
378
|
+
- `ai-wiki/metrics/reuse-events/<handle>.jsonl` and `ai-wiki/metrics/task-checks/<handle>.jsonl` are user-owned evidence data. Package-managed aggregate views are regenerated under `ai-wiki/_toolkit/metrics/`, and the installer ignores all of those telemetry paths by default in `.gitignore`.
|
|
379
|
+
- Legacy flat files such as `ai-wiki/metrics/reuse-events.jsonl` and `ai-wiki/metrics/task-checks.jsonl` are still read for compatibility, but new writes should use the handle-sharded layout.
|
|
380
|
+
- `aiwiki-toolkit doctor --suggest-index-upgrade` prints suggested replacements for missing repo starter docs and repo-owned companion docs such as `ai-wiki/workflows.md`, but it does not overwrite them automatically.
|
|
381
|
+
- `.agents/skills/ai-wiki-reuse-check/**`, `.agents/skills/ai-wiki-update-check/**`, `.agents/skills/ai-wiki-clarify-before-code/**`, and `.agents/skills/ai-wiki-capture-review-learning/**` are installed as starter scaffolding only. Existing files at those paths are skipped instead of overwritten.
|
|
382
|
+
- Prompt files are updated only inside the managed block marked by:
|
|
383
|
+
|
|
384
|
+
```md
|
|
385
|
+
<!-- aiwiki-toolkit:start -->
|
|
386
|
+
<!-- aiwiki-toolkit:end -->
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
- `.gitignore` is updated only inside the managed block marked by:
|
|
390
|
+
|
|
391
|
+
```gitignore
|
|
392
|
+
# <!-- aiwiki-toolkit:start -->
|
|
393
|
+
# <!-- aiwiki-toolkit:end -->
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
- Future `opencode.json` integration is limited to a single top-level `aiwikiToolkit` key.
|
|
397
|
+
|
|
398
|
+
## Distribution
|
|
399
|
+
|
|
400
|
+
The public distribution model is:
|
|
401
|
+
|
|
402
|
+
- GitHub Releases are the source of truth for versioned release binaries
|
|
403
|
+
- Homebrew tap `BochengYin/tap` consumes those release assets for macOS and Linux users
|
|
404
|
+
- npm package `ai-wiki-toolkit` is a meta package that depends on platform-specific npm binary packages for macOS and Linux users who prefer `npm install -g`
|
|
405
|
+
|
|
406
|
+
The goal is to make end-user installation independent of a local Python setup, while keeping `pip install -e .` as the simplest contributor workflow inside this repository.
|
|
407
|
+
|
|
408
|
+
Release history is tracked in [CHANGELOG.md](CHANGELOG.md).
|
|
409
|
+
|
|
410
|
+
The first release skeleton is documented in [docs/releasing.md](docs/releasing.md).
|
|
411
|
+
The Homebrew tap plan is documented in [docs/homebrew-tap.md](docs/homebrew-tap.md).
|
|
412
|
+
The npm distribution plan is documented in [docs/npm-wrapper.md](docs/npm-wrapper.md).
|
|
413
|
+
The npm publishing plan is documented in [docs/npm-publish.md](docs/npm-publish.md).
|
|
414
|
+
|
|
415
|
+
## Path examples
|
|
416
|
+
|
|
417
|
+
The repo-local wiki is always:
|
|
418
|
+
|
|
419
|
+
- `ai-wiki/`
|
|
420
|
+
|
|
421
|
+
The home-level system wiki resolves from the current user's home directory:
|
|
422
|
+
|
|
423
|
+
- macOS: `/Users/<username>/ai-wiki/system`
|
|
424
|
+
- Linux: `/home/<username>/ai-wiki/system`
|
|
425
|
+
- Windows: `C:\Users\<username>\ai-wiki\system`
|
|
426
|
+
|
|
427
|
+
In Python terms, the path comes from `Path.home() / "ai-wiki" / "system"`, so it follows the current platform automatically.
|
|
Binary file
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ai-wiki-toolkit-linux-arm64",
|
|
3
|
+
"version": "0.1.16",
|
|
4
|
+
"description": "Platform binary package for ai-wiki-toolkit (linux-arm64-glibc).",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"homepage": "https://github.com/BochengYin/ai-wiki-toolkit#readme",
|
|
7
|
+
"bugs": {
|
|
8
|
+
"url": "https://github.com/BochengYin/ai-wiki-toolkit/issues"
|
|
9
|
+
},
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/BochengYin/ai-wiki-toolkit.git"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"bin/aiwiki-toolkit",
|
|
16
|
+
"LICENSE",
|
|
17
|
+
"README.md"
|
|
18
|
+
],
|
|
19
|
+
"os": [
|
|
20
|
+
"linux"
|
|
21
|
+
],
|
|
22
|
+
"cpu": [
|
|
23
|
+
"arm64"
|
|
24
|
+
],
|
|
25
|
+
"bin": {
|
|
26
|
+
"aiwiki-toolkit": "bin/aiwiki-toolkit"
|
|
27
|
+
},
|
|
28
|
+
"libc": "glibc"
|
|
29
|
+
}
|