Skip to content

Commit a548354

Browse files
Grivnclaude
andcommitted
OpenClaw skill: add install specs and setup guide
Add standard OpenClaw install metadata (brew, go) to SKILL.md frontmatter so OpenClaw can auto-detect and offer installation. Add Install & Configure section with one-command setup, plugin config reference, and uninstall. Update README to reflect fully automated OpenClaw integration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6d5aef8 commit a548354

2 files changed

Lines changed: 78 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,10 @@ mnemon setup
8383
### [OpenClaw](https://github.com/openclaw/openclaw)
8484

8585
```bash
86-
mnemon setup --target openclaw
86+
mnemon setup --target openclaw --yes
8787
```
8888

89-
This installs the skill and deploys a behavioral guide to `~/.mnemon/prompt/guide.md`. Since hook integration is not yet automated for OpenClaw, provide the guide to your agent and let it self-configure:
90-
91-
> Read `~/.mnemon/prompt/guide.md` and configure yourself to follow its recall/remember workflow.
89+
One command deploys skill, hook, plugin, and behavioral guide to `~/.openclaw/`. Restart the OpenClaw gateway to activate.
9290

9391
### Uninstall
9492

internal/setup/assets/openclaw/SKILL.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,86 @@ metadata:
66
emoji: "🧠"
77
requires:
88
bins: ["mnemon"]
9+
install:
10+
- id: "brew"
11+
kind: "brew"
12+
formula: "mnemon-dev/tap/mnemon"
13+
bins: ["mnemon"]
14+
label: "Install mnemon (Homebrew)"
15+
- id: "go"
16+
kind: "go"
17+
package: "github.com/mnemon-dev/mnemon@latest"
18+
bins: ["mnemon"]
19+
label: "Install mnemon (go install)"
920
---
1021

1122
# mnemon
1223

24+
## Install & Configure
25+
26+
### 1. Install the binary
27+
28+
**Homebrew** (macOS / Linux):
29+
30+
```bash
31+
brew install mnemon-dev/tap/mnemon
32+
```
33+
34+
**Go install**:
35+
36+
```bash
37+
go install github.com/mnemon-dev/mnemon@latest
38+
```
39+
40+
### 2. Set up OpenClaw integration
41+
42+
```bash
43+
mnemon setup --target openclaw --yes
44+
```
45+
46+
This single command deploys all components:
47+
- **Skill**`~/.openclaw/skills/mnemon/SKILL.md`
48+
- **Hook**`~/.openclaw/hooks/mnemon-prime/` (agent:bootstrap — injects behavioral guide)
49+
- **Plugin**`~/.openclaw/extensions/mnemon/` (remind, nudge, compact hooks)
50+
- **Prompts**`~/.mnemon/prompt/` (guide.md, skill.md)
51+
52+
Restart the OpenClaw gateway to activate.
53+
54+
### 3. Customize (optional)
55+
56+
Edit `~/.mnemon/prompt/guide.md` to tune recall/remember behavior.
57+
58+
Plugin hooks are configured in `~/.openclaw/openclaw.json`:
59+
60+
```json
61+
{
62+
"plugins": {
63+
"entries": {
64+
"mnemon": {
65+
"enabled": true,
66+
"config": {
67+
"remind": true,
68+
"nudge": true,
69+
"compact": false
70+
}
71+
}
72+
}
73+
}
74+
}
75+
```
76+
77+
| Hook | Default | Description |
78+
|------|---------|-------------|
79+
| `remind` | on | Recall relevant memories + remind agent on each message |
80+
| `nudge` | on | Suggest remember sub-agent after each reply |
81+
| `compact` | off | Save key insights before context compaction |
82+
83+
### 4. Uninstall
84+
85+
```bash
86+
mnemon setup --eject --target openclaw --yes
87+
```
88+
1389
## Workflow
1490

1591
1. **Remember**: `mnemon remember "<fact>" --cat <cat> --imp <1-5> --entities "e1,e2" --source agent`

0 commit comments

Comments
 (0)