Seu espaço de trabalho de API vive em uma GUI. Seu dia de trabalho vive em um terminal. Cada troca de contexto entre os dois custa segundos e foco, e em um pipeline de CI ou sessão de agente de IA, a GUI nem sequer é uma opção. O Apidog CLI fecha essa lacuna: ele traz toda a plataforma Apidog, testes, endpoints, esquemas, ambientes, expectativas de mock e documentação para o prompt de shell que você já tem aberto.
Uma definição honesta antes de tudo. O Apidog CLI não é outro curl. Se você quiser disparar um GET único e inspecionar o JSON, curl e HTTPie já fazem isso bem, e o resumo de clientes REST de terminal e TUI cobre o lado interativo. O Apidog CLI é um cliente para o seu próprio espaço de trabalho de API: ele executa os cenários de teste que você construiu, lê e atualiza o contrato da API e move especificações para dentro e para fora do projeto, tudo a partir de comandos que um script ou um agente pode chamar.
O que "vive no seu terminal" significa aqui
Ferramentas HTTP de terminal lidam com uma solicitação por vez. O Apidog CLI opera no nível do projeto. Sua superfície de comando abrange mais de quarenta grupos, e eles se agrupam em cinco tarefas:
| Tarefa | Comandos |
|---|---|
| Executar testes | run, test-scenario, test-suite, test-case, test-data, test-report |
| Gerenciar o contrato | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| Publicar documentos e mocks | doc, docs-site, shared-doc, mock |
| Configurar e conectar | environment, variables, vault, database-connection, websocket, socketio |
| Operar em equipe | branch, merge-request, runner, scheduled-task, audit-log, import, export |
Todo comando suporta --help, a saída é JSON estruturado, e a maioria das respostas inclui agentHints.nextSteps dizendo a você (ou ao seu agente) o que executar em seguida. Esse último detalhe parece pequeno. Ele muda a forma como a ferramenta é percebida: o CLI guia o fluxo de trabalho em vez de assumir que você o memorizou.
Instale-o em um comando
O CLI é distribuído como um pacote npm (apidog-cli) e funciona em macOS, Linux e Windows. Ele precisa do Node.js 16 ou superior.
npm install -g apidog-cli
apidog --version
Então, faça login com um token de acesso de API. Pegue-o no aplicativo Apidog: clique no seu avatar, abra as Configurações da Conta e copie o token em Token de Acesso à API.
apidog login --with-token <SEU_TOKEN>
O token é salvo em ~/.apidog/config.toml, então mantenha-o fora de seus repositórios e logs; em CI, passe-o por execução com --access-token de um segredo, em vez disso. Quatro flags globais cobrem a maioria dos contextos: --project seleciona o projeto, --branch seleciona o branch, --access-token sobrescreve o login salvo, e --api-base-url aponta o CLI para uma implantação Apidog auto-hospedada. O guia de autenticação do Apidog CLI detalha os tokens para CI.
Execute os testes que você construiu visualmente
Aqui está o fluxo de trabalho em torno do qual o CLI foi construído. Você cria um cenário de teste no editor visual do Apidog: requisições encadeadas, variáveis extraídas de uma resposta e injetadas na próxima, asserções de status e corpo. Então você o executa em qualquer lugar onde um shell exista.
# Copie este comando, incluindo os IDs, da aba CI/CD do cenário
apidog run -t <scenario_id> -e <env_id> -r cli
O comando sai com 0 quando todas as asserções passam e não zero quando algo falha, então um pipeline depende dele sem cola extra. Troque -e para apontar o mesmo cenário para ambientes de desenvolvimento, staging ou produção. Alimente-o com um arquivo CSV ou JSON e ele itera o cenário sobre cada linha, que é como o teste baseado em dados funciona sem duplicar etapas. Se você está começando do zero, o passo a passo para testar API REST via linha de comando vai da instalação à primeira execução bem-sucedida.
Os relatórios saem em quatro formatos: cli imprime resultados passo a passo no terminal, enquanto html, json e junit são salvos em apidog-reports/ para painéis e artefatos de CI. Combine-os livremente, como em -r cli,junit. O guia de relatórios de teste mostra como cada formato se parece.
Para execuções que não devem depender do seu laptop, os comandos runner e scheduled-task gerenciam runners auto-hospedados e execuções agendadas, a mesma mecânica por trás dos testes de API agendados no Apidog.
Gerencie o contrato da API sem abrir o aplicativo
Esta é a parte que nenhuma outra ferramenta de teste de terminal oferece. O mesmo CLI que executa seus testes pode ler e escrever a própria definição da API:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
Endpoints, esquemas de dados, pastas, ambientes, variáveis, esquemas de segurança e componentes reutilizáveis são todos consultáveis e editáveis. O comando mock gerencia expectativas de mock, os pares fixos de solicitação e resposta que seu servidor de mock retorna. Os comandos doc e docs-site manipulam a documentação publicada. Endpoints WebSocket e Socket.IO têm seus próprios grupos, e database-connection cobre as configurações de banco de dados que seus cenários de teste leem.
Importação e exportação utilizam os formatos importantes: OpenAPI 3.x e Swagger 2.0 (a especificação que a maioria das toolchains padroniza), além de coleções Postman. Isso torna o CLI uma ponte em scripts de migração: puxe uma especificação de um sistema, envie-a para o Apidog e gerencie a versão de toda a troca.
apidog import openapi.json --project <project_id>
apidog export --format openapi
Construído para que agentes de IA possam operá-lo
Os lançamentos de 2026 do CLI se apoiam fortemente em uma ideia: um agente de codificação de IA deve ser capaz de operar seu espaço de trabalho de API com a mesma segurança que uma pessoa. Quatro peças fazem isso funcionar.
Primeiro, saída estruturada. Cada comando retorna JSON que um agente pode analisar, e agentHints.nextSteps diz a ele o que fazer após cada resultado, incluindo como se recuperar de erros.
Segundo, um esquema de entrada publicado. apidog cli-schema list e apidog cli-schema get expõem a forma exata de JSON que cada comando de escrita espera, e apidog cli-schema validate verifica um payload antes que algo toque o projeto. O ritual de escrita segura é sempre o mesmo: obter o esquema, gerar o JSON, validá-lo e só então executar create ou update.
Terceiro, uma habilidade empacotada. O comando skill envia o conhecimento operacional do CLI em um formato que os agentes carregam diretamente, o que é a história por trás de por que construímos a skill do Apidog CLI. Em nossas próprias medições, agentes trabalhando através do esquema do CLI usaram cerca de 30% menos chamadas de ferramentas e 25% menos tokens do que agentes que adivinhavam os payloads; os números são detalhados nesta análise.
Quarto, portas de permissão. Por padrão, escritas originadas por IA em um branch são bloqueadas até que um humano ative as Permissões de Edição Externa de IA (no cliente Apidog 2.8.32 ou posterior, em Configurações do Projeto, Configurações de Recursos, Configurações de Recursos de IA). A alternativa é um branch de IA: um branch isolado onde um agente importa os recursos de que precisa, faz suas edições e entrega o resultado como uma solicitação de mesclagem para revisão. Branches de IA não tocados são automaticamente arquivados após 24 horas, para que experimentos não se acumulem. Seu contrato de API permanece revisável mesmo quando um agente escreve o primeiro rascunho.
O que o Apidog CLI não é
Três limites, declarados claramente, porque escolher ferramentas com informações honestas é melhor do que descobrir as lacunas depois.
Não é um cliente de requisição interativo. Não há comando que digite um POST ad-hoc e imprima a resposta de forma bonita; curl, HTTPie e os clientes TUI dominam essa tarefa, e são melhores nisso.
Não é de código aberto. O pacote é proprietário, npm é o único canal de instalação, e fazer qualquer coisa além de --help requer uma conta Apidog. A camada gratuita cobre todo o fluxo de trabalho descrito aqui, mas se uma licença auditável é um requisito rígido, um executor de código aberto é a recomendação honesta.
Não é autônomo. O CLI é o braço de terminal da plataforma: cenários, endpoints e ambientes vivem em seu projeto Apidog, não em arquivos locais. Essa é a troca que oferece uma única fonte de verdade para design, testes, mocks e documentação.
Onde ele se encaixa na caixa de ferramentas do terminal
Em relação a outros runners, a diferença está onde a autoria acontece. Newman e o Postman CLI executam coleções criadas no Postman; Hurl e Bruno executam testes criados como arquivos de texto; o Apidog CLI executa cenários criados em um editor visual que também contém seu contrato, mocks e documentos. A comparação Apidog CLI vs Newman aprofunda-se, e o campo completo é classificado no resumo das principais ferramentas de teste de API baseadas em terminal.
Uma configuração funcional para a maioria das equipes: mantenha curl ou xh na memória muscular para requisições rápidas, e deixe apidog run levar os conjuntos em CI. O passo a passo para GitHub Actions oferece um pipeline de copiar e colar para começar.
FAQ
O Apidog CLI é gratuito? Sim. O pacote é instalado gratuitamente via npm, e o nível gratuito do Apidog cobre a criação de cenários e a execução deles através do CLI. Planos pagos adicionam recursos para equipes, não acesso básico ao CLI.
Ele substitui o curl ou HTTPie? Não, e nem tenta. Essas ferramentas enviam requisições ad-hoc; o Apidog CLI executa cenários de teste salvos e gerencia recursos do projeto. A maioria dos terminais acaba usando ambos.
Ele pode rodar totalmente sem interface gráfica em CI? Sim. Autentique-se com --access-token de um segredo do CI, execute apidog run com o ID do seu cenário, e condicione a build ao código de saída. Nenhuma aplicação desktop é necessária no executor.
Quais formatos ele pode importar e exportar? OpenAPI 3.x, Swagger 2.0 e coleções Postman, em ambas as direções. Isso cobre migrações de entrada e integrações de saída.
Como os agentes de IA o usam com segurança? Através do ritual de validação de esquema e escrita, e portas de permissão: cli-schema validate detecta payloads malformados antes que sejam registrados, e os branches de IA mantêm as edições do agente isoladas até que um humano as mescle. Veja-o funcionando dentro de um agente em como usar o Apidog CLI no Claude Code.
O terminal é onde seus testes já rodam e onde seus agentes já trabalham. Colocar o cliente de API lá também remove a última troca de contexto. Baixe o Apidog, instale o CLI via npm e execute um cenário de ponta a ponta; a página do Apidog CLI tem a referência completa de comandos quando você estiver pronto para ir além de run.