Skip to content

Commit 2fe4a5b

Browse files
Merge pull request #5 from Light-Heart-Labs/add-guardian-v2
Improve repo discoverability: tagline, component table, Quick Start p…
2 parents 0d9bd1e + fe1a378 commit 2fe4a5b

2 files changed

Lines changed: 40 additions & 5 deletions

File tree

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# LightHeart OpenClaw
22

3-
**Your agents never crash from context overflow again.**
3+
**Keep your AI agents running. No matter what they do to themselves.**
44

5-
An open source toolkit for [OpenClaw](https://openclaw.io) agents. Session lifecycle management, API cost monitoring, local model tool-calling fixes, golden configs, and everything else you need to run OpenClaw agents that don't fall over.
5+
An open source operations toolkit for persistent LLM agents. Built for [OpenClaw](https://openclaw.io) but many components work with any agent framework or service stack.
6+
7+
| Component | What it does | Requires OpenClaw? | Platform |
8+
|-----------|-------------|-------------------|----------|
9+
| [Session Watchdog](#session-watchdog) | Auto-cleans bloated sessions before context overflow | Yes | Linux, Windows |
10+
| [vLLM Tool Call Proxy](#vllm-tool-call-proxy-v4) | Makes local model tool calling work | Yes | Linux |
11+
| [Token Spy](#token-spy--api-cost--usage-monitor) | API cost monitoring with real-time dashboard | No (any OpenAI/Anthropic client) | Linux |
12+
| [Guardian](#guardian) | Self-healing process watchdog with backup restore | No (any Linux services) | Linux (root) |
13+
| [Memory Shepherd](#memory-shepherd) | Periodic memory reset to prevent agent drift | No (any markdown-based agent memory) | Linux |
14+
| [Golden Configs](#golden-configs) | Working config templates for OpenClaw + vLLM | Yes | Any |
15+
| [Workspace Templates](#workspace-templates) | Agent personality/identity starter files | Yes | Any |
616

717
---
818

@@ -32,12 +42,12 @@ Starter personality files (`SOUL.md`, `IDENTITY.md`, `TOOLS.md`, `MEMORY.md`) th
3242
### Memory Shepherd
3343
Periodic memory reset for persistent LLM agents. Agents accumulate scratch notes in `MEMORY.md` during operation — Memory Shepherd archives those notes and restores the file to a curated baseline on a schedule. Keeps agents on-mission by preventing context drift, memory bloat, and self-modification of instructions.
3444

35-
Defines a `---` separator convention: everything above is operator-controlled identity (rules, capabilities, pointers), everything below is agent scratch space that gets archived and cleared.
45+
Defines a `---` separator convention: everything above is operator-controlled identity (rules, capabilities, pointers), everything below is agent scratch space that gets archived and cleared. See [memory-shepherd/README.md](memory-shepherd/README.md) for full documentation.
3646

3747
### Guardian
3848
Self-healing process watchdog for LLM infrastructure. Runs as a root systemd service that agents cannot kill or modify. Monitors processes, systemd services, Docker containers, and file integrity — automatically restoring from known-good backups when things break.
3949

40-
Supports tiered health checks (port listening, HTTP endpoints, custom commands, JSON validation), a recovery cascade (soft restart → backup restore → restart), generational backups with immutable flags, and restart delegation chains. Everything is config-driven via an INI file.
50+
Supports tiered health checks (port listening, HTTP endpoints, custom commands, JSON validation), a recovery cascade (soft restart → backup restore → restart), generational backups with immutable flags, and restart delegation chains. Everything is config-driven via an INI file. See [guardian/README.md](guardian/README.md) for full documentation.
4151

4252
### Architecture Docs
4353
Deep-dive documentation on how OpenClaw talks to vLLM, why the proxy exists, how session files work, and the five failure points that kill local setups.
@@ -100,6 +110,29 @@ export VLLM_API_KEY=vllm-local
100110
openclaw agent --local --agent main -m 'What is 2+2?'
101111
```
102112

113+
### Option 4: Guardian (Process Watchdog)
114+
115+
Works with any Linux service stack — not OpenClaw-specific. See [guardian/README.md](guardian/README.md) for full docs.
116+
117+
```bash
118+
cd guardian
119+
cp guardian.conf.example guardian.conf
120+
nano guardian.conf # Define your monitored resources
121+
nano guardian.service # Add your paths to ReadWritePaths
122+
sudo ./install.sh # Installs to systemd as root service
123+
```
124+
125+
### Option 5: Memory Shepherd (Memory Reset)
126+
127+
Works with any agent that uses markdown memory files. See [memory-shepherd/README.md](memory-shepherd/README.md) for full docs.
128+
129+
```bash
130+
cd memory-shepherd
131+
cp memory-shepherd.conf.example memory-shepherd.conf
132+
nano memory-shepherd.conf # Define your agents and baselines
133+
sudo ./install.sh # Installs as systemd timer
134+
```
135+
103136
---
104137

105138
## Configuration

guardian/guardian.conf.example

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ max_soft_restarts=3
8282
restart_grace=15
8383

8484
# Example: file integrity with JSON validation
85+
# For file-integrity, "soft restart" IS a backup restore, so max_soft_restarts=0
86+
# skips the redundant phase and goes straight to restore.
8587
[my-settings]
8688
enabled=false
8789
type=file-integrity
@@ -90,7 +92,7 @@ protected_files=/opt/myapp/data/settings.json
9092
required_json_keys=session_limit,poll_interval,agents
9193
# Pin specific JSON values (dot-notation path=expected_value)
9294
# required_json_values=agents.defaults.model.primary=gpt-4
93-
max_soft_restarts=1
95+
max_soft_restarts=0
9496
restart_grace=5
9597

9698
# ============================================================================

0 commit comments

Comments
 (0)