Skip to content

Commit c67629f

Browse files
committed
docs: surface Codex harness quick config
1 parent 148a346 commit c67629f

1 file changed

Lines changed: 46 additions & 43 deletions

File tree

docs/plugins/codex-harness.md

Lines changed: 46 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,52 @@ If you are trying to orient yourself, start with
2020
`openai/gpt-5.5` is the model ref, `codex` is the runtime, and Telegram,
2121
Discord, Slack, or another channel remains the communication surface.
2222

23+
## Quick config
24+
25+
To use the Codex harness for GPT agent turns, keep the model ref canonical as
26+
`openai/gpt-*`, enable the bundled `codex` plugin, and set
27+
`agentRuntime.id: "codex"`:
28+
29+
```json5
30+
{
31+
plugins: {
32+
entries: {
33+
codex: {
34+
enabled: true,
35+
},
36+
},
37+
},
38+
agents: {
39+
defaults: {
40+
model: "openai/gpt-5.5",
41+
agentRuntime: {
42+
id: "codex",
43+
fallback: "none",
44+
},
45+
},
46+
},
47+
}
48+
```
49+
50+
If your config uses `plugins.allow`, include `codex` there too:
51+
52+
```json5
53+
{
54+
plugins: {
55+
allow: ["codex"],
56+
entries: {
57+
codex: {
58+
enabled: true,
59+
},
60+
},
61+
},
62+
}
63+
```
64+
65+
Do not use `openai-codex/gpt-*` for this path. That selects Codex OAuth through
66+
the normal PI runner unless you separately force a runtime. Config changes apply
67+
to new or reset sessions; existing sessions keep their recorded runtime.
68+
2369
## What this plugin changes
2470

2571
The bundled `codex` plugin contributes several separate capabilities:
@@ -192,49 +238,6 @@ For live and Docker smoke tests, auth usually comes from the Codex CLI account
192238
or an OpenClaw `openai-codex` auth profile. Local stdio app-server launches can
193239
also fall back to `CODEX_API_KEY` / `OPENAI_API_KEY` when no account is present.
194240

195-
## Minimal config
196-
197-
Use `openai/gpt-5.5`, enable the bundled plugin, and force the `codex` harness:
198-
199-
```json5
200-
{
201-
plugins: {
202-
entries: {
203-
codex: {
204-
enabled: true,
205-
},
206-
},
207-
},
208-
agents: {
209-
defaults: {
210-
model: "openai/gpt-5.5",
211-
agentRuntime: {
212-
id: "codex",
213-
},
214-
},
215-
},
216-
}
217-
```
218-
219-
If your config uses `plugins.allow`, include `codex` there too:
220-
221-
```json5
222-
{
223-
plugins: {
224-
allow: ["codex"],
225-
entries: {
226-
codex: {
227-
enabled: true,
228-
},
229-
},
230-
},
231-
}
232-
```
233-
234-
Legacy configs that set `agents.defaults.model` or an agent model to
235-
`codex/<model>` still auto-enable the bundled `codex` plugin. New configs should
236-
prefer `openai/<model>` plus the explicit `agentRuntime` entry above.
237-
238241
## Add Codex alongside other models
239242

240243
Do not set `agentRuntime.id: "codex"` globally if the same agent should freely switch

0 commit comments

Comments
 (0)