Add README + Quickstart sections for agent execution

This commit is contained in:
2026-06-28 13:49:06 -04:00
parent 6a8a2c61da
commit 94b3bf84b4
3 changed files with 194 additions and 0 deletions
+36
View File
@@ -8,6 +8,42 @@ description: >
exceeds 85% or on explicit user request ("memory audit", "memory maintenance").
---
## Quickstart — How to Run This Contract
### For the Agent Running This Contract
Read this section first. It tells you exactly what to do.
**When to run:**
- User says: `"memory audit"`, `"memory maintenance"`, `"clean up memory"`, `"memory is full"`
- You detect that your `memory` store usage exceeds 85% in a write attempt
- It's been 2+ weeks since the last audit
**How to run (via OpenProse CLI):**
```bash
# Default — 85% threshold, verify configs, compress entries
prose run memory-audit-maintenance
# Softer audit — only flag issues, don't rewrite files
prose run memory-audit-maintenance compress_entries=false
# Hard audit — stricter limits
prose run memory-audit-maintenance memory_threshold=90 max_memory_chars=800 max_user_chars=300
```
### How to Follow the Template (Manual)
If `prose` CLI is not available:
1. **Read both memory files:** `cat ~/.hermes/memories/MEMORY.md` and `cat ~/.hermes/memories/USER.md`
2. **Check in-memory usage:** Use the `memory` tool with no args
3. **Categorize every entry** using the Categorization Guide below
4. **Rewrite MEMORY.md** — technical configs only, 8001,100 chars max
5. **Rewrite USER.md** — identity + preferences only, 300500 chars max
6. **Verify live configs** — curl each endpoint, check each model
7. **Sync in-memory** — Add summary markers (or just leave file as source of truth)
8. **Report** using the Example Output template at the bottom
## Maintains
- last_audit: timestamp — When the last full audit was completed