Skip to content

Commit 29bec7c

Browse files
committed
docs: add agent install/update instructions
1 parent 81dfbca commit 29bec7c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,35 @@ Check [releases](https://github.com/numman-ali/opencode-openai-codex-auth/releas
9595

9696
---
9797

98+
### Agent Instructions (Install / Update)
99+
100+
If you’re using an AI agent (Codex/Claude/etc.) to install or update this plugin on a machine, use these steps:
101+
102+
1. **Use the official repo**: https://github.com/numman-ali/opencode-openai-codex-auth
103+
2. **Pin the plugin version** in the user’s OpenCode config (`~/.config/opencode/opencode.json` or project `.opencode.json`).
104+
3. **Replace the config** with the latest `config/full-opencode.json` from the repo.
105+
4. **Refresh the plugin cache** so OpenCode reinstalls the updated version.
106+
5. **Restart OpenCode**.
107+
108+
```bash
109+
# 1) Update plugin version (replace <latest> with newest release tag)
110+
# Example: opencode-openai-codex-auth@4.2.0
111+
112+
# 2) Copy full config
113+
cp <repo>/config/full-opencode.json ~/.config/opencode/opencode.json
114+
115+
# 3) Refresh OpenCode plugin cache
116+
rm -rf ~/.cache/opencode/node_modules ~/.cache/opencode/bun.lock
117+
118+
# 4) Optional sanity check for GPT-5.2-Codex presets
119+
jq '.provider.openai.models | keys | map(select(startswith("gpt-5.2-codex")))' \
120+
~/.config/opencode/opencode.json
121+
```
122+
123+
> **Note**: If using a project-local config, replace the target path with `<project>/.opencode.json`.
124+
125+
---
126+
98127
#### ⚠️ REQUIRED: Full Configuration (Only Supported Setup)
99128

100129
**IMPORTANT**: You MUST use the full configuration from [`config/full-opencode.json`](./config/full-opencode.json). Other configurations are not officially supported and may not work reliably.

0 commit comments

Comments
 (0)