CLI

Versión del documento: 20261024

Disponible en las aplicaciones de escritorio para macOS y Windows. iOS y Android no incluyen este comando. Abra ApiCatcher antes de usarlo.

La CLI permite que una IA llame a las funciones que ya tiene ApiCatcher, por ejemplo buscar y analizar peticiones HTTP, y gestionar scripts y reglas de reescritura.

Dónde está el comando

Ejecútelo en la terminal del sistema. En macOS es Terminal. En Windows es el símbolo del sistema o PowerShell.

En macOS el comando está dentro de la aplicación instalada:

/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli tools

Si ApiCatcher no está en la carpeta Aplicaciones, sustituya /Applications/ApiCatcher.app por la ubicación de su ApiCatcher.app.

Puede ponerle un nombre corto en la ventana de terminal actual y después escribir apicatcher:

alias apicatcher="/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli"

En Windows, abra la carpeta donde está instalado ApiCatcher y ejecute apicatcher-cli.exe. La ubicación habitual es:

%LOCALAPPDATA%\Programs\ApiCatcher\apicatcher-cli.exe tools

El icono de ApiCatcher en el escritorio abre la ventana. No es este comando.

Los ejemplos de abajo dicen apicatcher. Use la ruta completa de su equipo.

La aplicación tiene que estar abierta y con la CLI activada

La CLI está apagada por defecto y no ocupa un puerto. Para usar el comando:

1. Abra ApiCatcher.
2. Abra CLI en la barra lateral y active el interruptor.
3. Cierre la aplicación por completo y vuelva a abrirla. Ese arranque es el que acepta comandos en este equipo.

Al desactivar el interruptor, también se detiene en el siguiente arranque.

El comando falla si la aplicación está cerrada, si el interruptor está apagado o si no ha reiniciado después de cambiar el interruptor.

Comandos

Mostrar las herramientas y los parámetros de esta versión. Esa salida es el esquema válido.

apicatcher tools

Llamar a una herramienta. --args es un objeto JSON.

apicatcher call search_requests --args '{"host":"api.example.com","limit":10}'

También puede llegar por la entrada estándar:

printf '%s' '{"host":"api.example.com"}' | apicatcher call search_requests

Si no pasa --args y la entrada estándar es una terminal, los argumentos son {}.

apicatcher call get_capture_status

Salida

La salida estándar es un solo objeto JSON. ok indica si la llamada ha ido bien. Si el resultado de la herramienta es JSON, va dentro de result. Si no, result sigue siendo una cadena.

{"ok":false,"error":"ApiCatcher is not running"}

Campos habituales de search_requests: keyword, search_target (url, host, req_header, resp_header, req_body, resp_body), method, host, status_code, file_type, session_id, limit, skip.

Seguridad

• El comando solo funciona en este equipo. Otros dispositivos de la red no pueden llegar a él.
• La salida es tráfico capturado real y puede incluir cookies, tokens y cuerpos. No la publique.