Skip to content

Commit e8d0820

Browse files
committed
docs: refresh codex-first rebrand and cutover notes
1 parent 5e0bcc1 commit e8d0820

18 files changed

+88
-75
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ npm run lint # eslint
6464
## NOTES
6565
- OAuth callback: `http://127.0.0.1:1455/auth/callback`.
6666
- ChatGPT backend requires `store: false`, include `reasoning.encrypted_content`.
67-
- Per-project accounts: `~/.opencode/projects/<project-key>/openai-codex-accounts.json` (walks up to find project root).
68-
- Global accounts: `~/.opencode/openai-codex-accounts.json`.
67+
- Per-project accounts: `~/.opencode/projects/<project-key>/oc-codex-multi-auth-accounts.json` (walks up to find project root).
68+
- Global accounts: `~/.opencode/oc-codex-multi-auth-accounts.json`.
6969
- Prompt templates synced from Codex CLI GitHub releases with ETag caching.
7070
- 5xx server errors trigger account rotation and health penalty (same as network errors).
7171
- API deprecation/sunset headers (RFC 8594) are logged as warnings.

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
all notable changes to this project. dates are ISO format (YYYY-MM-DD).
44

5-
## [unreleased]
5+
## [6.0.0] - 2026-04-06
66

77
### added
88

@@ -12,19 +12,23 @@ all notable changes to this project. dates are ISO format (YYYY-MM-DD).
1212
- **backup/import safety controls**: `codex-export` now supports auto timestamped backup paths; `codex-import` adds `dryRun` preview and automatic pre-import backup on apply.
1313
- **beginner safe mode config**: new `beginnerSafeMode` config key and `CODEX_AUTH_BEGINNER_SAFE_MODE` env override for conservative retry behavior.
1414
- **startup preflight summary**: one-time startup health summary with recommended next action.
15+
- **breaking rebrand migration**: current runtime storage now uses package-aligned files (`oc-codex-multi-auth-accounts.json`, `oc-codex-multi-auth-flagged-accounts.json`) with automatic migration from legacy package-era and pre-package storage names on first load.
1516

1617
### changed
1718

1819
- **account storage schema**: V3 account metadata now includes optional `accountTags` and `accountNote`.
1920
- **docs refresh for operational flows**: README + docs portal/development guides updated to reflect beginner commands, safe mode, interactive picker behavior, and backup/import safeguards.
2021
- **repository presentation refresh**: rewrote the README as a landing page, added a public FAQ and code of conduct, refreshed package metadata, and removed stale CI/test claims from public docs surfaces.
2122
- **test matrix expansion**: coverage now includes beginner UI helpers, safe-fix diagnostics edge cases, tag/note command behavior, and timestamped backup/import preview utilities.
23+
- **package line renamed**: the supported package, repo, plugin entry, installer surface, and docs now use `oc-codex-multi-auth` instead of `oc-chatgpt-multi-auth`.
24+
- **codex-first auth wording**: OAuth options, installer guidance, and onboarding docs now describe the Codex-first flow directly instead of the older MULTI-branded labels.
2225

2326
### fixed
2427

2528
- **non-interactive command guidance**: optional-index commands provide explicit usage guidance when interactive menus are unavailable.
2629
- **doctor safe-fix edge path**: `codex-doctor fix` now reports a clear non-crashing message when no eligible account is available for auto-switch.
2730
- **first-time import flow**: `codex-import` no longer fails with `No accounts to export` when storage is empty; pre-import backup is skipped cleanly in zero-account setups.
31+
- **installer cache hygiene**: the installer now removes both the old and new package names from OpenCode cache metadata so cutover installs do not stay pinned to stale artifacts.
2832

2933
## [5.4.8] - 2026-03-24
3034

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Thank you for contributing to `oc-chatgpt-multi-auth`.
3+
Thank you for contributing to `oc-codex-multi-auth`.
44

55
This project accepts improvements that make the OpenCode plugin clearer, safer, easier to maintain, and more useful for personal development workflows.
66

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# oc-chatgpt-multi-auth
1+
# oc-codex-multi-auth
22

3-
[![npm version](https://img.shields.io/npm/v/oc-chatgpt-multi-auth.svg)](https://www.npmjs.com/package/oc-chatgpt-multi-auth)
4-
[![npm downloads](https://img.shields.io/npm/dw/oc-chatgpt-multi-auth.svg)](https://www.npmjs.com/package/oc-chatgpt-multi-auth)
3+
[![npm version](https://img.shields.io/npm/v/oc-codex-multi-auth.svg)](https://www.npmjs.com/package/oc-codex-multi-auth)
4+
[![npm downloads](https://img.shields.io/npm/dw/oc-codex-multi-auth.svg)](https://www.npmjs.com/package/oc-codex-multi-auth)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
66

77
Use your ChatGPT Plus/Pro subscription inside OpenCode with OAuth login, GPT-5/Codex model presets, and multi-account failover.
88

9-
`oc-chatgpt-multi-auth` is an OpenCode plugin for developers who want ChatGPT-backed GPT-5 and Codex workflows in OpenCode without switching to separate Platform API credentials for personal use. It uses the same official OAuth flow as the Codex CLI, adds model templates for current GPT-5 families, and can rotate across multiple ChatGPT accounts when one account is rate-limited or unavailable.
9+
`oc-codex-multi-auth` is an OpenCode plugin for developers who want Codex-first GPT-5 workflows in OpenCode without switching to separate Platform API credentials for personal use. It uses the same official OAuth flow as the Codex CLI, adds model templates for current GPT-5 families, and can rotate across multiple ChatGPT accounts when one account is rate-limited or unavailable.
1010

1111
## What This Project Does
1212

@@ -19,7 +19,7 @@ Use your ChatGPT Plus/Pro subscription inside OpenCode with OAuth login, GPT-5/C
1919

2020
```bash
2121
# 1. Install or refresh the plugin config
22-
npx -y oc-chatgpt-multi-auth@latest
22+
npx -y oc-codex-multi-auth@latest
2323

2424
# 2. Sign in with ChatGPT Plus/Pro
2525
opencode auth login
@@ -32,7 +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"`
35+
- normalizes the plugin entry to `"oc-codex-multi-auth"`
3636
- clears the cached plugin copy so OpenCode reinstalls the latest package
3737

3838
By default, the installer now writes a full catalog config that includes both:
@@ -103,7 +103,7 @@ Use the quick-start path above for the fastest setup. For full setup, local deve
103103
If you prefer the compact variant-only config on OpenCode `v1.0.210+`, use:
104104

105105
```bash
106-
npx -y oc-chatgpt-multi-auth@latest --modern
106+
npx -y oc-codex-multi-auth@latest --modern
107107
```
108108

109109
## Configuration
@@ -125,7 +125,16 @@ Start here if the plugin does not load or authenticate correctly:
125125

126126
Common first checks:
127127

128-
- confirm `"plugin": ["oc-chatgpt-multi-auth"]` is present in your OpenCode config
128+
- confirm `"plugin": ["oc-codex-multi-auth"]` is present in your OpenCode config
129+
130+
## 6.0.0 Cutover
131+
132+
This release intentionally breaks the old package line and moves the runtime to package-aligned storage names.
133+
134+
- Rename the GitHub repository to `ndycode/oc-codex-multi-auth`
135+
- Publish `oc-codex-multi-auth@6.0.0`
136+
- Deprecate `oc-chatgpt-multi-auth` on npm with a pointer to the new package
137+
- Verify docs, badges, repo links, and OpenCode config examples all resolve to `oc-codex-multi-auth`
129138
- rerun `opencode auth login`
130139
- inspect `~/.opencode/logs/codex-plugin/` after running one request with `ENABLE_PLUGIN_REQUEST_LOGGING=1`
131140

assets/readme-hero.svg

Lines changed: 4 additions & 4 deletions
Loading

config/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
This directory contains the official OpenCode config templates for the ChatGPT Codex OAuth plugin.
3+
This directory contains the official OpenCode config templates for `oc-codex-multi-auth`.
44

55
## Required: choose the right config file
66

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
theme: jekyll-theme-hacker
2-
title: oc-chatgpt-multi-auth
2+
title: oc-codex-multi-auth
33
description: Use your ChatGPT Plus/Pro subscription inside OpenCode with OAuth login and GPT-5/Codex presets
44
show_downloads: true

docs/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration Reference
22

3-
Complete reference for configuring `oc-chatgpt-multi-auth`. Most of this is optional; the defaults work for most people.
3+
Complete reference for configuring `oc-codex-multi-auth`. Most of this is optional; the defaults work for most people.
44

55
---
66

@@ -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"],
12+
"plugin": ["oc-codex-multi-auth"],
1313
"provider": {
1414
"openai": {
1515
"options": {
@@ -256,7 +256,7 @@ same settings for all models:
256256

257257
```json
258258
{
259-
"plugin": ["oc-chatgpt-multi-auth"],
259+
"plugin": ["oc-codex-multi-auth"],
260260
"provider": {
261261
"openai": {
262262
"options": {
@@ -303,7 +303,7 @@ model options override global options.
303303
global (`~/.config/opencode/opencode.json`):
304304
```json
305305
{
306-
"plugin": ["oc-chatgpt-multi-auth"],
306+
"plugin": ["oc-codex-multi-auth"],
307307
"provider": {
308308
"openai": {
309309
"options": { "reasoningEffort": "medium" }
@@ -335,8 +335,8 @@ result: project uses `high`, other projects use `medium`.
335335
| `<project>/.opencode.json` | project-specific config |
336336
| `~/.opencode/openai-codex-auth-config.json` | plugin config |
337337
| `~/.opencode/auth/openai.json` | oauth tokens |
338-
| `~/.opencode/openai-codex-accounts.json` | global account storage |
339-
| `~/.opencode/projects/<project-key>/openai-codex-accounts.json` | per-project account storage |
338+
| `~/.opencode/oc-codex-multi-auth-accounts.json` | global account storage |
339+
| `~/.opencode/projects/<project-key>/oc-codex-multi-auth-accounts.json` | per-project account storage |
340340
| `~/.opencode/backups/codex-backup-YYYYMMDD-HHMMSSmmm-<hex>.json` | timestamped export backup (global storage mode) |
341341
| `~/.opencode/projects/<project-key>/backups/codex-backup-YYYYMMDD-HHMMSSmmm-<hex>.json` | timestamped export backup (per-project storage mode) |
342342
| `.../backups/codex-pre-import-backup-YYYYMMDD-HHMMSSmmm-<hex>.json` | automatic snapshot created before non-dry-run imports when existing accounts are present |

docs/development/CONFIG_FIELDS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Config Fields
22

3-
This document summarizes the current config fields that matter for `oc-chatgpt-multi-auth`.
3+
This document summarizes the current config fields that matter for `oc-codex-multi-auth`.
44

55
## Top-Level Fields
66

@@ -10,7 +10,7 @@ Use the plain package name in OpenCode config:
1010

1111
```json
1212
{
13-
"plugin": ["oc-chatgpt-multi-auth"]
13+
"plugin": ["oc-codex-multi-auth"]
1414
}
1515
```
1616

docs/development/CONFIG_FLOW.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenCode Config Flow
22

3-
This document describes the current config surfaces used by `oc-chatgpt-multi-auth` on `main`.
3+
This document describes the current config surfaces used by `oc-codex-multi-auth` on `main`.
44

55
## Primary Config Surfaces
66

@@ -45,17 +45,17 @@ That file controls plugin behavior such as retry policy, beginner safe mode, fal
4545

4646
## Installer Flow
4747

48-
`scripts/install-opencode-codex-auth.js` performs these steps:
48+
`scripts/install-oc-codex-multi-auth.js` performs these steps:
4949

5050
1. Load the selected template set (`full` by default, `config/opencode-modern.json` with `--modern`, `config/opencode-legacy.json` with `--legacy`).
5151
2. Back up an existing `~/.config/opencode/opencode.json`.
52-
3. Normalize the plugin list so it ends with plain `oc-chatgpt-multi-auth`.
52+
3. Normalize the plugin list so it ends with plain `oc-codex-multi-auth`.
5353
4. Replace `provider.openai` with the selected shipped template block.
5454
5. Clear the cached OpenCode plugin copy under `~/.cache/opencode/`.
5555

5656
Important detail:
5757

58-
- The installer intentionally writes the plugin entry as `oc-chatgpt-multi-auth`, not `oc-chatgpt-multi-auth@latest`.
58+
- The installer intentionally writes the plugin entry as `oc-codex-multi-auth`, not `oc-codex-multi-auth@latest`.
5959
- The default `full` install mode merges the modern base-model template with the explicit legacy preset entries so users can access `--variant` workflows and still see the full shipped preset catalog directly.
6060

6161
## Shipped Template Structure
@@ -86,7 +86,7 @@ Example shape:
8686

8787
```json
8888
{
89-
"plugin": ["oc-chatgpt-multi-auth"],
89+
"plugin": ["oc-codex-multi-auth"],
9090
"provider": {
9191
"openai": {
9292
"options": {
@@ -170,8 +170,8 @@ Important runtime behavior:
170170
| `<project>/.opencode.json` | project-local OpenCode override |
171171
| `~/.opencode/openai-codex-auth-config.json` | plugin runtime config |
172172
| `~/.opencode/auth/openai.json` | OAuth token storage |
173-
| `~/.opencode/openai-codex-accounts.json` | global account storage |
174-
| `~/.opencode/projects/<project-key>/openai-codex-accounts.json` | per-project account storage |
173+
| `~/.opencode/oc-codex-multi-auth-accounts.json` | global account storage |
174+
| `~/.opencode/projects/<project-key>/oc-codex-multi-auth-accounts.json` | per-project account storage |
175175
| `~/.opencode/logs/codex-plugin/` | plugin request/debug logs |
176176

177177
## See Also

0 commit comments

Comments
 (0)