CLI Reference

Global Usage

claudex [OPTIONS] [COMMAND]

Option	Description
`--config <PATH>`	Override config file path
`--version`	Print version
`--help`	Print help

When run without a command, Claudex launches the TUI dashboard if profiles are configured, or shows a welcome message if no profiles exist.

Commands

`run`

Run Claude Code with a specific provider profile.

claudex run <PROFILE> [PROMPT] [OPTIONS] [-- ARGS...]

Argument / Option	Description
`PROFILE`	Profile name, or `auto` for smart routing
`PROMPT`	Optional prompt for non-interactive (one-shot) execution
`-m, --model MODEL`	Override the default model for this session
`--hyperlinks`	Force enable OSC 8 terminal hyperlinks
`--print`	Print the response and exit (non-interactive mode)
`--dangerously-skip-permissions`	Skip all permission prompts (use with `--print` for CI/CD)
`ARGS...`	Additional arguments passed to `claude` (after `--`)

# Use Grok (interactive)
claudex run grok

# Use Grok with a specific model
claudex run grok -m grok-3-mini-beta

# Smart routing
claudex run auto

# Force terminal hyperlinks
claudex run grok --hyperlinks

# Non-interactive one-shot execution
claudex run grok "Explain this codebase" --print

# CI/CD pipeline usage (no prompts, no permissions)
claudex run grok "Fix lint errors" --print --dangerously-skip-permissions

# Pass extra args to claude
claudex run grok -- --verbose

`profile`

Manage provider profiles.

`profile list`

claudex profile list

List all configured profiles with their status, provider type, and model.

`profile add`

claudex profile add

Interactive wizard to add a new profile. Guides through provider selection, API key entry (with optional keyring storage), model selection, and connectivity testing.

`profile show`

claudex profile show <NAME>

Show details for a specific profile including all configuration fields.

`profile remove`

claudex profile remove <NAME>

Remove a profile from the configuration.

`profile test`

claudex profile test <NAME|all>

Test connectivity for a specific profile or all profiles. Sends a lightweight request to the provider’s /models endpoint.

`auth`

Manage OAuth subscription authentication for provider profiles.

`auth login`

claudex auth login <PROVIDER> [OPTIONS]

Option	Description
`--profile <NAME>`	Associate with a specific profile
`--enterprise-url <URL>`	Custom enterprise server URL (for self-hosted GitLab, etc.)
`--headless`	Use headless (device code) flow, skip browser launch

# Log in to OpenAI (reads from Codex CLI)
claudex auth login openai --profile codex-sub

# Log in to Claude (reads from ~/.claude)
claudex auth login claude

# Log in to Google
claudex auth login google --profile gemini-sub

# Log in to GitLab with enterprise URL
claudex auth login gitlab --enterprise-url https://gitlab.mycompany.com

# Headless mode (no browser, device code only)
claudex auth login github --headless

`auth status`

claudex auth status [PROVIDER]

Show the current authentication status. Without a provider argument, shows status for all configured OAuth profiles.

# Check all OAuth profiles
claudex auth status

# Check a specific provider
claudex auth status openai

`auth refresh`

claudex auth refresh <PROVIDER>

Manually refresh the OAuth token for a provider. Tokens are also refreshed automatically by the proxy when they expire.

`auth logout`

claudex auth logout <PROVIDER>

Remove stored OAuth tokens for a provider from the system keyring.

`proxy`

Manage the translation proxy server.

`proxy start`

claudex proxy start [OPTIONS]

Flag	Description
`-p, --port PORT`	Override proxy port (default: from config)
`-d, --daemon`	Run as background daemon

`proxy stop`

claudex proxy stop

Stop the proxy daemon (sends SIGTERM via PID file).

`proxy status`

claudex proxy status

Show whether the proxy is running and on which port.

`dashboard`

claudex dashboard

Launch the TUI dashboard for real-time monitoring and quick-launch.

`config`

Manage configuration files.

`config show`

claudex config show

Display the loaded config file path, search order, and current configuration values.

`config path`

claudex config path

Print only the resolved config file path.

`config init`

claudex config init

Create a new config file in the current directory from the built-in template.

`config recreate`

claudex config recreate

Recreate the config file from config.example.toml, overwriting the existing config.

`config edit`

claudex config edit

Open the config file in your $EDITOR (or $VISUAL).

`config validate`

claudex config validate

Validate config syntax, profile references (backup_providers, router rules), and OAuth provider settings. Reports errors and warnings.

`config get`

claudex config get <KEY>

Get a specific configuration value by key path (e.g., proxy_port, profiles.0.name).

`config set`

claudex config set <KEY> <VALUE>

Set a specific configuration value by key path.

`config export`

claudex config export

Export the current merged configuration to stdout in TOML format.

`sets`

Manage configuration sets (installable bundles of rules, skills, and MCP servers).

`sets add`

claudex sets add <PATH>

Install a configuration set from a local directory containing a manifest.json (or manifest.yaml).

`sets remove`

claudex sets remove <NAME>

Remove an installed configuration set by name.

`sets list`

claudex sets list

List all installed configuration sets with their version, description, and component summary.

`sets update`

claudex sets update <NAME> <PATH>

Update an existing configuration set from a new manifest path.

`sets show`

claudex sets show <NAME>

Show detailed information about an installed configuration set, including all components.

`update`

claudex update [OPTIONS]

Flag	Description
`--check`	Only check for updates, don’t install

Without --check, downloads and installs the latest version from GitHub Releases.