Skip to content

Commit d4c475a

Browse files
committed
docs(codex): expand evolve lite readme
1 parent cb742e4 commit d4c475a

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

  • platform-integrations/codex/plugins/evolve-lite

platform-integrations/codex/plugins/evolve-lite/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,10 @@ This removes both `.evolve/subscribed/{name}/` and its mirrored recall copy unde
174174
her-guideline.md # mirrored for recall, annotated [from: alice]
175175
```
176176

177+
## Example Walkthrough
178+
179+
See the [Codex example walkthrough](../../../../docs/examples/hello_world/codex.md) for a step-by-step example showing the save-then-recall loop in a Codex workspace.
180+
177181
## Included Skills
178182

179183
### `evolve-lite:learn`
@@ -199,3 +203,56 @@ Remove a configured subscription and delete its local clones and mirrored recall
199203
### `evolve-lite:sync`
200204

201205
Pull every configured subscription and mirror its markdown files into `.evolve/entities/subscribed/` so recall can include them automatically.
206+
207+
## Environment Variables
208+
209+
- `EVOLVE_DIR`: Override the default `.evolve` directory location for entities, sharing data, audit logs, and the mirrored subscription store.
210+
211+
## Verification
212+
213+
After installation, verify that:
214+
215+
- `plugins/evolve-lite/` exists in the repo
216+
- `.agents/plugins/marketplace.json` contains the `evolve-lite` entry
217+
- `.codex/hooks.json` contains the Evolve `UserPromptSubmit` and `SessionStart` hooks
218+
219+
You can also run:
220+
221+
```bash
222+
platform-integrations/install.sh status
223+
```
224+
225+
## Plugin Structure
226+
227+
```text
228+
evolve-lite/
229+
├── .codex-plugin/
230+
│ └── plugin.json
231+
├── skills/
232+
│ ├── learn/
233+
│ │ ├── SKILL.md
234+
│ │ └── scripts/
235+
│ │ └── save_entities.py
236+
│ ├── recall/
237+
│ │ ├── SKILL.md
238+
│ │ └── scripts/
239+
│ │ └── retrieve_entities.py
240+
│ ├── publish/
241+
│ │ ├── SKILL.md
242+
│ │ └── scripts/
243+
│ │ └── publish.py
244+
│ ├── subscribe/
245+
│ │ ├── SKILL.md
246+
│ │ └── scripts/
247+
│ │ └── subscribe.py
248+
│ ├── unsubscribe/
249+
│ │ ├── SKILL.md
250+
│ │ └── scripts/
251+
│ │ └── unsubscribe.py
252+
│ └── sync/
253+
│ ├── SKILL.md
254+
│ └── scripts/
255+
│ └── sync.py
256+
├── README.md
257+
└── lib/ # copied in at install time from the Claude plugin
258+
```

0 commit comments

Comments
 (0)