npm - oc-codex-multi-account - Versions diffs - 1.0.0 → 1.0.11 - Mend

oc-codex-multi-account 1.0.0 → 1.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +45 -265
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -2,319 +2,99 @@
 [![npm version](https://img.shields.io/npm/v/oc-codex-multi-account)](https://www.npmjs.com/package/oc-codex-multi-account)
-Multi-account OAuth rotation for OpenAI Codex with sticky threshold switching.
-> **Based on [opencode-openai-codex-auth](https://github.com/numman-ali/opencode-openai-codex-auth) by [@nummanali](https://x.com/nummanali)**. Forked and modified to add multi-account rotation support.
-## Patched Build (Codex Backend Compatible)
-This fork patches the plugin to talk to **ChatGPT Codex backend** (`chatgpt.com/backend-api`) with the same headers and request shape as the official Codex OAuth plugin.
-**Install from npm (recommended):**
-```bash
-bun add oc-codex-multi-account --cwd ~/.config/opencode
-```
-Then set the plugin entry in `~/.config/opencode/opencode.json`:
-```json
-{
-  "plugin": ["oc-codex-multi-account@latest"]
-}
-```
-If you already installed an older build, re-run the GitHub install command above to override it.
+OpenCode plugin for Codex multi-account routing with sticky primary selection and threshold-based fallback.
 ## Installation
-### Via npm (Recommended)
+### 1) Add plugin to OpenCode config
-Add to your `~/.config/opencode/opencode.json`:
+Add this to your `~/.config/opencode/opencode.json` (or project-level `opencode.json`):
 ```json
 {
-  "plugin": ["oc-codex-multi-account@latest"]
+  "plugin": [
+    "oc-codex-multi-account@latest"
+  ]
 }
 ```
-OpenCode will auto-install on first run.
+OpenCode installs the package automatically on startup.
-### Manual Install
+### 2) (Optional) Install locally for CLI usage
-If auto-install fails, install manually:
+If you want to manage accounts via terminal commands:
 ```bash
 bun add oc-codex-multi-account --cwd ~/.config/opencode
 ```
-### From Source
-```bash
-git clone https://github.com/gaboe/oc-codex-multi-account.git
-cd oc-codex-multi-account
-bun install
-bun run build
-bun link
-```
-## Add Your Accounts
-```bash
-# Add each account (opens browser for OAuth)
-opencode-multi-auth add personal
-opencode-multi-auth add work
-opencode-multi-auth add backup
-# Each command opens your browser - log in with a different ChatGPT account each time
-```
-## Verify Setup
+Then use:
 ```bash
-opencode-multi-auth status
-```
-Output:
-```
-[multi-auth] Account Status
-Strategy: round-robin
-Accounts: 3
-Active: personal
-  personal (active)
-    Email: you@personal.com
-    Uses: 12
-    Token expires: 12/25/2025, 3:00:00 PM
-  work
-    Email: you@work.com
-    Uses: 10
-    Token expires: 12/25/2025, 3:00:00 PM
-  backup
-    Email: you@backup.com
-    Uses: 8
-    Token expires: 12/25/2025, 3:00:00 PM
+~/.config/opencode/node_modules/.bin/oc-codex-multi-account --help
 ```
-## Web Dashboard (Local Only)
-Launch the local dashboard:
+If global bin is available in your PATH, you can use:
 ```bash
-opencode-multi-auth web --port 3434 --host 127.0.0.1
+oc-codex-multi-account --help
 ```
-Or from the repo:
+## Add Accounts
 ```bash
-npm run web
+oc-codex-multi-account add primary
+oc-codex-multi-account add fallback1
+oc-codex-multi-account add fallback2
 ```
-Open `http://127.0.0.1:3434` to manage Codex CLI tokens from `~/.codex/auth.json`:
-- Sync current auth.json token into your local list
-- See which token is active on the device
-- Switch auth.json to a stored token
-- Refresh OAuth tokens (per-token or all)
-- Refresh 5-hour and weekly limits manually (probe-run per alias)
-- Search/filter by alias/email/tags/notes
-- Sort by remaining limits, expiry, or alias; recommended token badge
-- Tag and annotate tokens (notes)
-- Queue-based refresh with progress + stop
-- Limit history sparklines and trend rate
-- Built-in log view
+The first account is treated as primary. Additional accounts are fallbacks.
-The dashboard watches `~/.codex/auth.json` and will add new tokens as you log in via Codex CLI.
+## How Switching Works
-Limit refresh runs `codex exec` in a per-alias sandbox (`~/.codex-multi/<alias>`) so you can
-update limits for any stored token without switching the active device token.
+- Primary-first (sticky): requests stay on primary while under thresholds.
+- Fallback on pressure: switches when primary exceeds configured utilization.
+- Recovery checks: while on fallback, periodically checks if primary recovered and switches back.
+- Safety skips: temporarily skips accounts that are rate-limited or have auth/model/workspace issues.
-### Optional Store Encryption
+## Storage
-Set `CODEX_SOFT_STORE_PASSPHRASE` to encrypt `~/.config/opencode-multi-auth/accounts.json` at rest:
+Credentials and runtime state are stored in:
-```bash
-export CODEX_SOFT_STORE_PASSPHRASE="your-passphrase"
-```
+- `~/.config/oc-codex-multi-account/accounts.json`
-If the store is encrypted and the passphrase is missing, the UI will show a locked status and refuse to overwrite.
+Migration is automatic from legacy path:
-### Systemd Autostart (user service)
+- `~/.config/opencode-multi-auth/accounts.json`
-Install and enable the user service:
-```bash
-opencode-multi-auth service install --port 3434 --host 127.0.0.1
-```
-Check status or disable:
+## CLI Commands
 ```bash
-opencode-multi-auth service status
-opencode-multi-auth service disable
-```
-### Logs
-The dashboard writes logs to `~/.config/opencode-multi-auth/logs/codex-soft.log` by default.
-Override with `CODEX_SOFT_LOG_PATH` if you want a custom path.
-## Configure OpenCode
-Add to your `~/.config/opencode/opencode.json`:
-```json
-{
-  "plugin": ["oc-codex-multi-account@latest"]
-}
-```
-Or with other plugins:
-```json
-{
-  "plugin": [
-    "oh-my-opencode",
-    "oc-codex-multi-account@latest"
-  ]
-}
-```
-## Background Notifications (macOS)
-### iPhone notifications via ntfy (click to open session)
-If you want push notifications on iOS (with a clickable link to the OpenCode web session), use `ntfy`.
-1) Install the **ntfy** app on iPhone and subscribe to a topic.
-2) Set these env vars on the Mac where OpenCode runs:
-- `OPENCODE_MULTI_AUTH_NOTIFY_NTFY_URL`
-  Example: `https://ntfy.sh/<your-topic>` (or your self-hosted ntfy URL)
-- `OPENCODE_MULTI_AUTH_NOTIFY_UI_BASE_URL`
-  Base URL of your OpenCode web UI reachable from iPhone.
-  Example (Tailscale): `http://100.x.y.z:4096`
-- Optional: `OPENCODE_MULTI_AUTH_NOTIFY_NTFY_TOKEN` (Bearer token)
-The plugin sends notifications for:
-- `session.idle` (finished): priority `3`
-- `session.status` with `retry`: priority `4`
-- `session.error`: priority `5`
-When possible, the notification body includes `Project` + session `Title`, plus the `sessionID`.
-It also attaches a `Click:` URL like `<base>/session/<sessionID>` so tapping the push opens the session.
-This plugin can send a **macOS notification + sound** when a session finishes work.
-It listens for OpenCode events (`session.status` and `session.idle`).
-Defaults:
-- Enabled by default
-- Sound: `/System/Library/Sounds/Glass.aiff`
-Environment variables:
-- `OPENCODE_MULTI_AUTH_NOTIFY=0` disables notifications
-- `OPENCODE_MULTI_AUTH_NOTIFY_SOUND=/path/to/sound.aiff` overrides the sound
-- `OPENCODE_MULTI_AUTH_NOTIFY_MAC_OPEN=0` disables click-to-open on macOS (when available)
-Clickable macOS notifications require `terminal-notifier` (optional). If installed, clicking the banner opens the session URL.
-If OpenCode seems to only make progress when the window is focused, macOS may be throttling it.
-Try disabling App Nap for OpenCode.app (Finder -> Get Info -> Prevent App Nap),
-or run the server from a terminal under `caffeinate`.
-## Codex Latest Model Mapping
-OpenCode may not list the newest Codex model yet (it keeps an internal allowlist).
-This plugin can still use the newest model by **mapping** the selected Codex model
-to the latest backend model on ChatGPT.
-Default behavior:
-- If you select `openai/gpt-5.2-codex` (or `openai/gpt-5-codex`), the plugin will send requests as `gpt-5.3-codex`.
-Environment variables:
-- `OPENCODE_MULTI_AUTH_PREFER_CODEX_LATEST=0` disables the mapping (use exact model).
-- `OPENCODE_MULTI_AUTH_CODEX_LATEST_MODEL=gpt-5.3-codex` overrides the target model.
-- `OPENCODE_MULTI_AUTH_DEBUG=1` prints mapping logs like: `model map: gpt-5.2-codex -> gpt-5.3-codex`.
-## Troubleshooting
-### BunInstallFailedError (DependencyLoop)
-If OpenCode fails to boot with:
-```
-BunInstallFailedError
-{ "pkg": "oc-codex-multi-account", "version": "latest" }
+oc-codex-multi-account add <alias>       # OAuth login flow
+oc-codex-multi-account remove <alias>    # remove account
+oc-codex-multi-account list              # list accounts
+oc-codex-multi-account status            # detailed status
+oc-codex-multi-account path              # print store file path
+oc-codex-multi-account web --port 3434 --host 127.0.0.1
+oc-codex-multi-account service install --port 3434 --host 127.0.0.1
 ```
-It usually means an older `@a3fckx/opencode-multi-auth` dependency is still present.
+## Release Flow
-Fix:
+This repository is configured for tag-based publishing via GitHub Actions.
-1) Remove the old dependency from `~/.config/opencode/package.json`:
-```json
-{
-  "dependencies": {
-    "@a3fckx/opencode-multi-auth": "^1.0.4"
-  }
-}
-```
-2) Reinstall:
+- Create and push a tag like `v1.0.1`
+- Workflow publishes to npm and creates GitHub Release
 ```bash
-bun add oc-codex-multi-account --cwd ~/.config/opencode
-```
-Optional fallback: use a file path plugin entry if installs are blocked:
-```json
-{
-  "plugin": [
-    "file:///Users/<you>/.config/opencode/node_modules/oc-codex-multi-account/dist/index.js"
-  ]
-}
+git tag v1.0.1
+git push origin v1.0.1
 ```
-## How It Works
-| Feature | Behavior |
-|---------|----------|
-| **Rotation** | Round-robin across all accounts per API call |
-| **Rate Limits** | Auto-skips rate-limited account for 5 min, uses next |
-| **Token Refresh** | Auto-refreshes tokens before expiry |
-| **Models** | Auto-discovers GPT-5.x models from OpenAI API |
-| **Storage** | `~/.config/opencode-multi-auth/accounts.json` |
-## CLI Commands
-| Command | Description |
-|---------|-------------|
-| `add <alias>` | Add new account via OAuth (opens browser) |
-| `remove <alias>` | Remove an account |
-| `list` | List all configured accounts |
-| `status` | Detailed status with usage counts |
-| `path` | Show config file location |
-| `web` | Launch local Codex auth.json dashboard |
-| `service` | Install/disable systemd user service |
-| `help` | Show help message |
-## Requirements
-- ChatGPT Plus/Pro subscription(s)
-- OpenCode CLI
-## Credits
+## Repository
-- Original OAuth implementation: [numman-ali/opencode-openai-codex-auth](https://github.com/numman-ali/opencode-openai-codex-auth)
-- Multi-account rotation: [@a3fckx](https://github.com/a3fckx)
+- GitHub: `https://github.com/gaboe/oc-codex-multi-account`
+- npm: `https://www.npmjs.com/package/oc-codex-multi-account`
 ## License

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "oc-codex-multi-account",
-  "version": "1.0.0",
+  "version": "1.0.11",
   "description": "Codex multi-account plugin with sticky threshold switching",
   "type": "module",
   "main": "./dist/index.js",