Skip to content

Commit 8cd8574

Browse files
authored
docs: refresh config guidance for current main structure
1 parent ef44165 commit 8cd8574

File tree

10 files changed

+342
-1705
lines changed

10 files changed

+342
-1705
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ What the installer does:
3232

3333
- writes `~/.config/opencode/opencode.json`
3434
- backs up an existing config before changing it
35+
- normalizes the plugin entry to `"oc-chatgpt-multi-auth"`
3536
- clears the cached plugin copy so OpenCode reinstalls the latest package
3637

3738
## Example Usage
@@ -120,7 +121,7 @@ Start here if the plugin does not load or authenticate correctly:
120121

121122
Common first checks:
122123

123-
- confirm `"plugin": ["oc-chatgpt-multi-auth@latest"]` is present in your OpenCode config
124+
- confirm `"plugin": ["oc-chatgpt-multi-auth"]` is present in your OpenCode config
124125
- rerun `opencode auth login`
125126
- inspect `~/.opencode/logs/codex-plugin/` after running one request with `ENABLE_PLUGIN_REQUEST_LOGGING=1`
126127

config/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This directory contains the official OpenCode config templates for the ChatGPT C
66

77
| File | OpenCode version | Description |
88
|------|------------------|-------------|
9-
| [`opencode-modern.json`](./opencode-modern.json) | **v1.0.210+** | Variant-based config: 6 base models with 21 total presets |
10-
| [`opencode-legacy.json`](./opencode-legacy.json) | **v1.0.209 and below** | Legacy explicit entries: 21 individual model definitions |
9+
| [`opencode-modern.json`](./opencode-modern.json) | **v1.0.210+** | Variant-based config: 7 base models with 26 total presets |
10+
| [`opencode-legacy.json`](./opencode-legacy.json) | **v1.0.209 and below** | Legacy explicit entries: 26 individual model definitions |
1111

1212
## Quick pick
1313

@@ -34,11 +34,13 @@ opencode --version
3434
OpenCode v1.0.210+ added model `variants`, so one model entry can expose multiple reasoning levels. That keeps modern config much smaller while preserving the same effective presets.
3535

3636
Both templates include:
37-
- GPT-5.4, GPT-5 Codex, GPT-5.1, GPT-5.1 Codex, GPT-5.1 Codex Max, GPT-5.1 Codex Mini
37+
- GPT-5.4, GPT-5.4 Mini, GPT-5 Codex, GPT-5.1, GPT-5.1 Codex, GPT-5.1 Codex Max, GPT-5.1 Codex Mini
3838
- Reasoning variants per model family
3939
- `store: false` and `include: ["reasoning.encrypted_content"]`
4040
- Context metadata (`gpt-5.4*`: 1,000,000 context / 128,000 output; other shipped models: 272,000 / 128,000)
4141

42+
Use `opencode debug config` to verify that these template entries were merged into your effective config. `opencode models openai` currently shows OpenCode's built-in provider catalog and can omit config-defined entries such as `gpt-5.4-mini`.
43+
4244
If your OpenCode runtime supports global compaction tuning, you can also set:
4345
- `model_context_window = 1000000`
4446
- `model_auto_compact_token_limit = 900000`

docs/configuration.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Complete reference for configuring `oc-chatgpt-multi-auth`. Most of this is opti
99
```json
1010
{
1111
"$schema": "https://opencode.ai/config.json",
12-
"plugin": ["oc-chatgpt-multi-auth@latest"],
12+
"plugin": ["oc-chatgpt-multi-auth"],
1313
"provider": {
1414
"openai": {
1515
"options": {
@@ -46,14 +46,15 @@ controls how much thinking the model does.
4646
| `gpt-5.1-codex-mini` | medium, high |
4747
| `gpt-5.1` | none, low, medium, high |
4848

49-
the shipped config templates include 21 presets and do not add optional IDs by default. add `gpt-5.4-pro` and/or `gpt-5.3-codex-spark` manually only for entitled workspaces.
49+
the shipped config templates include 7 base model families and 26 shipped presets overall (26 modern variants or 26 legacy explicit entries). add `gpt-5.4-pro` and/or `gpt-5.3-codex-spark` manually only for entitled workspaces.
5050
for context sizing, shipped templates use:
5151
- `gpt-5.4`, `gpt-5.4-mini`, and `gpt-5.4-pro`: `context=1000000`, `output=128000`
5252
- other shipped families: `context=272000`, `output=128000`
5353

5454
model normalization aliases:
5555
- legacy `gpt-5`, `gpt-5-mini`, `gpt-5-nano` map to `gpt-5.4` (not to `gpt-5.4-mini`)
5656
- snapshot ids `gpt-5.4-2026-03-05*`, `gpt-5.4-mini-2026-03-05*`, and `gpt-5.4-pro-2026-03-05*` map to stable `gpt-5.4` / `gpt-5.4-mini` / `gpt-5.4-pro`
57+
- `opencode debug config` is the reliable way to confirm merged custom/template model entries; `opencode models openai` currently shows only the built-in provider catalog
5758

5859
if your OpenCode runtime supports global compaction tuning, you can set:
5960
- `model_context_window = 1000000`
@@ -254,7 +255,7 @@ same settings for all models:
254255

255256
```json
256257
{
257-
"plugin": ["oc-chatgpt-multi-auth@latest"],
258+
"plugin": ["oc-chatgpt-multi-auth"],
258259
"provider": {
259260
"openai": {
260261
"options": {
@@ -301,7 +302,7 @@ model options override global options.
301302
global (`~/.config/opencode/opencode.json`):
302303
```json
303304
{
304-
"plugin": ["oc-chatgpt-multi-auth@latest"],
305+
"plugin": ["oc-chatgpt-multi-auth"],
305306
"provider": {
306307
"openai": {
307308
"options": { "reasoningEffort": "medium" }

docs/development/ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ let include: Vec<String> = if reasoning.is_some() {
368368
**Alternative**: Single global config
369369

370370
**Problem**:
371-
- `gpt-5-codex` optimal settings differ from `gpt-5-nano`
371+
- `gpt-5-codex` optimal settings differ from `gpt-5.4` or `gpt-5.4-mini`
372372
- Users want quick switching between quality levels
373373
- No way to save "presets"
374374

@@ -472,12 +472,12 @@ The plugin now includes a beginner-focused operational layer in `index.ts` and `
472472

473473
2. **Checklist and wizard flow**
474474
- `codex-setup` renders a checklist (`add account`, `set active`, `verify health`, `label accounts`, `learn commands`).
475-
- `codex-setup wizard=true` launches an interactive menu when terminal supports TTY interaction.
475+
- `codex-setup --wizard` launches an interactive menu when terminal supports TTY interaction.
476476
- Wizard gracefully falls back to checklist output when menus are unavailable.
477477

478478
3. **Doctor + next-action diagnostics**
479479
- `codex-doctor` maps runtime/account states into severity findings (`ok`, `warning`, `error`) with specific action text.
480-
- `codex-doctor fix=true` performs safe remediation:
480+
- `codex-doctor --fix` performs safe remediation:
481481
- refreshes tokens using queued refresh,
482482
- persists refreshed credentials,
483483
- switches active account to healthiest eligible account when beneficial.

0 commit comments

Comments
 (0)