Справочник CLI
Сервер Ogma на Rust может работать как локальный прокси, встроенный процесс MCP или команда пентеста без интерфейса.
Пользователи десктопных пакетов обычно запускают Ogma из приложения. CLI полезен для разработки, автоматизации и локального тестирования в серверном режиме.
Серверный режим
bash
ogma \
--listen 127.0.0.1:8080 \
--api-port 127.0.0.1:8181 \
--data-dir ./ogma-dataОсновные флаги
| Флаг | По умолчанию | Назначение |
|---|---|---|
--listen | 127.0.0.1:8080 | Адрес слушателя прокси. |
--api-port | 127.0.0.1:8181 | Адрес REST API и сервера интерфейса. |
--data-dir | ./ogma-data | База проекта, сертификаты, плагины, экспорт и локальное состояние. |
--max-plugin-size | 52428800 | Максимальный размер пакета плагина в байтах. |
--intercept-queue-cap | 1000 | Максимум элементов очереди перед передачей нового трафика. |
--ui-dir | не задан | Каталог собранного интерфейса для обслуживания сервером API. |
Флаги OAST
| Флаг | По умолчанию | Назначение |
|---|---|---|
--oast-http-port | 8888 | Слушатель HTTP. 0 отключает. |
--oast-https-port | 8443 | Слушатель HTTPS. 0 отключает. |
--oast-dns-port | 5353 | Слушатель DNS. 0 отключает. |
--oast-smtp-port | 2525 | Слушатель SMTP. 0 отключает. |
--oast-domain | oast.local | Домен создаваемых имён обратных обращений. |
--oast-public-ip | не задан | Публичный IP в ответах A-записей OAST DNS. |
Пентест без интерфейса
Подкоманда pentest выполняет обнаружение, пассивный анализ, необязательное активное сканирование и выводит отчёт Markdown.
bash
ogma pentest https://example.com \
--depth 3 \
--concurrency 10 \
--min-severity medium \
--output report.mdФлаги пентеста
| Флаг | По умолчанию | Назначение |
|---|---|---|
--depth | 3 | Глубина обнаружения. 0 без ограничений. |
--concurrency | 10 | Максимум одновременных запросов. |
--no-active | отключён | Отключить активное сканирование; только обнаружение и пассивный анализ. |
--min-severity | medium | Минимальная критичность для кода выхода 1. Значения: info, low, medium, high, critical. |
--output | stdout | Записать отчёт в файл вместо stdout. |
Коды выхода:
| Код | Значение |
|---|---|
0 | Завершено, ни один результат не достиг порога критичности. |
1 | Завершено, хотя бы один результат достиг порога. |
2 | Ошибка выполнения или настройки. |
Режим MCP
MCP запускается из настроек Ogma или отдельным бинарным файлом ogma-mcp. Скрытые флаги сервера также поддерживают встроенный режим MCP при запуске внутреннего процесса Ogma.
Для обычной настройки используйте Настройка MCP.
Флаги отдельного ogma-mcp
bash
ogma-mcp \
--api-url http://127.0.0.1:8181 \
--body-preview-bytes 2048| Флаг | Переменная окружения | По умолчанию | Назначение |
|---|---|---|---|
--api-url | OGMA_API_URL | http://127.0.0.1:8181 | URL API работающего сервера Ogma. |
--body-preview-bytes | не задана | 512 | Максимум байтов предпросмотра тела инструментами чтения. |
--allow-write-findings | OGMA_MCP_ALLOW_WRITE_FINDINGS | отключён | Создание, обновление, теги и привязка доказательств результатов. |
--allow-export-data | OGMA_MCP_ALLOW_EXPORT_DATA | отключён | Создание заданий экспорта. |
--allow-read-secrets | OGMA_MCP_ALLOW_READ_SECRETS | отключён | Открытые значения переменных. |
--allow-send-requests | OGMA_MCP_ALLOW_SEND_REQUESTS | отключён | Отправка трафика, браузер, обход, пробы, тестирование аутентификации и соединения WebSocket. |
--allow-run-workflows | OGMA_MCP_ALLOW_RUN_WORKFLOWS | отключён | Предпросмотр, запуск и отмена рабочих процессов. |
--allow-intercept-control | OGMA_MCP_ALLOW_INTERCEPT_CONTROL | отключён | Управление очередью, передача, отбрасывание и изменение. |
--tool-profile | OGMA_MCP_TOOL_PROFILE | full | Устаревший флаг совместимости. Всегда объявляются все инструменты, даже при core или discovery в старой команде. --mcp-tool-profile — псевдоним. |
MCP пишет протокольные сообщения в stdout, поэтому журналы выполнения идут в stderr.
Логические переменные разрешений принимают true для включения. Нет поминутных или посессионных квот; пределы отдельных инструментов сохраняются. Удалённые флаги квот не принимаются. Флаги stdio настраивают процесс независимо от встроенного MCP.
Сборки разработки
Скрипты локальной сборки доступны в корне репозитория:
bash
./build-local.sh
./build-desktop-local.shИспользуйте десктопную сборку для проверки упакованного Electron. Сборку сервера и интерфейса — для проверки API и веб-интерфейса.