@cairnkeep/cli 2.5.0 → 2.7.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/CHANGELOG.md +24 -1
- package/README.md +33 -12
- package/bin/cairn +15 -3
- package/claude/commands/graphify.md +46 -55
- package/docs/building-an-overlay.md +2 -2
- package/docs/harness-compatibility.md +95 -9
- package/docs/learning/CURRICULUM-MAP.md +3 -1
- package/docs/learning/FEATURE-GUIDE.md +3 -2
- package/docs/learning/README.md +12 -12
- package/docs/learning/lessons/L00-why-cairnkeep.md +1 -5
- package/docs/learning/lessons/L01-safe-trial.md +3 -7
- package/docs/learning/lessons/L02-installation.md +15 -9
- package/docs/learning/lessons/L03-first-project.md +1 -5
- package/docs/learning/lessons/L04-memory-fundamentals.md +0 -6
- package/docs/learning/lessons/L05-daily-workflow.md +0 -5
- package/docs/learning/lessons/L06-repository-quality.md +0 -6
- package/docs/learning/lessons/L07-privacy-and-storage.md +0 -5
- package/docs/learning/lessons/L08-multiple-machines.md +0 -5
- package/docs/learning/lessons/L09-domain-knowledge.md +0 -5
- package/docs/learning/lessons/L10-context-exploration.md +0 -5
- package/docs/learning/lessons/L11-containers.md +0 -5
- package/docs/learning/lessons/L12-managed-overlays.md +0 -6
- package/docs/learning/lessons/L13-session-evidence.md +0 -6
- package/docs/learning/lessons/L14-typed-memory.md +0 -6
- package/docs/learning/lessons/L15-capability-governance.md +0 -6
- package/docs/learning/lessons/L16-evaluation.md +0 -7
- package/docs/learning/lessons/L17-agent-boundary.md +0 -6
- package/docs/learning/templates/lesson-template.md +0 -4
- package/docs/operating.md +111 -9
- package/docs/privacy-and-data-flow.md +1 -0
- package/examples/eval/bundled-fake.json +1 -1
- package/kimi/skills/graphify/SKILL.md +33 -0
- package/mcp-memory-server/dist/capability-registry.js +2 -2
- package/mcp-memory-server/dist/graph-cli.js +386 -0
- package/mcp-memory-server/package.json +2 -1
- package/opencode/command/graphify.md +48 -58
- package/package.json +4 -2
- package/pi/prompts/graphify.md +32 -0
- package/scripts/bootstrap.sh +4 -1
- package/scripts/completion.sh +17 -6
- package/scripts/smoke-bash32.sh +1 -0
- package/scripts/sync-kimi-assets.sh +77 -0
- package/scripts/sync-pi-assets.sh +52 -31
- package/scripts/test-bootstrap-untracked.sh +23 -1
- package/scripts/test-cli-dispatch.sh +4 -0
- package/scripts/test-completion.sh +5 -0
- package/scripts/test-graph-harness-adapters.sh +46 -0
- package/scripts/test-launcher-hooks.sh +33 -3
- package/scripts/test-learning-docs.sh +2 -9
- package/scripts/test-package-install.sh +9 -0
- package/scripts/test-trajectory-hooks.sh +5 -1
- package/scripts/test-uninstall.sh +12 -2
- package/scripts/uninstall.sh +12 -4
- package/templates/graph-policy.md.template +23 -4
- package/templates/start-qwen.sh.template +32 -0
- package/docs/learning/PRODUCTION-PLAN.md +0 -153
- package/docs/learning/instructor-guide.md +0 -66
- package/docs/learning/templates/video-script-template.md +0 -50
- package/docs/learning/video-scripts/L00-why-cairnkeep.md +0 -80
- package/docs/learning/video-scripts/L01-safe-trial.md +0 -78
- package/docs/learning/video-scripts/L02-installation.md +0 -97
- package/docs/learning/video-scripts/L03-first-project.md +0 -99
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
# L02 Video Script - Install the local workflow
|
|
2
|
-
|
|
3
|
-
**Target duration:** 12 minutes
|
|
4
|
-
**Companion lesson:** [L02](../lessons/L02-installation.md)
|
|
5
|
-
|
|
6
|
-
## Recording setup
|
|
7
|
-
|
|
8
|
-
- Use a clean user profile or disposable VM with Node.js 22 or newer.
|
|
9
|
-
- Install Claude Code but remove any existing `cairn-memory` registration.
|
|
10
|
-
- Ensure no private MCP servers, provider URLs, or environment variables appear.
|
|
11
|
-
- Prepare a snapshot before installation for a repeatable retake.
|
|
12
|
-
|
|
13
|
-
## 00:00 - Hook
|
|
14
|
-
|
|
15
|
-
**Say:** “The most common incomplete installation has a running memory server
|
|
16
|
-
but no Cairnkeep commands or hooks. We will install and verify all three parts
|
|
17
|
-
of the local workflow.”
|
|
18
|
-
|
|
19
|
-
**Show:** A three-part diagram: CLI, MCP registration, operating layer.
|
|
20
|
-
|
|
21
|
-
## 00:40 - Outcome
|
|
22
|
-
|
|
23
|
-
**Say:** “At the end, Claude Code can start the local `cairn-memory` server and
|
|
24
|
-
the managed command assets pass a non-writing drift check.”
|
|
25
|
-
|
|
26
|
-
## 01:10 - Runtime preflight
|
|
27
|
-
|
|
28
|
-
**Do:** Run `node --version` and `npm --version`.
|
|
29
|
-
|
|
30
|
-
**Say:** “Cairnkeep requires Node.js 22 or newer. I verify that before changing
|
|
31
|
-
the machine.”
|
|
32
|
-
|
|
33
|
-
## 02:00 - Install the CLI
|
|
34
|
-
|
|
35
|
-
**Do:** Run the pinned npm install and `cairn --version` from L02.
|
|
36
|
-
|
|
37
|
-
**Say:** “For a course recording I pin the version. Users can follow the current
|
|
38
|
-
release instructions when the lesson is updated.”
|
|
39
|
-
|
|
40
|
-
## 03:30 - Register MCP
|
|
41
|
-
|
|
42
|
-
**Say:** “The stable server name is `cairn-memory`. This command tells Claude
|
|
43
|
-
Code to launch a local stdio child process. It does not configure a remote URL.”
|
|
44
|
-
|
|
45
|
-
**Do:** Run the `claude mcp add` command, followed by `claude mcp get cairn-memory`.
|
|
46
|
-
|
|
47
|
-
**Point out:** The command is `cairn memory-server`.
|
|
48
|
-
|
|
49
|
-
## 05:15 - Install the operating layer
|
|
50
|
-
|
|
51
|
-
**Say:** “MCP tools alone do not install `/remember`, `/recall`, wiki commands,
|
|
52
|
-
review workflows, agents, or hooks. That is the job of `cairn sync`.”
|
|
53
|
-
|
|
54
|
-
**Do:** Run `cairn sync --apply`.
|
|
55
|
-
|
|
56
|
-
**Pause:** Allow the learner to see the asset summary.
|
|
57
|
-
|
|
58
|
-
## 07:00 - Verify without writing
|
|
59
|
-
|
|
60
|
-
**Do:** Run `cairn sync --check`.
|
|
61
|
-
|
|
62
|
-
**Say:** “This is the repeatable drift check. A healthy result means the
|
|
63
|
-
operating layer matches the installed distribution. MCP registration plus this
|
|
64
|
-
check distinguishes a complete setup from a partial one.”
|
|
65
|
-
|
|
66
|
-
## 08:30 - Common failure demonstration
|
|
67
|
-
|
|
68
|
-
**Say:** “If slash commands are missing, do not reinstall everything blindly.
|
|
69
|
-
First check the MCP registration, then check operating-layer drift, and restart
|
|
70
|
-
the harness after applying assets.”
|
|
71
|
-
|
|
72
|
-
**Show:** The two verification commands together.
|
|
73
|
-
|
|
74
|
-
## 09:30 - Optional shell completion
|
|
75
|
-
|
|
76
|
-
**Do:** Run `source <(cairn completion bash)` and complete `cairn tra`.
|
|
77
|
-
|
|
78
|
-
**Say:** “Completion is optional convenience. It does not start another server
|
|
79
|
-
or enable any feature.”
|
|
80
|
-
|
|
81
|
-
## 10:00 - Boundary
|
|
82
|
-
|
|
83
|
-
**Say:** “This default server is local. We did not configure embeddings,
|
|
84
|
-
document RAG, or remote HTTP memory. Those choices have separate lessons
|
|
85
|
-
because they change data flow.”
|
|
86
|
-
|
|
87
|
-
## 11:00 - Recap
|
|
88
|
-
|
|
89
|
-
**Say:** “The machine setup has three pieces: CLI, MCP registration, and the
|
|
90
|
-
operating layer. In L03 we add the fourth piece, a bootstrapped project, and
|
|
91
|
-
prove memory survives a new session.”
|
|
92
|
-
|
|
93
|
-
## Editing notes
|
|
94
|
-
|
|
95
|
-
- Chapter markers: Preflight, CLI, MCP, Operating layer, Verify, Boundary.
|
|
96
|
-
- Do not show the general MCP list if it contains unrelated server names.
|
|
97
|
-
- Link L02, the operating guide, and L03.
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
# L03 Video Script - Bootstrap the first project
|
|
2
|
-
|
|
3
|
-
**Target duration:** 13 minutes
|
|
4
|
-
**Companion lesson:** [L03](../lessons/L03-first-project.md)
|
|
5
|
-
|
|
6
|
-
## Recording setup
|
|
7
|
-
|
|
8
|
-
- Start from the completed L02 VM snapshot.
|
|
9
|
-
- Confirm `$HOME/cairnkeep-course/first-project` does not exist.
|
|
10
|
-
- Use only the synthetic UTC convention from the lesson.
|
|
11
|
-
- Prepare to stop and restart the harness during the recording.
|
|
12
|
-
|
|
13
|
-
## 00:00 - Hook
|
|
14
|
-
|
|
15
|
-
**Say:** “An installation is not proven by files on disk. The useful proof is a
|
|
16
|
-
fact accepted in one session and recalled in a new session.”
|
|
17
|
-
|
|
18
|
-
## 00:30 - Outcome
|
|
19
|
-
|
|
20
|
-
**Say:** “We will bootstrap a disposable Git repository, run diagnostics, store
|
|
21
|
-
one synthetic convention, restart Claude Code, and retrieve it again.”
|
|
22
|
-
|
|
23
|
-
## 01:00 - Create the project
|
|
24
|
-
|
|
25
|
-
**Do:** Run the directory, `git init`, and README commands from L03.
|
|
26
|
-
|
|
27
|
-
**Say:** “I use a disposable repository so no course artifact can reach a real
|
|
28
|
-
project.”
|
|
29
|
-
|
|
30
|
-
## 02:00 - Bootstrap
|
|
31
|
-
|
|
32
|
-
**Say:** “Bootstrap adds project launchers and derived-knowledge scaffolding. It
|
|
33
|
-
does not reinstall the machine-level MCP server or operating assets.”
|
|
34
|
-
|
|
35
|
-
**Do:** Run `cairn bootstrap "$PWD"` and copy `.ai/env.example` to `.ai/.env`.
|
|
36
|
-
|
|
37
|
-
**Point out:** The generated next steps without reading every created filename.
|
|
38
|
-
|
|
39
|
-
## 03:45 - Diagnose
|
|
40
|
-
|
|
41
|
-
**Do:** Run `cairn doctor`.
|
|
42
|
-
|
|
43
|
-
**Say:** “Optional unconfigured integrations may be skipped. A configured but
|
|
44
|
-
unreachable dependency is a failure and should be fixed before relying on it.”
|
|
45
|
-
|
|
46
|
-
**Point out:** Session capture, notes, compaction, artifacts, typed memory,
|
|
47
|
-
capability governance, and evaluation remain off for the core-memory proof.
|
|
48
|
-
|
|
49
|
-
## 05:00 - Launch and remember
|
|
50
|
-
|
|
51
|
-
**Do:** Start `./.ai/start-claude.sh`.
|
|
52
|
-
|
|
53
|
-
**Say:** “I launch through the project script so every session loads the same
|
|
54
|
-
project environment.”
|
|
55
|
-
|
|
56
|
-
**Do in Claude:** `/remember Course convention: examples use UTC timestamps.`
|
|
57
|
-
|
|
58
|
-
**Point out:** The durable key returned by the workflow.
|
|
59
|
-
|
|
60
|
-
## 07:00 - Recall
|
|
61
|
-
|
|
62
|
-
**Do in Claude:** `/recall UTC timestamps`
|
|
63
|
-
|
|
64
|
-
**Say:** “This confirms retrieval inside the first session, but not yet
|
|
65
|
-
persistence across sessions.”
|
|
66
|
-
|
|
67
|
-
## 08:00 - Persistence proof
|
|
68
|
-
|
|
69
|
-
**Do:** Exit Claude Code, run the launcher again, and repeat `/recall UTC timestamps`.
|
|
70
|
-
|
|
71
|
-
**Pause:** Keep the retrieved result visible.
|
|
72
|
-
|
|
73
|
-
**Say:** “This is the important proof. The second harness process recovered the
|
|
74
|
-
accepted fact from durable local storage.”
|
|
75
|
-
|
|
76
|
-
## 10:00 - Locate storage
|
|
77
|
-
|
|
78
|
-
**Do:** Exit the harness and run `cairn memory path`.
|
|
79
|
-
|
|
80
|
-
**Say:** “The command reports the local store location. Nothing in bootstrap
|
|
81
|
-
silently selected a remote server.”
|
|
82
|
-
|
|
83
|
-
## 11:00 - Recovery and boundary
|
|
84
|
-
|
|
85
|
-
**Say:** “If recall fails after restart, compare the launcher and environment,
|
|
86
|
-
check the MCP registration, and verify the storage path. Do not solve routing
|
|
87
|
-
problems by copying database files while the server is running.”
|
|
88
|
-
|
|
89
|
-
## 12:00 - Recap
|
|
90
|
-
|
|
91
|
-
**Say:** “We bootstrapped one project, used its launcher, and proved persistence
|
|
92
|
-
across a new session. The quickstart is complete. L04 will teach how to choose
|
|
93
|
-
keys, scopes, search, history, and the memory review gate.”
|
|
94
|
-
|
|
95
|
-
## Editing notes
|
|
96
|
-
|
|
97
|
-
- Do not cut away the harness exit/restart; it is the central proof.
|
|
98
|
-
- Add captions for “first session” and “second session”.
|
|
99
|
-
- Link L03 and L04 in the description.
|