QuantBrasil
Documentação
CLI

Primeiros passos

Da chave de API à primeira consulta em poucos comandos.

1. Crie uma chave

Abra Configurações → Chaves de API, crie uma chave e copie o valor exibido. Ele só deve ser compartilhado com a CLI no seu próprio computador.

2. Inicialize a CLI

npx -y @quantbrasil/cli@beta init

O comando salva a chave, valida a autenticação e instala a skill pública nos clientes compatíveis detectados.

3. Responda à entrevista do perfil

Depois de validar a chave, o init oferece uma entrevista curta, com três perguntas sobre mercados, horizonte e leitura de risco. As respostas personalizam os relatórios das skills e nunca alteram o resultado dos comandos. A entrevista é opcional. Pule com quantbrasil init --skip-profile e rode quantbrasil profile setup quando quiser. O que o perfil guarda e por que perguntamos está em Perfil local.

4. Verifique a conexão

quantbrasil --status
quantbrasil whoami

5. Faça a primeira consulta

quantbrasil market price PETR4
quantbrasil news asset PETR4 --window 7

Para uso em scripts, acrescente --json aos comandos que oferecem essa opção e consulte os limites de uso antes de automatizar chamadas em volume.