Pular para o conteúdo

Configuração: CLIProxyAPI

Conecte o TomoriBot a um upstream autorizado por meio do CLIProxyAPI, um proxy local de Chat Completions.

Siga o início rápido oficial. Os arquivos de lançamento contêm executáveis prontos para uso; escolha seu sistema operacional e arquitetura de CPU, extraia o arquivo compactado e verifique o checksum. Compilar um clone do Git é opcional.

Configure o CLIProxyAPI antes de iniciá-lo. Se o instalador iniciou um serviço, pare-o primeiro.

Crie config.yaml ao lado do executável (cli-proxy-api.exe no Windows). Uma pasta de configuração separada é opcional; estes exemplos mantêm ambos os arquivos juntos. Substitua o marcador da chave de cliente por pelo menos 32 bytes aleatórios codificados em hex ou base64, gerados pelo seu gerenciador de senhas.

config-version: 8
server:
host: "127.0.0.1"
port: 8317
discovery:
enabled: false
management:
allow-remote: false
secret-key: ""
disable-control-panel: true
access:
api-keys:
- "REPLACE_WITH_RANDOM_CLIENT_KEY"
oauth:
auth-dir: "~/.cli-proxy-api"

A chave de cliente sob access.api-keys autentica o TomoriBot no CLIProxyAPI. Mantenha config.yaml e os arquivos de credenciais em oauth.auth-dir privados e fora do Git. Restrinja o acesso à sua conta e à conta do processo.

Deixe MANAGEMENT_PASSWORD sem definição e evite --password e a TUI de gerenciamento: o segredo de gerenciamento vazio mantém as rotas de gerenciamento desativadas, inclusive atrás do túnel. Se a sua versão usar um formato de configuração diferente, aplique essas definições ao config.example.yaml incluído.

Escolha como o CLIProxyAPI se autentica no provedor de modelos. Ambos os métodos usam a configuração base acima.

Execute o comando de login a partir da pasta que contém o executável e config.yaml. Estes exemplos usam Antigravity; substitua pela flag do seu provedor e revise a tela de consentimento dele antes de entrar:

ProvedorFlag de login
Antigravity--antigravity-login
Claude--claude-login
Codex--codex-login ou --codex-device-login
Terminal window
$configPath = (Resolve-Path .\config.yaml).Path
.\cli-proxy-api.exe --config $configPath --antigravity-login

Conclua o login no navegador e aguarde o terminal informar sucesso. O CLIProxyAPI salva as credenciais em oauth.auth-dir; uma configuração apenas com OAuth não precisa do bloco de chave de API upstream. Mantenha os listeners de callback OAuth locais e use o mesmo caminho de configuração para login e inicialização. Outras flags de login estão listadas em --help e nos guias de provedores upstream.

Inicie o servidor a partir da pasta que contém config.yaml. Substitua pelo caminho real do executável ou pelo comando instalado, se necessário; mantenha --config para que ele carregue este arquivo.

Terminal window
$configPath = (Resolve-Path .\config.yaml).Path
.\cli-proxy-api.exe --config $configPath

Deixe o servidor em execução e siga para o passo 5. Mantenha server.host em 127.0.0.1; nenhuma exceção de entrada no firewall ou redirecionamento de portas no roteador é necessária.

  1. Para um bot fora de produção rodando no mesmo computador que o CLIProxyAPI, defina ALLOW_PRIVATE_NETWORK=127.0.0.1:8317 no ambiente do TomoriBot e reinicie o bot. Use o listener local configurado acima; nenhum túnel é necessário.
  2. Execute /providers (gerenciadores do servidor) ou /personal providers e adicione um endpoint personalizado Compatível com OpenAI com estas configurações:
CampoValor
URL do Endpointhttp://127.0.0.1:8317/v1
Token de AutenticaçãoA chave de cliente de access.api-keys

Selecione a conexão salva, adicione um Modelo de Texto usando um ID ou alias servido pelo CLIProxyAPI e confirme uma resposta no Discord.

Esta URL pressupõe que o bot rode diretamente no host. No Docker, 127.0.0.1 identifica o contêiner, então ele não alcança o listener do host através desse endereço. Um bot rodando em modo de produção ainda exige o caminho de produção hospedado.

Como listar os modelos disponíveis

Com o CLIProxyAPI em execução, abra outro terminal para listar os IDs dos modelos. Desative transcrições do PowerShell ou rastreamento de shell antes de carregar a chave de cliente. Feche este terminal quando terminar.

Execute a partir da pasta que contém config.yaml; isso lê a primeira chave de cliente do layout acima.

Terminal window
$keyMatch = [regex]::Match((Get-Content -LiteralPath .\config.yaml -Raw), '(?m)^access:\r?\n api-keys:\r?\n - "([A-Za-z0-9+/=_-]+)"[ \t]*\r?$')
if (!$keyMatch.Success) { throw 'Expected a quoted client key under access.api-keys in config.yaml.' }
$engineKey = $keyMatch.Groups[1].Value
$headers = @{ Authorization = "Bearer $engineKey" }
$base = 'http://127.0.0.1:8317/v1'
$models = Invoke-RestMethod "$base/models" -Headers $headers
$models.data | Select-Object id
Remove-Variable engineKey, keyMatch, headers

Uma lista vazia exige configuração do upstream. HTTP 401 significa que o servidor respondeu, mas rejeitou a chave de cliente.

SintomaAção
401Verifique a chave de cliente separadamente da chave upstream.
404Use a base /v1, sem /chat/completions; verifique o ID do modelo.
Parâmetros rejeitadosDeixe Janela de Contexto em branco e o raciocínio em Automático; o TomoriBot já tenta novamente rejeições de parâmetros elegíveis antes do início da saída. Verifique os logs em busca de requisições degradadas antes de ativar ferramentas ou depender de controles de amostragem.
403, página de login em HTML ou erros de túnelVerifique a configuração do túnel. Se você ativou o Cloudflare Access, ele precisa da configuração opcional de Access e Caddy; o painel do Discord não consegue fornecer cabeçalhos do Access diretamente.
O stream é interrompidoVerifique a suspensão do PC, cota do upstream, integridade do túnel e os limites de stream no guia do Cloudflare.

Mantenha o log de requisições e depuração desativado, a menos que esteja diagnosticando uma reprodução local sem dados sensíveis. Faça a rotação de uma chave de cliente vazada no CLIProxyAPI e no endpoint salvo do TomoriBot, além de qualquer relay opcional que a utilize. Revogue credenciais upstream vazadas separadamente.

Desativar um login de conta

Revogue o acesso nas configurações da conta upstream, pare o proxy e remova os arquivos locais de credenciais dele. A exclusão dos arquivos por si só não revoga tokens.

Verificar o endereço de vinculação local

Se a API local estiver inacessível, verifique o endereço de vinculação dela em outro terminal enquanto o CLIProxyAPI estiver em execução:

Terminal window
Get-NetTCPConnection -LocalPort 8317 |
Select-Object LocalAddress, LocalPort, State, OwningProcess

Espere apenas 127.0.0.1; pare se vir 0.0.0.0, ::, * ou um endereço da LAN. Revise as regras de firewall existentes (wf.msc no Windows); não abra uma porta de entrada nem adicione redirecionamento de portas no roteador. O relatório de estado TCP do Windows pode omitir um endpoint acessível, portanto a consulta inclui todos os estados; a consulta opcional de modelos testa a acessibilidade da API.

Testar uma resposta local

Se um modelo falhar ao responder no Discord, teste-o diretamente enquanto o CLIProxyAPI estiver em execução. Desative transcrições do PowerShell ou rastreamento de shell antes de carregar a chave de cliente.

Execute a partir da pasta que contém config.yaml; isso lê a primeira chave de cliente do layout acima.

Terminal window
$keyMatch = [regex]::Match((Get-Content -LiteralPath .\config.yaml -Raw), '(?m)^access:\r?\n api-keys:\r?\n - "([A-Za-z0-9+/=_-]+)"[ \t]*\r?$')
if (!$keyMatch.Success) { throw 'Expected a quoted client key under access.api-keys in config.yaml.' }
$engineKey = $keyMatch.Groups[1].Value
$headers = @{ Authorization = "Bearer $engineKey" }
$base = 'http://127.0.0.1:8317/v1'
$body = @{
model = Read-Host 'Model ID to test'
messages = @(@{ role = 'user'; content = 'Reply with hello.' })
stream = $false
} | ConvertTo-Json -Depth 4
$reply = Invoke-RestMethod "$base/chat/completions" -Method Post -Headers $headers -ContentType 'application/json' -Body $body
$reply.choices.message.content
Remove-Variable engineKey, keyMatch, headers

Uma resposta gerada confirma o acesso ao upstream. Um resultado ausente na consulta de sockets por si só não prova que a API esteja inacessível.