Skip to content

Commit 4d3e379

Browse files
committed
update README
1 parent d024205 commit 4d3e379

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
CodexOpt: Optimize your Agents.MD and Skills for Codex with GEPA
44

5+
## Demo Repo
6+
7+
Want to see CodexOpt on a small, intentionally messy repository with sample
8+
`AGENTS.md`, demo skills, `tasks.md`, and `issues.md`?
9+
10+
- Demo: https://github.com/SuperagenticAI/codexopt-demo
11+
512
CodexOpt is a lightweight Python CLI to improve Codex instruction assets with a repeatable loop:
613

714
1. Scan instruction files.
@@ -294,11 +301,44 @@ The best candidate is selected by score delta. If delta is below `min_apply_delt
294301

295302
CodexOpt can call `gepa.optimize_anything` when `--engine gepa` is selected.
296303

304+
The GEPA path is model-agnostic. In practice, teams can use any reflection model
305+
supported by their GEPA / LiteLLM setup, including OpenAI, Gemini, local models,
306+
or other compatible providers. That means you can ask GEPA to generate feedback
307+
and candidate improvements using whichever model gives you the best quality /
308+
cost tradeoff for your workflow.
309+
297310
Requirements:
298311

299312
- `gepa` installed in the environment.
300313
- A valid reflection model via `--reflection-model` or config.
301314

315+
Common examples:
316+
317+
```yaml
318+
optimization:
319+
engine: "gepa"
320+
reflection_model: "openai/gpt-5-mini"
321+
```
322+
323+
```yaml
324+
optimization:
325+
engine: "gepa"
326+
reflection_model: "gemini/gemini-2.5-pro"
327+
```
328+
329+
For OpenAI-backed GEPA runs, set:
330+
331+
```bash
332+
export OPENAI_API_KEY="your-openai-key"
333+
```
334+
335+
For Gemini-backed GEPA runs, set:
336+
337+
```bash
338+
export GEMINI_API_KEY="your-gemini-key"
339+
export GOOGLE_API_KEY="$GEMINI_API_KEY"
340+
```
341+
302342
Fallback behavior:
303343

304344
- If GEPA is unavailable or errors, CodexOpt falls back to heuristic optimization.

0 commit comments

Comments
 (0)