threadnote 0.4.1 → 0.5.0
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/README.md +35 -0
- package/dist/threadnote.cjs +395 -158
- package/docs/.nojekyll +0 -0
- package/docs/index.html +1532 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
It is intentionally scoped to curated docs, memories, skills, and handoffs. It is not a source-navigation replacement,
|
|
5
5
|
and it does not index whole repositories by default.
|
|
6
6
|
|
|
7
|
+
> **Walkthrough deck:** https://kashkovsky.github.io/threadnote/
|
|
8
|
+
|
|
7
9
|
## Real-World Uses
|
|
8
10
|
|
|
9
11
|
**Want to continue work in a fresh agent session?**
|
|
@@ -222,6 +224,39 @@ claude mcp add threadnote -- threadnote-mcp-server
|
|
|
222
224
|
Cursor uses the equivalent entry in `~/.cursor/mcp.json`.
|
|
223
225
|
Copilot uses the VS Code MCP `servers` entry in the user-profile `mcp.json`.
|
|
224
226
|
|
|
227
|
+
### Agent hooks (optional, opt-in)
|
|
228
|
+
|
|
229
|
+
The instruction files (`~/.codex/AGENTS.md`, `~/.claude/CLAUDE.md`, etc.) are the **cross-agent guidance floor** — they
|
|
230
|
+
ask agents to recall context, store handoffs, and so on, and they work for every supported agent. They rely on the
|
|
231
|
+
agent to comply.
|
|
232
|
+
|
|
233
|
+
For deterministic moments where the agent shouldn't have to remember, Threadnote can also install agent-side
|
|
234
|
+
**hooks** — currently for Claude Code (the only supported agent that exposes a hook surface today):
|
|
235
|
+
|
|
236
|
+
- **`PreCompact`** auto-stores a handoff snapshot for the current repo right before Claude compacts the conversation,
|
|
237
|
+
so the next turn can recall it even if the agent forgot to write a handoff manually.
|
|
238
|
+
- **`SessionStart`** preloads the latest threadnote handoff/feature memory for the current repo into the new session
|
|
239
|
+
context, so the first turn already knows where you left off.
|
|
240
|
+
|
|
241
|
+
Install them per agent (Codex / Cursor / Copilot are no-ops today — Threadnote prints a clear explanation):
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
threadnote install-hooks claude --dry-run # preview the change
|
|
245
|
+
threadnote install-hooks claude --apply # add managed entries to ~/.claude/settings.json
|
|
246
|
+
threadnote install-hooks claude --remove --apply # take them out again
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Or opt in at install time and let Threadnote drive every supported agent in one shot:
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
threadnote install --with-hooks
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
Managed entries are tagged with `"_threadnote": "managed"` so `threadnote repair` and `threadnote uninstall` can find
|
|
256
|
+
and rewrite/remove only those entries without touching any of your own hooks. Hooks complement, not replace, the
|
|
257
|
+
instruction files: the soft guidance covers semantic decisions ("is this memory durable?", "is this work meaningful
|
|
258
|
+
enough to publish?"); hooks cover deterministic moments the agent shouldn't be trusted to remember.
|
|
259
|
+
|
|
225
260
|
If a future OpenViking build exposes a healthy native endpoint, install it explicitly:
|
|
226
261
|
|
|
227
262
|
```bash
|