Referencia de la CLI

El backend de Ogma en Rust puede ejecutarse como servidor proxy local, proceso MCP integrado o comando de pruebas de penetración sin interfaz gráfica.

Los usuarios de la versión de escritorio empaquetada suelen iniciar Ogma desde la aplicación. La CLI resulta útil para el desarrollo, la automatización y las pruebas locales en modo servidor.

Modo servidor

ogma \
  --listen 127.0.0.1:8080 \
  --api-port 127.0.0.1:8181 \
  --data-dir ./ogma-data

Opciones habituales

Opción	Valor predeterminado	Función
--listen	127.0.0.1:8080	Dirección de escucha del proxy.
--api-port	127.0.0.1:8181	Dirección del servidor de la API REST y del frontend.
--data-dir	./ogma-data	Base de datos del proyecto, certificados, plugins, exportaciones y estado local.
--max-plugin-size	52428800	Tamaño máximo del paquete de plugin en bytes.
--intercept-queue-cap	1000	Número máximo de elementos en la cola de interceptación antes de reenviar el tráfico nuevo.
--ui-dir	sin definir	Directorio con los archivos compilados del frontend que se sirven desde el servidor de la API.

Opciones de OAST

Opción	Valor predeterminado	Función
--oast-http-port	8888	Servicio de escucha de callbacks HTTP. Usa 0 para desactivarlo.
--oast-https-port	8443	Servicio de escucha de callbacks HTTPS. Usa 0 para desactivarlo.
--oast-dns-port	5353	Servicio de escucha de callbacks DNS. Usa 0 para desactivarlo.
--oast-smtp-port	2525	Servicio de escucha de callbacks SMTP. Usa 0 para desactivarlo.
--oast-domain	oast.local	Dominio utilizado para los nombres de host generados para callbacks.
--oast-public-ip	sin definir	IP pública devuelta por las respuestas de registros A del DNS de OAST.

Modo de pruebas de penetración sin interfaz gráfica

El subcomando pentest realiza descubrimiento, análisis pasivo y, opcionalmente, escaneo activo, y genera un informe Markdown.

ogma pentest https://example.com \
  --depth 3 \
  --concurrency 10 \
  --min-severity medium \
  --output report.md

Opciones de pruebas de penetración

Opción	Valor predeterminado	Función
--depth	3	Profundidad de descubrimiento. 0 significa sin límite.
--concurrency	10	Número máximo de solicitudes simultáneas.
--no-active	desactivado	Desactiva el escaneo activo; ejecuta únicamente descubrimiento y análisis pasivo.
--min-severity	medium	Severidad mínima que devuelve el código de salida 1. Valores válidos: info, low, medium, high, critical.
--output	stdout	Escribe el informe en un archivo en lugar de stdout.

Códigos de salida:

Código	Significado
0	Finalizó y ningún hallazgo alcanzó el umbral de severidad.
1	Finalizó y al menos un hallazgo alcanzó el umbral de severidad.
2	Error de ejecución o configuración.

Modo MCP

MCP se puede iniciar desde la configuración de Ogma o mediante el binario independiente ogma-mcp. Las opciones ocultas del backend también permiten el modo MCP integrado cuando Ogma inicia un proceso MCP interno.

Para la configuración habitual, consulta Configuración de MCP.

Opciones de ogma-mcp independiente

ogma-mcp \
  --api-url http://127.0.0.1:8181 \
  --body-preview-bytes 2048

Opción	Variable de entorno	Valor predeterminado	Función
--api-url	OGMA_API_URL	http://127.0.0.1:8181	URL de la API del backend de Ogma en ejecución.
--body-preview-bytes	sin definir	512	Número máximo de bytes de vista previa del cuerpo devueltos por las herramientas de lectura.
--allow-write-findings	OGMA_MCP_ALLOW_WRITE_FINDINGS	desactivado	Habilita la creación y actualización de hallazgos, las etiquetas y la vinculación de evidencias.
--allow-export-data	OGMA_MCP_ALLOW_EXPORT_DATA	desactivado	Habilita la creación de tareas de exportación.
--allow-read-secrets	OGMA_MCP_ALLOW_READ_SECRETS	desactivado	Devuelve los valores de las variables de entorno sin enmascarar.
--allow-send-requests	OGMA_MCP_ALLOW_SEND_REQUESTS	desactivado	Habilita herramientas que envían tráfico, controlan el navegador, rastrean, sondean, prueban la autenticación o se conectan a WebSockets.
--allow-run-workflows	OGMA_MCP_ALLOW_RUN_WORKFLOWS	desactivado	Habilita las herramientas de vista previa, ejecución y cancelación de flujos de trabajo.
--allow-intercept-control	OGMA_MCP_ALLOW_INTERCEPT_CONTROL	desactivado	Habilita el control de la cola de interceptación, el reenvío, el descarte y la modificación.
--tool-profile	OGMA_MCP_TOOL_PROFILE	full	Opción de compatibilidad heredada. Todas las herramientas se anuncian siempre, incluso cuando un comando antiguo pasa core o discovery. --mcp-tool-profile es un alias.

MCP escribe los mensajes del protocolo en stdout, por lo que los registros de ejecución se envían a stderr.

Las variables de entorno booleanas de permisos aceptan true para habilitar la capacidad. El servidor no tiene cuotas de actividad por minuto ni por sesión; siguen aplicándose los límites individuales de cada herramienta. No se aceptan las opciones de cuotas eliminadas. Las opciones de stdio configuran ese proceso independientemente de la configuración del MCP integrado.

Compilaciones de desarrollo

Los scripts de compilación local están disponibles en la raíz del repositorio:

./build-local.sh
./build-desktop-local.sh

Utiliza la compilación de escritorio para probar la experiencia empaquetada de Electron. Utiliza la compilación de backend/frontend para probar el comportamiento de la API y la interfaz web.