@soulguard/openclaw 0.1.4 โ 0.2.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 +1 -57
- package/dist/index.js +548 -1622
- package/dist/openclaw.plugin.json +11 -0
- package/package.json +3 -3
- package/src/context.test.ts +92 -0
- package/src/context.ts +43 -0
- package/src/guard.test.ts +41 -15
- package/src/guard.ts +31 -23
- package/src/index.ts +6 -4
- package/src/openclaw-types.ts +3 -1
- package/src/plugin.ts +25 -108
- package/src/templates.test.ts +17 -21
- package/src/templates.ts +89 -98
package/README.md
CHANGED
|
@@ -1,59 +1,3 @@
|
|
|
1
1
|
# @soulguard/openclaw
|
|
2
2
|
|
|
3
|
-
OpenClaw
|
|
4
|
-
|
|
5
|
-
For the core system, see [@soulguard/core](../core/).
|
|
6
|
-
|
|
7
|
-
## Protection Templates
|
|
8
|
-
|
|
9
|
-
Templates define which paths go to vault, ledger, or are left unprotected. Every known path is explicitly categorized โ no silent omissions.
|
|
10
|
-
|
|
11
|
-
| Path | Relaxed | Default | Paranoid |
|
|
12
|
-
| --------------- | :-----: | :-----: | :------: |
|
|
13
|
-
| **Identity** | | | |
|
|
14
|
-
| SOUL.md | ๐ | ๐ | ๐ |
|
|
15
|
-
| AGENTS.md | ๐ | ๐ | ๐ |
|
|
16
|
-
| IDENTITY.md | ๐ | ๐ | ๐ |
|
|
17
|
-
| USER.md | ๐ | ๐ | ๐ |
|
|
18
|
-
| **Session** | | | |
|
|
19
|
-
| TOOLS.md | ๐ | ๐ | ๐ |
|
|
20
|
-
| HEARTBEAT.md | ๐ | ๐ | ๐ |
|
|
21
|
-
| BOOTSTRAP.md | ๐ | ๐ | ๐ |
|
|
22
|
-
| **Memory** | | | |
|
|
23
|
-
| MEMORY.md | ๐ | ๐ | ๐ |
|
|
24
|
-
| memory/\*\* | ๐ | ๐ | ๐ |
|
|
25
|
-
| **Skills** | | | |
|
|
26
|
-
| skills/\*\* | ๐ | ๐ | ๐ |
|
|
27
|
-
| **Config** | | | |
|
|
28
|
-
| soulguard.json | ๐ | ๐ | ๐ |
|
|
29
|
-
| openclaw.json | ๐ | ๐ | ๐ |
|
|
30
|
-
| cron/jobs.json | ๐ | ๐ | ๐ |
|
|
31
|
-
| extensions/\*\* | ๐ | ๐ | ๐ |
|
|
32
|
-
| **Other** | | | |
|
|
33
|
-
| sessions/\*\* | โ | โ | ๐ |
|
|
34
|
-
|
|
35
|
-
๐ Vault (requires owner approval) ยท ๐ Ledger (tracked, agent writes freely) ยท โ Unprotected
|
|
36
|
-
|
|
37
|
-
**Relaxed** โ Onboarding mode. Only `soulguard.json` is locked. Everything else tracked.
|
|
38
|
-
|
|
39
|
-
**Default** โ Steady state. Identity files and config locked. Memory and skills tracked.
|
|
40
|
-
|
|
41
|
-
**Paranoid** โ Maximum lockdown. Everything vaulted except sessions.
|
|
42
|
-
|
|
43
|
-
## Plugin
|
|
44
|
-
|
|
45
|
-
The OpenClaw plugin integrates soulguard into the agent runtime:
|
|
46
|
-
|
|
47
|
-
- `before_tool_call` hook intercepts Write/Edit tool calls targeting vault files and redirects to staging
|
|
48
|
-
- Reports soulguard status (vault/ledger health) in agent context
|
|
49
|
-
- Provides helpful error messages guiding the agent to the staging workflow
|
|
50
|
-
|
|
51
|
-
## Why a Plugin?
|
|
52
|
-
|
|
53
|
-
Soulguard's core provides hard security via OS file permissions. The agent literally cannot write to vault files. But without the plugin, the agent sees raw `Permission denied` errors and may waste tokens retrying. The plugin:
|
|
54
|
-
|
|
55
|
-
1. Tells the agent _why_ the write failed
|
|
56
|
-
2. Guides it to edit `.soulguard/staging/` instead
|
|
57
|
-
3. Provides soulguard operations as native tools
|
|
58
|
-
|
|
59
|
-
The plugin adds zero security responsibility โ if it has bugs, vault files are still protected by OS permissions.
|
|
3
|
+
OpenClaw plugin for [Soulguard](https://github.com/mirascope/soulguard) โ identity protection for AI agents. See the [main README](../../README.md) for full documentation.
|