Referencia da CLI
Uso Global
Seção intitulada “Uso Global”claudex [OPTIONS] [COMMAND]| Opcao | Descricao |
|---|---|
--config <PATH> | Substituir caminho do arquivo de configuracao |
--version | Exibir versao |
--help | Exibir ajuda |
Quando executado sem um comando, o Claudex inicia o dashboard TUI se profiles estiverem configurados, ou exibe uma mensagem de boas-vindas se nenhum profile existir.
Comandos
Seção intitulada “Comandos”Executar o Claude Code com um profile de provedor especifico.
claudex run <PROFILE> [PROMPT] [OPTIONS] [-- ARGS...]| Argumento / Opcao | Descricao |
|---|---|
PROFILE | Nome do profile, ou auto para roteamento inteligente |
PROMPT | Prompt opcional para execucao nao-interativa (one-shot) |
-m, --model MODEL | Substituir o modelo padrao para esta sessao |
--hyperlinks | Forcar ativacao de hyperlinks OSC 8 no terminal |
--print | Imprimir a resposta e sair (modo nao-interativo) |
--dangerously-skip-permissions | Pular todas as solicitacoes de permissao (use com --print para CI/CD) |
ARGS... | Argumentos adicionais passados para claude (apos --) |
# Usar Grok (interativo)claudex run grok
# Usar Grok com um modelo especificoclaudex run grok -m grok-3-mini-beta
# Roteamento inteligenteclaudex run auto
# Forcar hyperlinks no terminalclaudex run grok --hyperlinks
# Execucao one-shot nao-interativaclaudex run grok "Explain this codebase" --print
# Uso em pipeline CI/CD (sem prompts, sem permissoes)claudex run grok "Fix lint errors" --print --dangerously-skip-permissions
# Passar argumentos extras para claudeclaudex run grok -- --verboseprofile
Seção intitulada “profile”Gerenciar profiles de provedores.
profile list
Seção intitulada “profile list”claudex profile listListar todos os profiles configurados com status, tipo de provedor e modelo.
profile add
Seção intitulada “profile add”claudex profile addAssistente interativo para adicionar um novo profile. Guia pela selecao do provedor, entrada da chave API (com armazenamento opcional no keyring), selecao de modelo e teste de conectividade.
profile show
Seção intitulada “profile show”claudex profile show <NAME>Exibir detalhes de um profile especifico incluindo todos os campos de configuracao.
profile remove
Seção intitulada “profile remove”claudex profile remove <NAME>Remover um profile da configuracao.
profile test
Seção intitulada “profile test”claudex profile test <NAME|all>Testar conectividade para um profile especifico ou todos os profiles. Envia uma requisicao leve ao endpoint /models do provedor.
Gerenciar autenticacao OAuth por assinatura para profiles de provedores.
auth login
Seção intitulada “auth login”claudex auth login <PROVIDER> [OPTIONS]| Opcao | Descricao |
|---|---|
--profile <NAME> | Associar a um profile especifico |
--enterprise-url <URL> | URL de servidor enterprise personalizado (para GitLab auto-hospedado, etc.) |
--headless | Usar fluxo headless (device code), pular lancamento do navegador |
Fazer login em um provedor usando OAuth. Provedores suportados: claude, openai, google, qwen, kimi, github, gitlab.
# Fazer login na OpenAI (le do Codex CLI)claudex auth login openai --profile codex-sub
# Fazer login no Claude (le de ~/.claude)claudex auth login claude
# Fazer login no Googleclaudex auth login google --profile gemini-sub
# Fazer login no GitLab com URL enterpriseclaudex auth login gitlab --enterprise-url https://gitlab.mycompany.com
# Modo headless (sem navegador, apenas device code)claudex auth login github --headlessauth status
Seção intitulada “auth status”claudex auth status [PROVIDER]Exibir o status de autenticacao atual. Sem argumento de provedor, exibe o status de todos os profiles OAuth configurados.
# Verificar todos os profiles OAuthclaudex auth status
# Verificar um provedor especificoclaudex auth status openaiauth refresh
Seção intitulada “auth refresh”claudex auth refresh <PROVIDER>Atualizar manualmente o token OAuth de um provedor. Os tokens tambem sao atualizados automaticamente pelo proxy quando expiram.
auth logout
Seção intitulada “auth logout”claudex auth logout <PROVIDER>Remover tokens OAuth armazenados de um provedor do keyring do sistema.
Gerenciar o servidor proxy de traducao.
proxy start
Seção intitulada “proxy start”claudex proxy start [OPTIONS]| Flag | Descricao |
|---|---|
-p, --port PORT | Substituir porta do proxy (padrao: da configuracao) |
-d, --daemon | Executar como daemon em segundo plano |
proxy stop
Seção intitulada “proxy stop”claudex proxy stopParar o daemon do proxy (envia SIGTERM via arquivo PID).
proxy status
Seção intitulada “proxy status”claudex proxy statusExibir se o proxy esta em execucao e em qual porta.
dashboard
Seção intitulada “dashboard”claudex dashboardIniciar o dashboard TUI para monitoramento em tempo real e lancamento rapido.
Gerenciar arquivos de configuracao.
config show
Seção intitulada “config show”claudex config showExibir o caminho do arquivo de configuracao carregado, ordem de busca e valores de configuracao atuais.
config path
Seção intitulada “config path”claudex config pathImprimir apenas o caminho resolvido do arquivo de configuracao.
config init
Seção intitulada “config init”claudex config initCriar um novo arquivo de configuracao no diretorio atual a partir do template embutido.
config recreate
Seção intitulada “config recreate”claudex config recreateRecriar o arquivo de configuracao a partir do config.example.toml, sobrescrevendo o config existente.
config edit
Seção intitulada “config edit”claudex config editAbrir o arquivo de configuracao no seu $EDITOR (ou $VISUAL).
config validate
Seção intitulada “config validate”claudex config validateValidar sintaxe do config, referencias de profiles (backup_providers, regras do router) e configuracoes de provedores OAuth. Reporta erros e avisos.
config get
Seção intitulada “config get”claudex config get <KEY>Obter um valor especifico de configuracao por caminho de chave (ex: proxy_port, profiles.0.name).
config set
Seção intitulada “config set”claudex config set <KEY> <VALUE>Definir um valor especifico de configuracao por caminho de chave.
config export
Seção intitulada “config export”claudex config exportExportar a configuracao mesclada atual para stdout no formato TOML.
Gerenciar conjuntos de configuracao (pacotes instalaveis de regras, skills e servidores MCP).
sets add
Seção intitulada “sets add”claudex sets add <PATH>Instalar um conjunto de configuracao a partir de um diretorio local contendo um manifest.json (ou manifest.yaml).
sets remove
Seção intitulada “sets remove”claudex sets remove <NAME>Remover um conjunto de configuracao instalado por nome.
sets list
Seção intitulada “sets list”claudex sets listListar todos os conjuntos de configuracao instalados com versao, descricao e resumo de componentes.
sets update
Seção intitulada “sets update”claudex sets update <NAME> <PATH>Atualizar um conjunto de configuracao existente a partir de um novo caminho de manifesto.
sets show
Seção intitulada “sets show”claudex sets show <NAME>Exibir informacoes detalhadas sobre um conjunto de configuracao instalado, incluindo todos os componentes.
claudex update [OPTIONS]| Flag | Descricao |
|---|---|
--check | Apenas verificar atualizacoes, sem instalar |
Sem --check, baixa e instala a versao mais recente do GitHub Releases.