faq.md

FAQ

Short answers for developers evaluating codex-multi-auth.

---

Does this replace @openai/codex?

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

---

What problem does it solve?

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

---

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 auth ... commands. The plugin runtime is optional and uses the same account pool for advanced request handling.

---

Who is this for?

This project is aimed at individual developers using the official Codex CLI who want more control over local account state, switching, diagnostics, 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 auth doctor --fix
codex auth check
codex auth forecast --live

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

---

Where should I start after this page?

• getting-started.md
• architecture.md
• troubleshooting.md
• reference/commands.md