Skip to content

Latest commit

 

History

History
166 lines (136 loc) · 9.54 KB

File metadata and controls

166 lines (136 loc) · 9.54 KB

codex-multi-auth Documentation Portal

Public documentation for the codex-multi-auth Codex CLI multi-account OAuth manager. Start here for installation, ChatGPT OAuth account switching, runtime rotation, the optional mcodex convenience launcher, configuration, troubleshooting, release notes, and maintainer references.


Start Here

  1. Getting Started
  2. Daily-use landing page
  3. FAQ
  4. Troubleshooting

Daily Use

Document Focus
Daily-use landing page Common Codex CLI multi-account workflows, quick-start commands, and recovery shortcuts
faq.md Short answers to common adoption questions
features.md Multi-account OAuth, runtime rotation, diagnostics, recovery, storage, and dashboard capability map
configuration.md Stable defaults, precedence, and environment overrides
architecture.md Public system overview of the account manager, optional wrapper, storage, runtime rotation proxy, app bind, and optional plugin-host path
privacy.md Data handling and local storage behavior

Release History

Stable Releases

Document Focus
releases/v2.6.1.md Current stable release notes (install via npm i -g codex-multi-auth)
releases/v2.6.0.md Prior stable release notes
releases/v2.5.0.md Prior stable release notes
releases/v2.4.0.md Prior stable release notes
releases/v2.3.3.md Prior stable release notes
releases/v2.3.2.md Prior stable release notes
releases/v2.3.1.md Prior stable release notes
releases/v2.3.0.md Prior stable release notes
releases/v2.3.0-beta.3.md Prior prerelease notes
releases/v2.3.0-beta.2.md Prior prerelease notes
releases/v2.3.0-beta.1.md Prior prerelease notes
releases/v2.3.0-beta.0.md Prior prerelease notes
releases/v2.2.2.md Prior stable release notes
releases/v2.2.1.md Prior stable release notes
releases/v2.2.0.md Prior stable release notes
releases/v2.1.13-beta.2.md Prior prerelease notes
releases/v2.1.13-beta.1.md Prior prerelease notes
releases/v2.1.13-beta.0.md Prior prerelease notes
releases/v2.1.12.md Prior stable release notes
releases/v2.1.11.md Prior stable release notes
releases/v2.1.10.md Earlier stable release notes
releases/v2.1.9.md Earlier stable release notes
releases/v2.1.8.md Earlier stable release notes
releases/v2.1.7.md Earlier stable release notes
releases/v2.1.6.md Earlier stable release notes
releases/v2.1.5.md Earlier stable release notes
releases/v2.1.4.md Earlier stable release notes
releases/v2.1.3.md Earlier stable release notes
releases/v2.1.2.md Earlier stable release notes
releases/v2.1.1.md Earlier stable release notes
releases/v2.1.0.md Earlier stable release notes
releases/v2.0.2.md Earlier stable release notes
releases/v2.0.1.md Earlier stable release notes
releases/v2.0.0.md Earlier stable release notes
releases/v1.3.2.md Stable archive
releases/v1.3.1.md Stable archive
releases/v1.3.0.md Stable archive
releases/v1.2.7.md Stable archive
releases/v1.2.6.md Stable archive
releases/v1.2.5.md Stable archive
releases/v1.2.4.md Stable archive
releases/v1.2.3.md Stable archive
releases/v1.2.2.md Stable archive
releases/v1.2.1.md Stable archive
releases/v1.2.0.md Stable archive
releases/v1.1.11.md Stable archive
releases/v1.1.10.md Stable archive
releases/v0.1.9.md Pre-1.0 stable archive
releases/v0.1.8.md Pre-1.0 stable archive
releases/v0.1.7.md Pre-1.0 stable archive
releases/v0.1.6.md Pre-1.0 stable archive
releases/v0.1.5.md Pre-1.0 stable archive
releases/v0.1.4.md Pre-1.0 stable archive
releases/v0.1.3.md Pre-1.0 stable archive
releases/v0.1.2.md Pre-1.0 stable archive
releases/v0.1.1.md Pre-1.0 stable archive
releases/v0.1.0.md Pre-1.0 stable archive
releases/v0.1.0-beta.0.md Archived prerelease notes
releases/legacy-pre-0.1-history.md Archived pre-0.1 changelog history

Repair

Document Focus
troubleshooting.md Recovery playbooks for install, login, switching, and stale state
upgrade.md Migration from legacy package and path history

Reference

Document Focus
reference/commands.md Commands, flags, and hotkeys
reference/settings.md Dashboard and runtime settings
reference/storage-paths.md Canonical and compatibility storage paths
reference/public-api.md Public API stability and semver contract
reference/error-contracts.md CLI, JSON, and helper error semantics
Release history Stable, previous, and archived release notes

Maintainer Docs

Document Focus
DOCUMENTATION.md Documentation governance contract
STYLE_GUIDE.md Docs voice, naming, and alias-scoping rules
development/ARCHITECTURE.md Runtime architecture, selection order, security boundaries, and 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

Runbooks

Prefer the *_SAFELY / manager-command variants for new work. Older short-name runbooks remain for continuity.

Document Focus
development/RUNBOOK_ADD_AUTH_MANAGER_COMMAND.md Preferred workflow for adding a new codex-multi-auth ... command
development/RUNBOOK_ADD_CONFIG_FIELD_SAFELY.md Preferred workflow for introducing a new config/settings field
development/RUNBOOK_CHANGE_ROUTING_POLICY_SAFELY.md Preferred workflow for changing routing or account-selection policy
development/RUNBOOK_ADD_AUTH_COMMAND.md Earlier companion notes for adding an auth-manager command
development/RUNBOOK_ADD_CONFIG_FIELD.md Earlier companion notes for introducing a config field
development/RUNBOOK_CHANGE_ROUTING_POLICY.md Earlier companion notes for changing routing/retry/fallback policy

Historical maintainer material

These are snapshot archives. Prefer current development/ARCHITECTURE.md, reference docs, and code over the plans and audits below.

Document Focus
development/implementation-plans/ Historical local-governance implementation plans and subagent handoffs
audits/README.md Historical audit archive policy
audits/MASTER_AUDIT.md Historical v1.2.7 audit snapshot; evidence is preserved, not current architecture guidance
development/IA_FINDABILITY_AUDIT_2026-03-01.md IA and findability baseline audit

Governance