Skip to content

faq.md

Latest commit

 

History

History
86 lines (47 loc) · 3.03 KB

faq.md

File metadata and controls

86 lines (47 loc) · 3.03 KB

codex-multi-auth FAQ

Short answers for developers evaluating Codex CLI multi-account OAuth, account switching, local diagnostics, runtime rotation, and recovery workflows in codex-multi-auth.

Does this replace @openai/codex?

No. codex-multi-auth wraps the official @openai/codex CLI. It handles codex-multi-auth ... locally and forwards the rest of the codex workflow to the official CLI.

What problem does it solve?

It makes Codex CLI multi-account OAuth state visible and operable. Instead of relying on one hidden local auth state, you can sign into multiple ChatGPT-authenticated accounts, switch explicitly, run health checks, forecast account readiness, and repair local storage issues.

How is it different from the official Codex CLI alone?

The official Codex CLI owns the core coding experience and the codex binary. codex-multi-auth adds a separate local management layer for multiple OAuth accounts: account pool storage, explicit switching, health checks, forecasts, reports, repair commands, and optional wrapper-launched runtime rotation.

Do I need an OpenAI Platform API key?

Not for the ChatGPT-authenticated multi-account workflow in this repository. If you are building production applications or API integrations, use the OpenAI Platform API instead.

Is the plugin runtime required?

No. Many users only need the wrapper and codex-multi-auth ... commands. The plugin-host runtime is optional and uses the same account pool for advanced host request handling.

Is runtime rotation required?

Runtime rotation is enabled by default for request-bearing forwarded Codex CLI/app sessions. Disable it with codex-multi-auth rotation disable, codexRuntimeRotationProxy=false, or CODEX_MULTI_AUTH_RUNTIME_ROTATION_PROXY=0 when you need plain official Codex forwarding.

Does runtime rotation patch the Codex app?

No. The packaged app bind updates user-level Codex config and startup/router metadata and keeps a backup for restore. Official app binaries are not patched.

Who is this for?

This project is aimed at individual developers using the official Codex CLI who want more control over local account state, account switching, diagnostics, quota visibility, runtime rotation, and recovery.

Is this intended for commercial multi-user services?

No. The repository is positioned for personal development workflows with your own accounts.

Where is account data stored?

By default, under ~/.codex/multi-auth. Project-scoped account pools can also live under ~/.codex/multi-auth/projects/<project-key>/....

How do I recover quickly if something looks wrong?

Run:

codex-multi-auth doctor --fix
codex-multi-auth check
codex-multi-auth forecast --live

Then rerun codex-multi-auth login if the affected account still looks stale.

Where should I start after this page?