Quick Start: Get OmniRoute Running in 3 Minutes

Etapa 1: Instale o OmniRoute

Escolha seu método preferido:

Opção A: npm (Recomendado)

npm install -g omniroute

Opção B: Docker

docker run -d --name omniroute -p 20128:20128 diegosouzapw/omniroute:latest

:latest é a versão SemVer estável publicada mais recente. Ela não acompanha a branch main do git. Fixe diegosouzapw/omniroute:X.Y.Z para GitOps. Consulte Tags de imagem / Canais de lançamento.

Opção C: A partir do código-fonte

git clone https://github.com/diegosouzapw/OmniRoute.git
cd OmniRoute
npm install
npm run dev

---

Etapa 2: Inicie o OmniRoute

omniroute

O OmniRoute é iniciado em http://localhost:20128. O painel é aberto automaticamente.

---

Etapa 3: Conecte um provedor gratuito

Você pode usar o OmniRoute sem pagar nada conectando um provedor gratuito.

Opção A: Kiro (Claude gratuito — Sem cartão de crédito)

1. Abra o painel em http://localhost:20128
2. Acesse Provedores → Adicionar provedor
3. Selecione Kiro AI
4. Clique em Conectar (nenhuma chave de API é necessária!)
5. Pronto! Agora você tem acesso gratuito aos modelos Claude.

Opção B: OpenCode Free (Sem autenticação)

1. Abra o painel em http://localhost:20128
2. Acesse Provedores → Adicionar provedor
3. Selecione OpenCode Free
4. Clique em Conectar (nenhuma chave de API é necessária!)
5. Pronto! Agora você tem acesso gratuito a vários modelos.

Opção C: Pollinations (Nenhuma chave necessária)

1. Abra o painel em http://localhost:20128
2. Acesse Provedores → Adicionar provedor
3. Selecione Pollinations
4. Clique em Conectar (nenhuma chave de API é necessária!)
5. Pronto! Agora você tem acesso gratuito ao GPT-5, Claude, Gemini e muito mais.

---

Etapa 4: Verifique se funciona

Em Chaves de API, crie uma nova chave. Armazene essa chave, pois ela não será exibida novamente. Observe que essa chave serve para que as ferramentas acessem o OmniRoute, e não para acessar os provedores upstream.

curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"

Você deverá ver seus modelos conectados listados.

---

Etapa 5: Aponte sua IDE ou CLI para o OmniRoute

Na sua IDE ou ferramenta de CLI, defina:

Base URL: http://localhost:20128/v1
API Key:  [copy from Dashboard → Endpoints]
Model:    auto

É só isso! Agora sua IDE usa o OmniRoute com seleção automática de provedor.

Exemplo de IDE: VSCode/Continue.dev

1. No VSCode, instale a extensão Continue.dev.
2. Atualize seu ~/.continue/config.yaml para adicionar as seguintes linhas:

  - name: OmniRoute - Auto
    provider: openai
    model: auto
    apiBase: http://localhost:20128/v1
    apiKey: <YOUR_KEY>

3. No painel de chat do Continue.dev, selecione OmniRoute - Auto e você fará solicitações ao OmniRoute.
4. (Opcional) Exercício para o leitor — peça à sua IDE para atualizar o config.yaml com todas as outras configurações predefinidas 😊

Exemplo de CLI: Codex CLI

1. No seu sistema operacional, defina a variável de ambiente de forma persistente. Para macOS/Linux (adicione ao seu ~/.bashrc ou ~/.zshrc):

export OMNIROUTE_API_KEY="<YOUR_KEY>"

Para Windows (Prompt de Comando):

setx OMNIROUTE_API_KEY <YOUR_KEY>

2. Agora vamos iniciar o Codex, mas configurado para o OmniRoute. Execute:

omniroute launch-codex --model auto

Você pode fazer isso manualmente por meio do codex e de parâmetros de linha de comando para especificar o endpoint e a chave de API, mas, com o comando acima, o OmniRoute cuida de tudo para você.

O mesmo início com um único comando funciona para outras CLIs por meio do inicializador genérico — omniroute run <target> oferece suporte a claude, codex, aider, goose, opencode, qwen e gemini (consulte Integrações de CLI).

3. Agora a CLI deverá estar enviando solicitações ao OmniRoute.

Confirme se sua ferramenta está roteando para o OmniRoute

Você pode ver os detalhes da solicitação clicando em Monitoramento/Logs na barra lateral esquerda. Ao navegar pelas opções, você verá mais detalhes. Como observação adicional, você pode ver quais informações são enviadas pelo seu harness favorito. Isso é útil para fins educacionais e de depuração.

---

Próximos passos

• Guia do Auto-Combo — Deixe o OmniRoute escolher a melhor IA para você
• Guia de provedores — Conecte mais provedores (gratuitos e pagos)
• Guia de planos gratuitos — Obtenha IA gratuita sem cartão de crédito
• Solução de problemas — Corrija problemas comuns

---

Perguntas frequentes

“Preciso de uma chave de API?”

Não! Você pode usar provedores gratuitos (Kiro, OpenCode Free, Pollinations) sem nenhuma chave de API. Basta conectá-los no painel.

“O que é auto?”

auto instrui o OmniRoute a escolher automaticamente o melhor provedor para cada solicitação. Ele considera velocidade, custo, qualidade e disponibilidade. Consulte o Guia do Auto-Combo para obter detalhes.

“Quanto custa?”

O próprio OmniRoute é gratuito e de código aberto. Você paga apenas pelos provedores que usar. Muitos provedores têm planos gratuitos — consulte o Guia de planos gratuitos.

“Posso usá-lo com Claude Code / Cursor / Copilot?”

Sim! O OmniRoute funciona com qualquer ferramenta compatível com o formato OpenAI. Basta definir a URL base como http://localhost:20128/v1. Consulte o Guia de ferramentas de CLI para obter instruções específicas de configuração.

“E se um provedor ficar indisponível?”

O OmniRoute ignora automaticamente os provedores com falha e tenta o próximo. Você não precisa fazer nada. Consulte o Guia do Auto-Combo para obter detalhes.

---

Precisa de ajuda?

• Solução de problemas — Problemas comuns e correções
• Discord — Suporte da comunidade
• Issues do GitHub — Relate bugs

---

undefined (a58000c7685f)