Ferramenta de linha de comando

O CLI do AIVAX opera uma conta do AIVAX diretamente no terminal. Ele abrange os mesmos produtos da API, incluindo Gateways de IA, coleções RAG, clientes de chat, Batch, Testes Agentic, pesquisa na web, OCR, gerações, conversas, habilidades, logs e configurações da conta, sem exigir que você escreva requisições HTTP.

O CLI é de código aberto sob a licença MIT e publicado no npm como @aivax/cli.

Quando usá-lo #

Use o CLI quando uma pessoa ou um agente trabalha com uma conta de forma interativa ou por meio de scripts:

• inspecionando e ajustando gateways, coleções e clientes de chat sem abrir o painel;
• importando documentos para uma coleção ou transcrevendo as páginas de um PDF longo, uma a uma, para Markdown ou JSONL pronto para RAG;
• criando, iniciando e exportando trabalhos do Batch a partir de arquivos locais;
• executando Testes Agentic, verificando o consumo ou lendo conversas e logs durante a depuração;
• fornecendo a um agente de codificação uma maneira compacta de operar o AIVAX, já que as respostas são otimizadas para agentes por padrão.

Para código de aplicativo que atende usuários finais, chame a API ou um SDK compatível com OpenAI diretamente em vez disso.

Instalação #

O CLI requer o Node.js 22.19 ou versão mais recente.

npm install -g @aivax/cli
aivax auth login

Outros gerenciadores de pacotes também funcionam, como pnpm add -g @aivax/cli ou bun install -g @aivax/cli.

aivax auth login salva um perfil de conta. A chave de acesso é mantida no armazenamento de credenciais do sistema operacional. Para vincular um perfil sem compartilhar a chave de login da conta, por exemplo, quando um agente de codificação configura o CLI, passe uma chave de API existente em vez disso:

aivax auth login --api-key <API_KEY> --profile-name <PROFILE_NAME>

Para scripts e CI, defina a variável de ambiente AIVAX_API_KEY em vez de fazer login.

O que ele pode fazer #

Pergunte a um gateway sobre um arquivo local:

aivax gateways chat -m <GATEWAY_ID> "Summarize this contract" -f contract.pdf --stream

Pesquise uma coleção ou transcreva um documento e indexe-o:

aivax rag search --collection <COLLECTION_ID> -q "refund policy" -k 10
aivax ocr document manual.pdf --format jsonl -o manual.jsonl
aivax rag import -c <COLLECTION_ID> -f manual.jsonl

Execute um trabalho do Batch a partir de um arquivo JSONL e exporte os resultados:

aivax batch items import -w <WORKFLOW_ID> -j <JOB_ID> -f customers.jsonl
aivax batch jobs start -w <WORKFLOW_ID> -j <JOB_ID>
aivax batch jobs export -w <WORKFLOW_ID> -j <JOB_ID> -o results.jsonl

Gere mídia, pesquise na web ou verifique os gastos:

aivax generate speech -m <MODEL_ID> -t @script.txt -o narration.mp3
aivax web search -q "AI regulation news" --country US
aivax analytics balance

Chame qualquer endpoint que não tenha um comando dedicado:

aivax api get /api/v1/notifications/unread/count

Execute aivax --help para listar todos os grupos de comandos e adicione --help a qualquer comando para ver suas opções. aivax docs reference <ENDPOINT_NAME> mostra a referência da API para um endpoint sem sair do terminal.