Skip to content

Commit 12348a6

Browse files
author
Numman Ali
committed
v1.0.1: Improve installation docs
- Clarify that npm install is not needed (auto-installs) - Add config file locations (global vs project) - Add links to official opencode docs - Simplify quick start instructions
1 parent c2e7a2e commit 12348a6

File tree

2 files changed

+25
-26
lines changed

2 files changed

+25
-26
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,42 @@ This plugin enables opencode to use OpenAI's Codex backend via ChatGPT Plus/Pro
1515

1616
## Installation
1717

18-
### From npm (Recommended)
18+
### Quick Start
1919

20-
```bash
21-
npm install opencode-openai-codex-auth
22-
```
20+
**No npm install needed!** opencode automatically installs plugins when you add them to your config.
2321

24-
Add the plugin to your `opencode.json`:
22+
1. **Add plugin to your opencode configuration**:
2523

26-
```json
27-
{
28-
"$schema": "https://opencode.ai/config.json",
29-
"plugin": [
30-
"opencode-openai-codex-auth"
31-
],
32-
"model": "openai/gpt-5-codex"
33-
}
34-
```
24+
Edit your `opencode.json` file (create it if it doesn't exist):
3525

36-
### From source
26+
**Global config**: `~/.config/opencode/opencode.json`
27+
**Project config**: `<project>/.opencode.json`
3728

38-
1. Clone this repository:
29+
```json
30+
{
31+
"$schema": "https://opencode.ai/config.json",
32+
"plugin": [
33+
"opencode-openai-codex-auth"
34+
],
35+
"model": "openai/gpt-5-codex"
36+
}
37+
```
3938

40-
```bash
41-
git clone https://github.com/numman/opencode-openai-codex-auth.git
42-
cd opencode-openai-codex-auth
43-
npm install
44-
```
39+
2. **That's it!** opencode will auto-install the plugin on first run.
40+
41+
> **New to opencode?** Learn more:
42+
> - [Configuration Guide](https://opencode.ai/docs/config/)
43+
> - [Plugin Documentation](https://opencode.ai/docs/plugins/)
44+
45+
### Alternative: Local Development
4546

46-
2. Add the plugin to your `opencode.json`:
47+
For testing or development, you can use a local file path:
4748

4849
```json
4950
{
50-
"$schema": "https://opencode.ai/config.json",
5151
"plugin": [
5252
"file:///absolute/path/to/opencode-openai-codex-auth"
53-
],
54-
"model": "openai/gpt-5-codex"
53+
]
5554
}
5655
```
5756

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "opencode-openai-codex-auth",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "OpenAI ChatGPT (Codex backend) OAuth auth plugin for opencode - use your ChatGPT Plus/Pro subscription instead of API credits",
55
"main": "./index.mjs",
66
"type": "module",

0 commit comments

Comments
 (0)