providers
Provider management — list the provider catalog, and log in to subscription providers with OAuth.
Two ways a provider becomes available: BYOK (its API key in the environment — see BYOK) and providers login (OAuth against subscription providers such as Claude or Codex subscriptions — see Integrations). providers list shows the catalog and which providers are active in the current config.
bitrouter providers
Provider management
Usage: bitrouter providers [OPTIONS] <COMMAND>
Options
| Flag | Description |
|---|---|
-j, --json | Force JSON output (the default; agent-native). Conflicts with --human |
--human | Render the human-readable view to stdout instead of JSON |
bitrouter providers list
List every configured provider
Usage: bitrouter providers list [OPTIONS]
Options
| Flag | Description |
|---|---|
-c, --config <CONFIG> | Path to bitrouter.yaml. When omitted, the binary resolves in this order: ./bitrouter.yaml → $BITROUTER_HOME/bitrouter.yaml → ~/.bitrouter/bitrouter.yaml → zero-config in-memory defaults (bitrouter init is the explicit way to scaffold a file) |
-j, --json | Force JSON output (the default; agent-native). Conflicts with --human |
--human | Render the human-readable view to stdout instead of JSON |
bitrouter providers login
Log in to an upstream provider — interactive credential setup.
Per-provider methods are auto-derived from the catalog: claude-code adopts the live Claude Code session; anthropic accepts an API-key paste; openai-codex runs the ChatGPT PKCE flow; github-copilot the GitHub device flow; everything else accepts a pasted API key. Logging in to the built-in bitrouter provider runs the same cloud sign-in as bitrouter cloud login.
Usage: bitrouter providers login [OPTIONS] <PROVIDER>
Arguments
| Argument | Description |
|---|---|
<PROVIDER> | Provider id (e.g. claude-code, openai-codex, bitrouter) |
Options
| Flag | Description |
|---|---|
-j, --json | Force JSON output (the default; agent-native). Conflicts with --human |
-l, --label <LABEL> | Account label this credential is stored under (default default). Ignored for the bitrouter provider (it uses the cloud credential) [default: default] |
--human | Render the human-readable view to stdout instead of JSON |
--import-existing | Import an existing vendor CLI session without prompting for a browser sign-in. Currently supported by openai-codex |
--no-browser | Do not run a browser-based provider OAuth flow |
bitrouter providers login <provider-id>Opens the provider's OAuth flow and stores the credential in the local credential store — no key to paste. providers logout removes it.
bitrouter providers logout
Log out of an upstream provider — clears every stored credential for it. For the built-in bitrouter provider this is cloud logout
Usage: bitrouter providers logout [OPTIONS] <PROVIDER>
Arguments
| Argument | Description |
|---|---|
<PROVIDER> | Provider id whose stored credentials should be removed |
Options
| Flag | Description |
|---|---|
-j, --json | Force JSON output (the default; agent-native). Conflicts with --human |
--human | Render the human-readable view to stdout instead of JSON |
How is this guide?