Skip to content

Commit 23b2a33

Browse files
authored
Refactor README to include new features and structure
1 parent 12a9065 commit 23b2a33

1 file changed

Lines changed: 53 additions & 51 deletions

File tree

README.md

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -25,57 +25,6 @@ Follow me on [@AV1DLIVE](https://twitter.com/AV1DLIVE) for updates/collabs on pr
2525
Based on the article:
2626
**["The Agentic Stack"](https://x.com/Av1dlive/status/2044453102703841645?s=20)** · by [@AV1DLIVE](https://twitter.com/AV1DLIVE)
2727

28-
---
29-
30-
## What this is
31-
32-
Every guide shows the folder structure. This repo gives you the folder
33-
structure **plus the files that actually go inside**: a working portable
34-
brain with five seed skills, four memory layers, enforced permissions, a
35-
nightly staging cycle, host-agent review tools, and adapters for eight
36-
harnesses.
37-
38-
- **Memory**`working/`, `episodic/`, `semantic/`, `personal/`. Each
39-
layer has its own retention policy. Query-aware retrieval (salience ×
40-
relevance); nightly compression into reviewable candidates.
41-
- **Review protocol**`auto_dream.py` stages candidate lessons
42-
mechanically. Your host agent reviews them via CLI tools
43-
(`graduate.py`, `reject.py`, `reopen.py`) and commits decisions with
44-
a required rationale. No unattended reasoning, no provider coupling.
45-
- **Skills** — progressive disclosure. A lightweight manifest always
46-
loads; full `SKILL.md` files only load when triggers match the task.
47-
Every skill ships with a self-rewrite hook.
48-
- **Protocols** — typed tool schemas, a `permissions.md` that the
49-
pre-tool-call hook enforces, and a delegation contract for sub-agents.
50-
51-
## What's new in v0.6.0
52-
53-
- **Pi Coding Agent adapter.** `./install.sh pi` drops `AGENTS.md` and
54-
symlinks `.pi/skills` to `.agent/skills` so pi sees the full brain
55-
with zero duplication. Safe to install alongside hermes/opencode
56-
(they all read `AGENTS.md`; we skip the overwrite if one exists).
57-
- **OpenClient → OpenClaw.** Adapter renamed across the board.
58-
Installed file changed: `.openclient-system.md``.openclaw-system.md`.
59-
Breaking for existing OpenClient users — re-run `./install.sh openclaw`.
60-
61-
## What's new in v0.5.0
62-
63-
- **Host-agent review protocol.** Python handles filing (cluster, stage,
64-
heuristic prefilter, decay). The host agent handles reasoning via
65-
`list_candidates.py` / `graduate.py` / `reject.py` / `reopen.py`.
66-
Graduation requires `--rationale` so rubber-stamping is structurally
67-
impossible.
68-
- **Structured `lessons.jsonl` as source of truth.** `LESSONS.md` is
69-
rendered from it. Hand-curated content above the sentinel is
70-
preserved across renders; legacy bullets auto-migrate on first run.
71-
- **Content clustering.** Proper single-linkage Jaccard with bridge
72-
merging. Pattern IDs derived from canonical claim + conditions, stable
73-
across cluster-membership changes.
74-
- **[BETA] FTS5 memory search.** Opt-in full-text search over all
75-
`.md` / `.jsonl` memory documents. Default **off**; enable during
76-
onboarding or edit `.agent/memory/.features.json` directly.
77-
- **Windows-native installer.** `install.ps1` runs natively in
78-
PowerShell; `install.sh` continues to work under Git Bash / WSL.
7928

8029
## Quickstart
8130

@@ -176,6 +125,59 @@ decision history so recurring churn is visible, not fresh.
176125

177126
See [`docs/architecture.md`](docs/architecture.md) for the full lifecycle.
178127

128+
---
129+
130+
## What this is
131+
132+
Every guide shows the folder structure. This repo gives you the folder
133+
structure **plus the files that actually go inside**: a working portable
134+
brain with five seed skills, four memory layers, enforced permissions, a
135+
nightly staging cycle, host-agent review tools, and adapters for eight
136+
harnesses.
137+
138+
- **Memory**`working/`, `episodic/`, `semantic/`, `personal/`. Each
139+
layer has its own retention policy. Query-aware retrieval (salience ×
140+
relevance); nightly compression into reviewable candidates.
141+
- **Review protocol**`auto_dream.py` stages candidate lessons
142+
mechanically. Your host agent reviews them via CLI tools
143+
(`graduate.py`, `reject.py`, `reopen.py`) and commits decisions with
144+
a required rationale. No unattended reasoning, no provider coupling.
145+
- **Skills** — progressive disclosure. A lightweight manifest always
146+
loads; full `SKILL.md` files only load when triggers match the task.
147+
Every skill ships with a self-rewrite hook.
148+
- **Protocols** — typed tool schemas, a `permissions.md` that the
149+
pre-tool-call hook enforces, and a delegation contract for sub-agents.
150+
151+
## What's new in v0.6.0
152+
153+
- **Pi Coding Agent adapter.** `./install.sh pi` drops `AGENTS.md` and
154+
symlinks `.pi/skills` to `.agent/skills` so pi sees the full brain
155+
with zero duplication. Safe to install alongside hermes/opencode
156+
(they all read `AGENTS.md`; we skip the overwrite if one exists).
157+
- **OpenClient → OpenClaw.** Adapter renamed across the board.
158+
Installed file changed: `.openclient-system.md``.openclaw-system.md`.
159+
Breaking for existing OpenClient users — re-run `./install.sh openclaw`.
160+
161+
## What's new in v0.5.0
162+
163+
- **Host-agent review protocol.** Python handles filing (cluster, stage,
164+
heuristic prefilter, decay). The host agent handles reasoning via
165+
`list_candidates.py` / `graduate.py` / `reject.py` / `reopen.py`.
166+
Graduation requires `--rationale` so rubber-stamping is structurally
167+
impossible.
168+
- **Structured `lessons.jsonl` as source of truth.** `LESSONS.md` is
169+
rendered from it. Hand-curated content above the sentinel is
170+
preserved across renders; legacy bullets auto-migrate on first run.
171+
- **Content clustering.** Proper single-linkage Jaccard with bridge
172+
merging. Pattern IDs derived from canonical claim + conditions, stable
173+
across cluster-membership changes.
174+
- **[BETA] FTS5 memory search.** Opt-in full-text search over all
175+
`.md` / `.jsonl` memory documents. Default **off**; enable during
176+
onboarding or edit `.agent/memory/.features.json` directly.
177+
- **Windows-native installer.** `install.ps1` runs natively in
178+
PowerShell; `install.sh` continues to work under Git Bash / WSL.
179+
180+
179181
## Memory search `[BETA]`
180182

181183
Opt-in FTS5 keyword search over all memory documents:

0 commit comments

Comments
 (0)