Tu espacio de trabajo API reside en una GUI. Tu jornada laboral transcurre en una terminal. Cada cambio de contexto entre ambos cuesta segundos y concentración, y en una tubería de CI o una sesión de agente de IA, la GUI ni siquiera es una opción. La CLI de Apidog cierra esa brecha: lleva toda la plataforma Apidog, pruebas, endpoints, esquemas, entornos, expectativas de simulación y documentación, al prompt de shell que ya tienes abierto.
Una definición honesta antes que nada. La CLI de Apidog no es otro curl. Si quieres lanzar un GET puntual y echar un vistazo al JSON, curl y HTTPie ya lo hacen bien, y la recopilación de clientes REST de terminal y TUI cubre el lado interactivo. La CLI de Apidog es un cliente para tu propio espacio de trabajo API: ejecuta los escenarios de prueba que has construido, lee y actualiza el contrato API, y mueve especificaciones dentro y fuera del proyecto, todo desde comandos que un script o un agente puede llamar.
Qué significa aquí “reside en tu terminal”
Las herramientas HTTP de terminal manejan una solicitud a la vez. La CLI de Apidog opera a nivel de proyecto. Su superficie de comandos abarca más de cuarenta grupos, que se agrupan en cinco tareas:
| Tarea | Comandos |
|---|---|
| Ejecutar pruebas | run, test-scenario, test-suite, test-case, test-data, test-report |
| Gestionar el contrato | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| Publicar docs y mocks | doc, docs-site, shared-doc, mock |
| Configurar y conectar | environment, variables, vault, database-connection, websocket, socketio |
| Operar como un equipo | branch, merge-request, runner, scheduled-task, audit-log, import, export |
Cada comando admite --help, la salida es JSON estructurado y la mayoría de las respuestas incluyen agentHints.nextSteps que te indican (o a tu agente) qué ejecutar a continuación. Ese último detalle parece pequeño. Cambia la forma en que se siente la herramienta: la CLI guía el flujo de trabajo en lugar de asumir que lo memorizaste.
Instálalo con un solo comando
La CLI se distribuye como un paquete npm (apidog-cli) y se ejecuta en macOS, Linux y Windows. Necesita Node.js 16 o posterior.
npm install -g apidog-cli
apidog --version
Luego, inicia sesión con un token de acceso API. Obténlo desde la aplicación Apidog: haz clic en tu avatar, abre Configuración de la cuenta y copia el token bajo Token de Acceso API.
apidog login --with-token <YOUR_TOKEN>
El token se guarda en ~/.apidog/config.toml, así que mantenlo fuera de tus repositorios y registros; en CI, pásalo por ejecución con --access-token desde un secreto en su lugar. Cuatro banderas globales cubren la mayoría de los contextos: --project selecciona el proyecto, --branch selecciona la rama, --access-token anula el inicio de sesión guardado, y --api-base-url apunta la CLI a una implementación de Apidog autoalojada. La guía de autenticación de la CLI de Apidog detalla el uso de tokens para CI.
Ejecuta las pruebas que construiste visualmente
Aquí está el flujo de trabajo en torno al cual se construyó la CLI. Creas un escenario de prueba en el editor visual de Apidog: solicitudes encadenadas, variables extraídas de una respuesta e inyectadas en la siguiente, aserciones sobre el estado y el cuerpo. Luego lo ejecutas dondequiera que exista un shell.
# Copia este comando, incluyendo los IDs, de la pestaña CI/CD del escenario
apidog run -t <scenario_id> -e <env_id> -r cli
El comando sale con 0 cuando todas las aserciones pasan y con un valor distinto de cero cuando algo falla, por lo que una tubería de CI puede depender de ello sin necesidad de pegamento adicional. Cambia -e para apuntar el mismo escenario a entornos de desarrollo, staging o producción. Aliméntalo con un archivo CSV o JSON y el escenario se iterará sobre cada fila, que es como funciona el testing impulsado por datos sin duplicar pasos. Si estás empezando desde cero, el tutorial paso a paso de REST API te lleva desde la instalación hasta la primera ejecución exitosa.
Los informes se generan en cuatro formatos: cli imprime los resultados paso a paso en la terminal, mientras que html, json y junit se guardan en apidog-reports/ para paneles y artefactos de CI. Combínalos libremente, como en -r cli,junit. La guía de informes de prueba muestra cómo se ve cada formato.
Para ejecuciones que no deben depender de tu portátil, los comandos runner y scheduled-task gestionan runners autoalojados y ejecuciones programadas, la misma maquinaria detrás de las pruebas API programadas en Apidog.
Gestiona el contrato API sin abrir la aplicación
Esta es la parte que ninguna otra herramienta de prueba de terminal ofrece. La misma CLI que ejecuta tus pruebas puede leer y escribir la definición de la API:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
Endpoints, esquemas de datos, carpetas, entornos, variables, esquemas de seguridad y componentes reutilizables son todos consultables y editables. El comando mock gestiona las expectativas de simulación, los pares fijos de solicitud y respuesta que devuelve tu servidor mock. Los comandos doc y docs-site afectan la documentación publicada. Los endpoints de WebSocket y Socket.IO tienen sus propios grupos, y database-connection cubre las configuraciones de base de datos que leen tus escenarios de prueba.
La importación y exportación admiten los formatos importantes: OpenAPI 3.x y Swagger 2.0 (la especificación en la que se estandarizan la mayoría de las cadenas de herramientas), además de las colecciones de Postman. Esto convierte a la CLI en un puente en los scripts de migración: extrae una especificación de un sistema, impórtala a Apidog y versiona todo el intercambio.
apidog import openapi.json --project <project_id>
apidog export --format openapi
Diseñado para que los agentes de IA puedan manejarlo
Las versiones de 2026 de la CLI se inclinan fuertemente hacia una idea: un agente de codificación de IA debería poder operar tu espacio de trabajo API tan de forma segura como una persona. Cuatro elementos hacen que esto funcione.
Primero, salida estructurada. Cada comando devuelve JSON que un agente puede analizar, y agentHints.nextSteps le indica qué hacer después de cada resultado, incluyendo cómo recuperarse de errores.
Segundo, un esquema de entrada publicado. apidog cli-schema list y apidog cli-schema get exponen la forma JSON exacta que cada comando de escritura espera, y apidog cli-schema validate verifica una carga útil antes de que algo toque el proyecto. El ritual de escritura segura es siempre el mismo: obtener el esquema, generar el JSON, validarlo y solo entonces ejecutar create o update.
Tercero, una habilidad empaquetada. El comando skill envía el conocimiento operativo de la CLI en un formato que los agentes cargan directamente, que es la razón detrás de por qué construimos la habilidad de la CLI de Apidog. Según nuestras propias mediciones, los agentes que trabajan a través del esquema de la CLI utilizaron aproximadamente un 30% menos de llamadas a herramientas y un 25% menos de tokens que los agentes que adivinaban las cargas útiles; los números se desglosan en este análisis.
Cuarto, puertas de permiso. Por defecto, las escrituras en una rama originadas por IA están bloqueadas hasta que un humano habilita los Permisos de Edición de IA Externa (en el cliente Apidog 2.8.32 o posterior, bajo Configuración del Proyecto, Configuración de Funciones, Configuración de Funciones de IA). La alternativa es una rama de IA: una rama aislada donde un agente importa los recursos que necesita, realiza sus ediciones y devuelve el resultado como una solicitud de fusión para su revisión. Las ramas de IA no modificadas se autoarchivan después de 24 horas, para que los experimentos no se acumulen. Tu contrato API permanece revisable incluso cuando un agente escribe el primer borrador.
Lo que la CLI de Apidog no es
Tres límites, establecidos claramente, porque elegir herramientas con información honesta es mejor que descubrir las deficiencias más tarde.
No es un cliente de solicitudes interactivo. No hay ningún comando que escriba un POST ad-hoc y muestre la respuesta de forma bonita; curl, HTTPie y los clientes TUI son dueños de ese trabajo, y son mejores en ello.
No es de código abierto. El paquete es propietario, npm es el único canal de instalación, y hacer cualquier cosa más allá de --help requiere una cuenta de Apidog. El nivel gratuito cubre todo el flujo de trabajo descrito aquí, pero si una licencia auditable es un requisito estricto, un runner de código abierto es la recomendación honesta.
No es independiente. La CLI es el brazo de terminal de la plataforma: los escenarios, endpoints y entornos viven en tu proyecto Apidog, no en archivos locales. Ese es el trato que te proporciona una única fuente de verdad en diseño, pruebas, simulaciones y documentación.
Dónde encaja en la caja de herramientas de la terminal
Frente a otros runners, la diferencia radica en dónde ocurre la autoría. Newman y la CLI de Postman ejecutan colecciones creadas en Postman; Hurl y Bruno ejecutan pruebas creadas como archivos de texto; la CLI de Apidog ejecuta escenarios creados en un editor visual que también contiene tu contrato, simulaciones y documentos. La comparación entre Apidog CLI vs Newman profundiza, y el campo completo está clasificado en la recopilación de las principales herramientas de prueba de API basadas en terminal.
Una configuración funcional para la mayoría de los equipos: mantén curl o xh en la memoria muscular para pruebas rápidas, y deja que apidog run ejecute los conjuntos de pruebas en CI. El tutorial de GitHub Actions tiene una tubería de copiar y pegar para empezar.
Preguntas frecuentes
¿Es gratuita la CLI de Apidog? Sí. El paquete se instala de forma gratuita desde npm, y el nivel gratuito de Apidog cubre la construcción de escenarios y su ejecución a través de la CLI. Los planes de pago añaden características a escala de equipo, no acceso básico a la CLI.
¿Sustituye a curl o HTTPie? No, y no intenta hacerlo. Esas herramientas envían solicitudes ad-hoc; la CLI de Apidog ejecuta escenarios de prueba guardados y gestiona los recursos del proyecto. La mayoría de las terminales terminan usando ambas.
¿Puede ejecutarse completamente sin interfaz gráfica en CI? Sí. Autentícate con --access-token desde un secreto de CI, ejecuta apidog run con el ID de tu escenario y condiciona la construcción al código de salida. No se necesita una aplicación de escritorio en el runner.
¿Qué formatos puede importar y exportar? OpenAPI 3.x, Swagger 2.0 y colecciones de Postman, en ambas direcciones. Esto cubre las migraciones de entrada y las integraciones de salida.
¿Cómo utilizan los agentes de IA la CLI de forma segura? A través del ritual de esquema-validación-escritura y las puertas de permiso: cli-schema validate detecta cargas útiles mal formadas antes de que lleguen, y las ramas de IA mantienen las ediciones del agente aisladas hasta que un humano las fusiona. Véalo funcionando dentro de un agente en cómo usar la CLI de Apidog en Claude Code.
La terminal es donde tus pruebas ya se ejecutan y donde tus agentes ya trabajan. Poner el cliente API allí también elimina el último cambio de contexto. Descarga Apidog, instala la CLI desde npm y ejecuta un escenario de principio a fin; la página de la CLI de Apidog tiene la referencia completa de comandos cuando estés listo para ir más allá de run.