Primeiros passos

O que você precisa

• Node 24 ou mais recente.
• npm, que já vem com o Node.

Tudo roda localmente. Nenhuma conta é criada, nenhuma chave é exigida para começar, e nenhuma requisição sai da sua máquina durante nenhum dos passos abaixo.

Instale o OpenLimiter

Instale a ferramenta de linha de comando globalmente, depois rode a demonstração sintética dela.

npm install -g openlimiter
openlimiter demo

openlimiter demo renderiza fixtures sintéticos. Isso prova que o binário funciona sem tocar em nenhuma conta real, e todo número que ele imprime é inventado.

Dê a ele algo para medir

O OpenLimiter nunca contata um provedor nesta versão. Ele interpreta dados que outra coisa já colocou na frente dele. Até que um dos caminhos de ingestão rode, todo comando reporta unknown com honestidade.

O caminho que não precisa de nenhum trabalho extra é o statusline do Claude Code. O Claude Code roda seu comando de statusline a cada renderização e escreve um objeto JSON descrevendo a sessão atual na entrada padrão desse comando. Quando esse objeto carrega um bloco de limite de taxa, o OpenLimiter o valida, guarda em cache, e renderiza os números atualizados na mesma chamada.

openlimiter statusline < session.json
OpenLimiter NEAR_CAP NONE UNKNOWN OPENROUTER,CODEX,ANTIGRAVITY,OPENCODE,MANUAL  CLAUDE ####. 87.5%

Nem toda versão do Claude Code envia campos de limite de taxa. Se a sua não envia, este caminho fica quieto e os dois caminhos manuais continuam funcionando. A página de ingestão cobre os três.

Conecte o Claude Code

Adicione isto ao settings.json do seu Claude Code. A instalação global torna o comando openlimiter disponível para o Claude Code.

{
  "statusLine": {
    "type": "command",
    "command": "openlimiter statusline"
  },
  "hooks": {
    "UserPromptSubmit": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "openlimiter hook"
          }
        ]
      }
    ]
  }
}

Contribua a partir do código fonte

Use o toolchain do repositório quando quiser contribuir.

git clone https://github.com/lucaswebsystems/openlimiter
cd openlimiter
pnpm install
pnpm build
pnpm typecheck
pnpm test
node packages/cli/dist/bin.js demo

O build precisa rodar antes da checagem de tipos, porque cada pacote resolve seus vizinhos pelos arquivos de declaração que o build produz.

Para onde ir agora

Uma ordem de leitura razoável

1. 1Por que o OpenLimiter para o problema que ele resolve.
2. 2Provedores suportados para o que cada connector lê e quão frágil ele é.
3. 3Agent context para exatamente o que chega ao seu agente.
4. 4Referência da CLI para cada comando e código de saída.