mindkeeper-openclaw 0.2.25 → 0.2.26

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.
Files changed (6) hide show
  1. package/README.md +35 -10
  2. package/dist/index.js +1 -0
  3. package/package.json +1 -1
  4. package/skills/mindkeeper/README.md +36 -18
  5. package/skills/mindkeeper/SKILL.md +17 -4
  6. package/skills/mindkeeper/clawhub.json +2 -2
package/README.md CHANGED
@@ -2,15 +2,35 @@
2
2
 
3
3
  **Time Machine for Your AI's Brain** — OpenClaw plugin that gives your AI version control for agent context files.
4
4
 
5
- Every change to AGENTS.md, SOUL.md, MEMORY.md, skills, and more is automatically tracked. Your AI can browse history, compare versions, create checkpoints, and roll back any file.
5
+ Every change to `AGENTS.md`, `SOUL.md`, `MEMORY.md`, `memory/**/*.md`, and `skills/**/*.md` can be tracked automatically. Your AI can inspect history, compare versions, create checkpoints, and guide rollback safely.
6
+
7
+ ## Why Use It
8
+
9
+ This is the best experience if you want your AI to inspect history, show diffs, create checkpoints, and guide rollback in natural language:
10
+
11
+ - **Natural-language history** — ask your AI what changed and when
12
+ - **Preview-first rollback** — inspect the diff before restoring a file
13
+ - **Named checkpoints** — create safety points before risky edits
14
+ - **Background snapshots** — watcher starts with Gateway
15
+ - **LLM-powered commit messages** — reuse your existing OpenClaw model and auth settings
6
16
 
7
17
  ## Install
8
18
 
19
+ ### Option 1 — Install the plugin directly
20
+
9
21
  ```bash
10
22
  openclaw plugins install mindkeeper-openclaw
11
23
  ```
12
24
 
13
- Restart your Gateway once. The plugin auto-starts a background watcher and registers 5 tools.
25
+ Then restart your Gateway once.
26
+
27
+ ### Option 2 — Install the skill and let the AI guide setup
28
+
29
+ ```bash
30
+ clawhub install mindkeeper
31
+ ```
32
+
33
+ On first use, the AI checks whether `mindkeeper-openclaw` is available. If it is missing, the AI asks for your confirmation before installing the plugin and before restarting Gateway. If automatic restart is unavailable, it tells you to restart Gateway manually.
14
34
 
15
35
  ## Talk to Your AI
16
36
 
@@ -25,29 +45,34 @@ Once installed, ask in natural language:
25
45
 
26
46
  | Tool | What It Does |
27
47
  |------|--------------|
28
- | `mind_history` | Browse change history for any tracked file |
29
- | `mind_diff` | Compare any two versions with full unified diff |
30
- | `mind_rollback` | Two-step rollback: preview first, then execute after confirmation |
48
+ | `mind_history` | Browse change history for one file or all tracked files |
49
+ | `mind_diff` | Compare two versions with a unified diff |
50
+ | `mind_rollback` | Preview rollback first, then execute after confirmation |
31
51
  | `mind_snapshot` | Create named checkpoints before risky changes |
32
- | `mind_status` | Show what files are tracked and what's changed |
52
+ | `mind_status` | Show what files are tracked and what is pending |
33
53
 
34
54
  ## OpenClaw CLI
35
55
 
36
56
  ```bash
37
- openclaw mind status # See what's tracked and pending
38
- openclaw mind history SOUL.md # Browse SOUL.md change history
39
- openclaw mind snapshot stable-v2 # Save a named checkpoint
57
+ openclaw mind status
58
+ openclaw mind history SOUL.md
59
+ openclaw mind snapshot stable-v2
40
60
  ```
41
61
 
42
62
  ## Requirements
43
63
 
44
- - Node.js ≥ 22
64
+ - Node.js >= 22
45
65
  - OpenClaw with Gateway running
46
66
 
67
+ ## Commit Messages
68
+
69
+ OpenClaw Plugin mode is currently the only mode that supports LLM-generated commit messages. If no supported model or API key is available, mindkeeper falls back to template messages automatically.
70
+
47
71
  ## Links
48
72
 
49
73
  - [GitHub](https://github.com/seekcontext/mindkeeper)
50
74
  - [Core CLI](https://www.npmjs.com/package/mindkeeper) — Standalone version without OpenClaw
75
+ - [Mindkeeper Skill](https://github.com/seekcontext/mindkeeper/blob/main/packages/openclaw/skills/mindkeeper/SKILL.md)
51
76
 
52
77
  ## License
53
78
 
package/dist/index.js CHANGED
@@ -504,6 +504,7 @@ var SENSITIVE_FIELDS = ["commitMessage.llm.apiKey"];
504
504
  var DEFAULT_CONFIG = {
505
505
  tracking: {
506
506
  include: [
507
+ ".mindkeeper.json",
507
508
  "AGENTS.md",
508
509
  "SOUL.md",
509
510
  "USER.md",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mindkeeper-openclaw",
3
- "version": "0.2.25",
3
+ "version": "0.2.26",
4
4
  "description": "OpenClaw plugin for mindkeeper: auto-snapshot, diff, and rollback for agent context files",
5
5
  "keywords": [
6
6
  "openclaw",
package/skills/mindkeeper/README.md CHANGED
@@ -1,22 +1,40 @@
1
1
  # Mindkeeper Skill
2
2
 
3
- Time Machine for Your AI's Brain — version control for agent context files. This skill teaches your AI to use mindkeeper tools for history, diff, rollback, and snapshots.
3
+ **Time Machine for Your AI's Brain** — install this skill if you want your AI to inspect history, show diffs, create checkpoints, and guide rollback in natural language.
4
4
 
5
- **Setup:** Add this skill alone. When you first ask for mindkeeper capability, the AI will ask for your confirmation before installing the mindkeeper-openclaw plugin and restarting the Gateway. You can also install the plugin manually (see Requirements).
5
+ This skill teaches the AI how to bootstrap and use the `mindkeeper-openclaw` plugin. It is the easiest way to get the OpenClaw Plugin experience without manually setting everything up first.
6
6
 
7
- ## What It Does
7
+ ## Why Use It
8
8
 
9
- - **Browse history** — See what changed in SOUL.md, AGENTS.md, or any tracked file
9
+ - **Guided setup** — the AI checks whether the plugin is available and walks through first-use install
10
+ - **Safe permissions model** — plugin install and Gateway restart always require explicit confirmation
11
+ - **Natural-language usage** — ask about changes, diffs, rollback, and checkpoints conversationally
12
+ - **Rollback guardrails** — preview first, confirm second
13
+
14
+ ## Install
15
+
16
+ ```bash
17
+ clawhub install mindkeeper
18
+ ```
19
+
20
+ On first use, the AI checks whether `mindkeeper-openclaw` is available. If it is missing, the AI asks for your confirmation before installing the plugin and before restarting Gateway. If automatic restart is unavailable, it tells you to restart Gateway manually.
21
+
22
+ ## What It Enables
23
+
24
+ - **Browse history** — See what changed in `SOUL.md`, `AGENTS.md`, or any tracked file
10
25
  - **Compare versions** — Full unified diff between any two commits
11
- - **Rollback** — Restore any file to a previous version (with preview + confirmation)
26
+ - **Rollback** — Restore any file to a previous version with preview + confirmation
12
27
  - **Named snapshots** — Create checkpoints before risky changes
28
+ - **LLM commit messages** — Available in OpenClaw Plugin mode using your existing OpenClaw model and auth settings
13
29
 
14
30
  ## Requirements
15
31
 
16
- - Node.js ≥ 22
32
+ - Node.js >= 22
17
33
  - OpenClaw with Gateway running
18
34
 
19
- The mindkeeper-openclaw plugin provides the mind_* tools. The AI will ask for your confirmation before running `openclaw plugins install mindkeeper-openclaw` and restarting the Gateway on first use. Alternatively, install it yourself:
35
+ The `mindkeeper-openclaw` plugin provides the actual `mind_*` tools and background watcher. This skill provides the guidance and first-use bootstrap behavior.
36
+
37
+ If you prefer to install the plugin yourself first:
20
38
 
21
39
  ```bash
22
40
  openclaw plugins install mindkeeper-openclaw
@@ -27,15 +45,15 @@ openclaw plugins install mindkeeper-openclaw
27
45
 
28
46
  | Action | Purpose |
29
47
  |--------|---------|
30
- | `openclaw plugins install mindkeeper-openclaw` | Fetches the official plugin from npm to add mind_status, mind_history, mind_diff, mind_rollback, mind_snapshot tools |
48
+ | `openclaw plugins install mindkeeper-openclaw` | Fetches the official plugin and makes the `mind_*` tools available |
31
49
  | Gateway restart | Loads the newly installed plugin into the running Gateway |
32
50
 
33
- **User consent:** The AI will not run these commands until you explicitly confirm. This ensures you control when plugins are installed and when the Gateway restarts.
51
+ **User consent is required** before either action runs.
34
52
 
35
53
  ## How to Use
36
54
 
37
- 1. Install this skill: `clawhub install mindkeeper`
38
- 2. Ask your AI in natural language. On first use, the AI will ask for confirmation before installing the plugin and restarting the Gateway:
55
+ 1. Install the skill: `clawhub install mindkeeper`
56
+ 2. Ask your AI in natural language:
39
57
  - "What changed in SOUL.md recently?"
40
58
  - "Compare my current AGENTS.md to last week's version"
41
59
  - "Roll back SOUL.md to yesterday"
@@ -44,17 +62,17 @@ openclaw plugins install mindkeeper-openclaw
44
62
  ## Examples
45
63
 
46
64
  | User says | AI action |
47
- |-----------|------------|
48
- | "What changed in SOUL.md?" | `mind_history` with file filter |
65
+ |-----------|-----------|
66
+ | "What changed in SOUL.md?" | `mind_history` with a file filter |
49
67
  | "Show me the diff from last week" | `mind_history` → find commit → `mind_diff` |
50
- | "Undo that change" | `mind_rollback` (preview first, then execute) |
51
- | "Save a checkpoint before I experiment" | `mind_snapshot` with descriptive name |
68
+ | "Undo that change" | `mind_rollback` preview first, then execute after confirmation |
69
+ | "Save a checkpoint before I experiment" | `mind_snapshot` with a descriptive name |
52
70
 
53
71
  ## Troubleshooting
54
72
 
55
- - **History is empty** — Call `mind_status` to check if mindkeeper is initialized. Make a small edit to a tracked file to trigger the first snapshot.
56
- - **Tools not found** — Ensure the mindkeeper-openclaw plugin is installed and Gateway has been restarted.
57
- - **Rollback not applying** — After rollback, tell the user to run `/new` to reload the session with the restored file.
73
+ - **History is empty** — Call `mind_status` to check whether mindkeeper is initialized. Make a small edit to a tracked file to trigger the first snapshot.
74
+ - **Tools not found** — Ensure the `mindkeeper-openclaw` plugin is installed and Gateway has been restarted.
75
+ - **Rollback not applying** — After rollback, run `/new` to reload the session with the restored file.
58
76
 
59
77
  ## Links
60
78
 
package/skills/mindkeeper/SKILL.md CHANGED
@@ -1,14 +1,14 @@
1
1
  ---
2
2
  name: mindkeeper
3
3
  description: Time Machine for Your AI's Brain — version control for agent context files. Use when the user asks about changes in SOUL.md, AGENTS.md, MEMORY.md, or other agent context files; when they want to undo, rollback, or compare versions; or when they need a checkpoint before risky edits.
4
- version: 1.2.1
4
+ version: 1.2.3
5
5
  homepage: https://github.com/seekcontext/mindkeeper
6
6
  repository: https://github.com/seekcontext/mindkeeper
7
7
  ---
8
8
 
9
9
  # Mindkeeper — Time Machine for Your AI's Brain
10
10
 
11
- Use mindkeeper tools when the user asks about changes, history, or versions of their agent context files (AGENTS.md, SOUL.md, USER.md, IDENTITY.md, TOOLS.md, MEMORY.md, memory/, skills/).
11
+ Use mindkeeper tools when the user asks about changes, history, or versions of their agent context files (`AGENTS.md`, `SOUL.md`, `USER.md`, `IDENTITY.md`, `TOOLS.md`, `HEARTBEAT.md`, `MEMORY.md`, `memory/`, `skills/`).
12
12
 
13
13
  ## Bootstrap (One-time setup)
14
14
 
@@ -21,8 +21,8 @@ Use mindkeeper tools when the user asks about changes, history, or versions of t
21
21
  ```bash
22
22
  openclaw plugins install mindkeeper-openclaw
23
23
  ```
24
- - **Restart the gateway** — Use the `gateway` tool with `action: "restart"` and `note: "Restarting to load mindkeeper plugin"`. If gateway restart is disabled or fails, tell the user: "Plugin installed. Restart your Gateway manually to apply."
25
- - **Confirm** — Tell the user: "Mindkeeper is ready. Restart complete — you can now ask about history, diffs, rollbacks, or snapshots."
24
+ - **Restart Gateway if the runtime supports it** — Use the available runtime mechanism to restart Gateway. If restart is unavailable or fails, tell the user: "Plugin installed. Restart your Gateway manually to apply."
25
+ - **Confirm** — If restart succeeded, tell the user: "Mindkeeper is ready. Restart complete — you can now ask about history, diffs, rollbacks, or snapshots." If restart did not happen, tell the user that the plugin is installed but Gateway must be restarted before the tools will appear.
26
26
 
27
27
  3. **Alternative** — If the user prefers to install manually, tell them: "Run `openclaw plugins install mindkeeper-openclaw` in your terminal, then restart your Gateway. After that, mindkeeper will be ready."
28
28
 
@@ -38,6 +38,17 @@ If `mind_status` succeeds, the plugin is already installed; skip the bootstrap a
38
38
  | `mind_rollback` | Restore a file to a previous version (always preview first) |
39
39
  | `mind_snapshot` | Save a named checkpoint before making significant changes |
40
40
 
41
+ ## Tracking Scope
42
+
43
+ Mindkeeper tracks these files by default:
44
+
45
+ - `AGENTS.md`, `SOUL.md`, `USER.md`, `IDENTITY.md`
46
+ - `TOOLS.md`, `HEARTBEAT.md`, `MEMORY.md`
47
+ - `memory/**/*.md`
48
+ - `skills/**/*.md`
49
+
50
+ Excluded by default: `BOOTSTRAP.md`, `canvas/**`, `.git/`, `.mindkeeper/`.
51
+
41
52
  ## When to Use
42
53
 
43
54
  | User says… | Action |
@@ -105,9 +116,11 @@ After success, tell the user: **"Run `/new` to apply the changes to your current
105
116
 
106
117
  ## Important Notes
107
118
 
119
+ - **This skill is the guide, the plugin is the engine** — the `mindkeeper-openclaw` plugin provides the actual `mind_*` tools and watcher; this skill teaches the AI how to bootstrap and use them safely
108
120
  - **Rollback is per-file** — it only restores the specified file, not all files at once
109
121
  - **Rollbacks are non-destructive** — every rollback creates a new commit, so it can itself be undone
110
122
  - **Auto-snapshots run in the background** — the user doesn't need to manually save; mindkeeper captures every change automatically
123
+ - **LLM commit messages are plugin-only for now** — currently supported only through the OpenClaw plugin; standalone CLI mode falls back to template messages
111
124
  - **Named snapshots are the safety net** — encourage users to snapshot before major personality or rule changes
112
125
  - **If history is empty** — mindkeeper may not have initialized yet, or no changes have been made since install. Call `mind_status` to check.
113
126
  - **Commit hashes** — always use the `oid` field from `mind_history` results. Short 8-character hashes are fine.
package/skills/mindkeeper/clawhub.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "Mindkeeper",
3
3
  "tagline": "Time Machine for Your AI's Brain",
4
- "description": "Time Machine for Your AI's Brain — version control for agent context files. Every change to AGENTS.md, SOUL.md, MEMORY.md, skills, and other context files is automatically tracked. Your AI can browse history, compare versions with diff, create named checkpoints, and roll back any file to any previous state.\n\nSetup: add this skill alone. When the user first asks for mindkeeper, the AI will ask for explicit confirmation before installing the mindkeeper-openclaw plugin and restarting the Gateway. User consent is required for plugin install and Gateway restart.\n\nUse this skill when the user asks about changes, history, or versions of their agent context files. The AI learns to use mind_status, mind_history, mind_diff, mind_rollback, and mind_snapshot tools.",
4
+ "description": "Time Machine for Your AI's Brain — install this skill if you want your AI to inspect history, show diffs, create checkpoints, and guide rollback in natural language across agent context files.\n\nSetup: add this skill alone. On first use, the AI checks whether the mindkeeper-openclaw plugin is available. If it is not, the AI asks for explicit confirmation before installing the plugin and before restarting Gateway. User consent is required for plugin install and Gateway restart.\n\nUse this skill when the user asks about changes, history, or versions of their agent context files. The skill teaches the AI how to bootstrap and use the mind_status, mind_history, mind_diff, mind_rollback, and mind_snapshot tools safely.",
5
5
  "category": "productivity",
6
6
  "tags": ["version-control", "agent", "history", "rollback", "snapshot", "diff", "openclaw"],
7
- "version": "1.2.1",
7
+ "version": "1.2.3",
8
8
  "license": "MIT",
9
9
  "pricing": "free",
10
10
  "homepage": "https://github.com/seekcontext/mindkeeper",