The complete documentation set for codex-multi-auth, the multi-account OAuth manager for the official Codex CLI. New here? Read index.md for what the product does at runtime, then getting-started.md to install and sign in.
| Document | Purpose |
|---|---|
| index.md | Product overview — what it does at runtime and who needs it |
| getting-started.md | Install, first login, device-auth and manual login, day-1 commands |
| faq.md | Short answers to common adoption questions |
| troubleshooting.md | Recovery playbooks for install, login, routing, and storage problems |
| Document | Purpose |
|---|---|
| features.md | Capability tour: account pool, runtime rotation, governance, bridge, dashboard |
| architecture.md | Components, request flow, and trust boundaries |
| configuration.md | Settings, precedence, and environment overrides |
| upgrade.md | Version upgrades and legacy-package migration |
| privacy.md | Data handling and local storage behavior |
| Document | Purpose |
|---|---|
| reference/commands.md | Every command, flag, and dashboard hotkey |
| reference/settings.md | Dashboard and runtime settings |
| reference/storage-paths.md | Canonical and compatibility storage paths |
| reference/public-api.md | Public API stability tiers and semver contract |
| reference/error-contracts.md | CLI, JSON, and helper error semantics |
| reference/image-routes.md | Image generation/edit transport through the runtime proxy |
| reference/imagegen-provider-compatibility.md | Built-in image_gen provider compatibility |
| Release history | Stable, previous, and archived release notes |
| Document | Purpose |
|---|---|
| DOCUMENTATION.md | Documentation governance contract |
| STYLE_GUIDE.md | Docs voice, naming, and alias rules |
| development/ARCHITECTURE.md | Internals: selection order, security boundaries, invariants |
| development/CONFIG_FIELDS.md | Complete field and environment inventory |
| development/CONFIG_FLOW.md | Configuration resolution flow |
| development/REPOSITORY_SCOPE.md | Ownership map by repository path |
| development/TESTING.md | Validation gates and test matrix |
| development/TUI_PARITY_CHECKLIST.md | Dashboard UX parity checklist |
| development/GITHUB_DISCOVERABILITY.md | GitHub-facing metadata and presentation guidance |
| benchmarks/code-edit-format-benchmark.md | Benchmark methodology and outputs |
Prefer the *_SAFELY / manager-command runbooks for new work; the earlier short-name runbooks remain for continuity.
| Document | Purpose |
|---|---|
| development/RUNBOOK_ADD_AUTH_MANAGER_COMMAND.md | Add a new codex-multi-auth ... command |
| development/RUNBOOK_ADD_CONFIG_FIELD_SAFELY.md | Introduce a new config/settings field |
| development/RUNBOOK_CHANGE_ROUTING_POLICY_SAFELY.md | Change routing or account-selection policy |
| development/RUNBOOK_ADD_AUTH_COMMAND.md | Earlier notes for adding an auth-manager command |
| development/RUNBOOK_ADD_CONFIG_FIELD.md | Earlier notes for introducing a config field |
| development/RUNBOOK_CHANGE_ROUTING_POLICY.md | Earlier notes for changing routing/retry/fallback policy |
Snapshot material kept for provenance — prefer current development/ and reference/ docs over these.
| Document | Purpose |
|---|---|
| audits/README.md | Audit archive policy |
| audits/MASTER_AUDIT.md | Historical v1.2.7 audit snapshot |
| audits/AUDIT_2026-06-10.md | Repository audit, June 2026 |
| audits/evidence/ | Audit evidence files |
| development/implementation-plans/ | Local-governance implementation plans and subagent handoffs |
| development/IA_FINDABILITY_AUDIT_2026-03-01.md | IA and findability baseline audit |
| development/DEEP_AUDIT_2026-03-01.md | Deep audit baseline |
| development/CLI_UI_DEEPSEARCH_AUDIT.md | CLI/UI audit notes |
| development/CONTEXT_BUDGET_GUARD_PLAN.md | Context budget guard design plan |
| design/earned-reset-credits.md | Earned reset credits design |
| design/model-route-pools.md | Model route pools design |
| design/model-route-pools-release.md | Model route pools release notes design |
| design/model-route-pools-review.md | Model route pools design review |
Current stable: v2.19.0 (npm i -g codex-multi-auth). The 2.x line is the current release line; earlier lines are kept as archives.
- 2.19.x — v2.19.0
- 2.18.x — v2.18.0
- 2.17.x — v2.17.3 · v2.17.2 · v2.17.1 · v2.17.0
- 2.10 – 2.16 — v2.16.0 · v2.15.0 · v2.14.0 · v2.13.0 · v2.12.0 · v2.11.0 · v2.10.0
- 2.9.x — v2.9.2 · v2.9.1 · v2.9.0
- 2.8.x — v2.8.7 · v2.8.6 · v2.8.5 · v2.8.4 · v2.8.3 · v2.8.2 · v2.8.1 · v2.8.0
- 2.7.x — v2.7.1 · v2.7.0
- 2.6.x — v2.6.1 · v2.6.0
- 2.5.x — v2.5.0
- 2.4.x — v2.4.0
- 2.3.x — v2.3.3 · v2.3.2 · v2.3.1 · v2.3.0 · v2.3.0-beta.3 · v2.3.0-beta.2 · v2.3.0-beta.1 · v2.3.0-beta.0
- 2.2.x — v2.2.2 · v2.2.1 · v2.2.0
- 2.1.x — v2.1.13-beta.2 · v2.1.13-beta.1 · v2.1.13-beta.0 · v2.1.12 · v2.1.11 · v2.1.10 · v2.1.9 · v2.1.8 · v2.1.7 · v2.1.6 · v2.1.5 · v2.1.4 · v2.1.3 · v2.1.2 · v2.1.1 · v2.1.0
- 2.0.x — v2.0.2 · v2.0.1 · v2.0.0
- 1.3.x — v1.3.2 · v1.3.1 · v1.3.0
- 1.2.x — v1.2.7 · v1.2.6 · v1.2.5 · v1.2.4 · v1.2.3 · v1.2.2 · v1.2.1 · v1.2.0
- 1.1.x — v1.1.11 · v1.1.10
- 0.1.x — v0.1.9 · v0.1.8 · v0.1.7 · v0.1.6 · v0.1.5 · v0.1.4 · v0.1.3 · v0.1.2 · v0.1.1 · v0.1.0 · v0.1.0-beta.0
- Pre-0.1 — legacy-pre-0.1-history.md — archived pre-0.1 changelog history
- Project entry: ../README.md
- Changelog: ../CHANGELOG.md
- Contribution policy: ../CONTRIBUTING.md
- Code of conduct: ../CODE_OF_CONDUCT.md
- Security policy: ../SECURITY.md
- License: ../LICENSE