Install
Use npm or Bun if you want the easiest setup:
# or
Then verify the command is available:
Other Install Options
Install the latest GitHub release directly:
|
Build from source:
Requires Rust 1.94 or newer.
Setup
- Log in with your first Codex account:
- Log in with another Codex account and save it:
- Switch when needed:
Use --include-config when a profile also needs ~/.codex/config.toml, for
example custom providers:
Then restore the official Codex provider configuration and re-save each official
profile with --include-config:
By default, CodexSwitch backs up and replaces the entire config.toml. This is
the simplest behavior and ensures a profile restores exactly what was saved.
To save and replace only specific top-level fields while preserving everything
else in the active config, create ~/.codex/codexswitch/config.toml:
= [
"model",
"model_provider",
"model_providers",
]
Loading an auth-only profile does not change any active config fields. Saving
provider-specific and official profiles with --include-config ensures that
switching profiles also switches providers correctly.
Common Commands
| Command | What it does |
|---|---|
codexswitch-cli save --label work |
Save the current ~/.codex/auth.json as a profile. |
codexswitch-cli load --label work |
Restore a saved profile. |
codexswitch-cli list |
Show saved profiles. |
codexswitch-cli status --all |
Show active and saved profile usage. |
codexswitch-cli export --output profiles.json |
Export profiles for backup or transfer. |
codexswitch-cli import --input profiles.json |
Import profiles from an export bundle. |
codexswitch-cli doctor --fix |
Check and repair local profile storage. |
Run codexswitch-cli help <command> for command-specific options.
Storage
Profiles are stored locally under:
~/.codex/codexswitch/profiles/
Auth files and export bundles contain secrets. Keep them private.
Roadmap
- Polish the terminal UI for clearer, more attractive file-related output.
- Improve
statuswith richer usage details, exploring thecodex-limitmethodology and ideas fromcodex-profilesPR #24.
Docs
About SyntaxSkills
SyntaxSkills hosts this repository to keep maintenance continuous and community-owned. The goal is not profit; it is to keep the tool maintained beyond any single person. Contributors and maintainers are welcome to join.
Acknowledgements
CodexSwitch CLI is inspired by
codex-profiles and
preserves its commit history in this repository.