Ir para o guia
RubyCLIGuia de configuraçãoDocumentação

Ruby · agentes de código

Claude Code e Codex,
conectados à sua conta.

Use os modelos Ruby nos seus agentes de desenvolvimento. Escolha o cliente, conecte sua chave e acompanhe o consumo em Ruby Units pelo painel.

Comece com uma chave Ruby

Crie sua chave em Chaves de API e copie o valor completo quando ele aparecer. Os scripts consultam /v1/models para validar a chave e oferecer os modelos disponíveis, sem gerar uma resposta de IA.

01 · Anthropic Messages

Claude Code

O instalador prepara o Claude Code oficial quando necessário e salva sua conexão Ruby. Se o cliente já estiver disponível, aproveita a instalação existente.

PowerShell
irm https://app.rubycli.cloud/install.ps1 | iex

Requer PowerShell 5.1 ou superior. Cole a chave no prompt oculto, selecione o modelo e depois execute claude na pasta do projeto. No macOS/Linux, se necessário, use ~/.local/bin/claude.

Base do Claudehttps://app.rubycli.cloud/anthropic

O cliente acrescenta /v1/messages. A configuração inclui os aliases de modelos, subagentes e ferramentas locais, com confirmação normal de permissões.

A chave fica nas configurações locais do Claude. Arquivos anteriores recebem backup; hooks, MCP e permissões específicas são preservados. Execute o instalador novamente para trocar a chave ou o modelo.

Desktop, Cowork e IDE

O Claude Desktop precisa estar instalado. O instalador reconhece sua configuração e prepara a conexão Ruby; feche e abra o aplicativo para aplicar. Uma sessão pessoal da Anthropic é preservada por padrão. Consulte a seção do instalador para selecionar a Ruby explicitamente com RUBY_DESKTOP=1.

Para superfícies do Claude Code na IDE, reinicie o editor após configurar. Políticas administradas e configurações do projeto podem prevalecer sobre a configuração do usuário.

02 · OpenAI Responses

Codex CLI

Instale o Codex CLI oficial e confirme que codex está no PATH. O auxiliar abaixo abre uma sessão com seu modelo Ruby, sem alterar seu arquivo de configuração.

Base do Codexhttps://app.rubycli.cloud/v1

O cliente chama /responses, recebe eventos SSE e executa as funções locais. A chave é passada por RUBY_API_KEY; o auxiliar mantém esse valor apenas durante a sessão.

Iniciar com o auxiliar
Configuração manual e extensão de IDE

Para configurar manualmente, acrescente o provedor e o perfil abaixo a ~/.codex/config.toml, preservando as outras seções. Respeite CODEX_HOME se usar uma pasta própria. Substitua ID_DO_MODELO por um ID do catálogo.

config.toml do usuário
[profiles.rubycli]
model_provider = "ruby"
model = "ID_DO_MODELO"
web_search = "disabled"
model_supports_reasoning_summaries = false

[model_providers.ruby]
name = "RubyCLI"
base_url = "https://app.rubycli.cloud/v1"
env_key = "RUBY_API_KEY"
wire_api = "responses"
requires_openai_auth = false
supports_websockets = false

Forneça RUBY_API_KEY no ambiente e execute:

Perfil Ruby no Codex
codex --profile rubycli

Na extensão, abra Codex Settings → Open config.toml. Use o arquivo do usuário; configurações de provedor no arquivo do projeto não são aplicadas. A IDE precisa herdar RUBY_API_KEY ao iniciar. Para selecionar a Ruby como padrão, use model_provider = "ruby" e o modelo desejado no nível principal do TOML.

03 · Cliente já instalado

Escolha o agente e abra seu projeto

Baixe o auxiliar, execute na pasta do projeto e escolha Claude Code ou Codex. Ele solicita a chave sem exibi-la e valida o modelo antes de abrir o cliente.

Windows

Coloque os arquivos .cmd e .ps1 na mesma pasta e execute o .cmd. Também pode executar o PowerShell diretamente:

PowerShell · auxiliar local
powershell -NoProfile -ExecutionPolicy Bypass -File .\rubycli-setup.ps1

macOS / Linux / WSL

Após baixar, execute o arquivo pelo Bash:

Bash · auxiliar local
bash ./rubycli-setup.sh

Claude: reutiliza o instalador em modo de configuração e salva a chave localmente com backup. Codex: aplica as opções somente à sessão iniciada; mantém os perfis e o TOML existentes e não grava a chave em arquivo. Para abrir outra sessão Ruby, execute o auxiliar novamente.

04 · Compatibilidade

O que os endpoints aceitam

ClienteEndpointFormato
Claude Code / Desktop/anthropic/v1/messagesAnthropic Messages
Codex/v1/responsesOpenAI Responses
SDKs OpenAI/v1/chat/completionsChat Completions
  • Todos os formatos usam a mesma autorização, saldo, cotas e registro de consumo Ruby.
  • Envie o histórico completo em cada chamada. Responses deve usar store: false; previous_response_id, conversas persistentes e background não estão disponíveis.
  • O transporte é HTTP com SSE. Ferramentas hospedadas pelos provedores e WebSocket não estão disponíveis; funções executadas pelo cliente dependem do suporte do modelo.
  • O instalador desativa o thinking estendido e a busca de ferramentas do Claude. O auxiliar Codex desativa a busca web hospedada. Opções incompatíveis retornam erro de validação.
  • A interface Anthropic exige anthropic-version e aceita Bearer ou x-api-key. /v1/messages continua disponível. A contagem em /anthropic/v1/messages/count_tokens é estimada e não gera uma inferência.

Se a conexão não funcionar

Confira o ID em /v1/models, a validade da chave e o saldo no painel. No Claude Code, use /status; no Codex, confira o provedor selecionado. Depois de trocar a configuração, reinicie o cliente.

Ver exemplos dos protocolos