Setup guide

Provider setup guide

Browse setup steps and troubleshooting by tool.

Provider setup guide/CC-Switch general steps

CC-Switch general steps

CC Switch is an open-source AI programming CLI unified management tool. It mainly solves one problem: when you are using Claude Code, Codex, Gemini CLI, OpenCode, and other tools simultaneously, you don’t want to change Key, Base URL, model name, and MCP configuration individually for each tool.

What this tool is and what it is used for

It is suitable for people who have already installed multiple command-line AI programming tools. Ordinary beginners who only use one chat software do not need to learn CC Switch first; if you start using Claude Code, Codex CLI, and Gemini CLI at the same time, then consider using it to manage Providers in a unified way.

What scenarios is it suitable for

Multiple CLI Shared ProvidersThe same AI provider or official API needs to be used simultaneously for Claude Code, Codex, and Gemini CLI.
Frequently switch providersFor example, use the official account during the day, switch to the AI provider during testing, or switch different models in different projects.
Unified MCP / SkillsThe official CC Switch documentation also includes cross-tool management capabilities such as MCP and Skills. Beginners can start by learning to switch Providers first.

Download, install, and open for the first time

First, confirm the main interface After installation, first open the main program and make sure you can see entries like Provider, MCP, and Skills on the left. Beginners should only deal with Provider first, and should not change MCP and prompts at the same time.
CC Switch main screen
  1. Go to the CC Switch official website or GitHub Releases to download the current version.
  2. Windows users choose the installation package suitable for their system; macOS / Linux users follow the official installation instructions.
  3. After installation, first open the main program and confirm that the interface can load properly.
  4. If the system blocks the startup, first confirm that the source is the official repository or official website, and then follow the system prompts to allow it.

Add Provider

Add Provider Reference Here, first confirm the entry point and field locations for adding a new Provider; the fields for different target CLIs may have detailed differences depending on the version.
Adding a provider in the official CC Switch repository
  1. First, separately confirm that Claude Code, Codex CLI, and Gemini CLI can start on their own. CC Switch is a management tool, not something that installs all the CLIs for you.
  2. Download the installation package from the official CC Switch repository or official website. Do not download from unknown cloud storage.
  3. Open CC Switch and go to the Provider Management page.
  4. Add a new Provider and name it after the provider, for example, 'Some AI provider'.
  5. Enter the Base URL, API Key, and model name provided by the provider's backend. The fields may vary for different target tools, so fill them in according to the prompts on the current CC Switch page.
  6. After saving, select the target tool to apply, such as Claude Code, Codex, Gemini CLI.
  7. After executing Switch / Apply, follow the prompt to restart the corresponding terminal or CLI. According to the official documentation, most tools require a restart after switching, while Claude Code currently supports hot switching.
Configuration itemHow to FillAttention Beginners
Provider NameWrite the provider or purposeFor example, 'main AI provider' and 'backup official key', don't just write 1, 2, 3
Base URLCopy the provider backend API linkDecide whether to include it according to the backend example /v1
API KeyCopy the complete keyDo not take screenshots to make public, do not use the remark name as a key
Model NameCopy the model listClaude Code, Codex, and Gemini CLI may require different model names
Target ToolSelect the CLI to syncNot all providers can work with all tools. When it fails, first choose only one tool to test.

Verify separately according to target CLI

Target ToolWhat should be checked first?Detail page
Claude CodeClaude / Anthropic interface address, Key, Claude model nameCC-Switch Claude Code
Codex CLIOpenAI / Codex compatible address, Key, available Codex model namesCC-Switch Codex
Gemini CLIGoogle / Gemini or Vertex related authentication methodsCC-Switch Gemini
CC-Switch-CLICommand line configuration method when there is no graphical interfaceCC-Switch-CLI usage
CC Switch is the unified management entry, and does not mean one Provider can be applied to all CLIs indiscriminately. Claude, Codex, and Gemini have different interface protocols; if it fails, first choose only one target tool to test.

How to test after switching

After switching, do not immediately handle real projects. First, send the shortest question in an empty directory or test project to confirm the request actually goes to the provider you selected.

Minimal test command after switching
claude "Please reply only: Configuration successful" codex "Please reply only: Configuration successful" gemini "Please reply only: Configuration successful"
If a CLI still uses the old configuration, first close the current terminal window and reopen the terminal to try again. Do not manually modify the configuration file and use CC Switch to change the same item at the same time.