Referensi CLI

Backend Rust Ogma dapat berjalan sebagai server proksi lokal, proses MCP tertanam, atau perintah pengujian penetrasi headless.

Pengguna desktop dengan paket instalasi biasanya memulai Ogma dari aplikasi. Penggunaan CLI berguna untuk pengembangan, otomatisasi, dan pengujian lokal bergaya server.

Mode Server

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

Flag Umum

Flag	Default	Tujuan
--listen	127.0.0.1:8080	Alamat listener proksi.
--api-port	127.0.0.1:8181	Alamat API REST dan server frontend.
--data-dir	./ogma-data	Basis data proyek, sertifikat, plugin, ekspor, dan status lokal.
--max-plugin-size	52428800	Ukuran paket plugin maksimum dalam byte.
--intercept-queue-cap	1000	Jumlah maksimum item intersepsi yang mengantre sebelum lalu lintas baru diteruskan.
--ui-dir	tidak ditetapkan	Direktori berisi file frontend hasil build yang akan disajikan dari server API.

Flag OAST

Flag	Default	Tujuan
--oast-http-port	8888	Listener callback HTTP. Gunakan 0 untuk menonaktifkan.
--oast-https-port	8443	Listener callback HTTPS. Gunakan 0 untuk menonaktifkan.
--oast-dns-port	5353	Listener callback DNS. Gunakan 0 untuk menonaktifkan.
--oast-smtp-port	2525	Listener callback SMTP. Gunakan 0 untuk menonaktifkan.
--oast-domain	oast.local	Domain yang digunakan untuk nama host callback yang dihasilkan.
--oast-public-ip	tidak ditetapkan	IP publik yang dikembalikan oleh respons record A DNS OAST.

Mode Pengujian Penetrasi Headless

Subperintah pentest menjalankan penemuan konten, analisis pasif, pemindaian aktif opsional, dan menghasilkan laporan Markdown.

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

Flag Pengujian Penetrasi

Flag	Default	Tujuan
--depth	3	Kedalaman penemuan. 0 berarti tanpa batas.
--concurrency	10	Jumlah maksimum permintaan serentak.
--no-active	nonaktif	Menonaktifkan pemindaian aktif; hanya menjalankan penemuan dan analisis pasif.
--min-severity	medium	Tingkat keparahan minimum yang mengembalikan kode keluar 1. Nilai valid: info, low, medium, high, critical.
--output	stdout	Menulis laporan ke file, bukan stdout.

Kode keluar:

Kode	Makna
0	Selesai dan tidak ada temuan yang memenuhi ambang tingkat keparahan.
1	Selesai dan sedikitnya satu temuan memenuhi ambang tingkat keparahan.
2	Kesalahan runtime atau konfigurasi.

Mode MCP

MCP dapat dimulai dari pengaturan Ogma atau melalui biner ogma-mcp mandiri. Flag backend tersembunyi juga mendukung mode MCP tertanam ketika Ogma menjalankan proses MCP internal.

Untuk pengaturan biasa, gunakan Pengaturan MCP.

Flag ogma-mcp Mandiri

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

Flag	Variabel lingkungan	Default	Tujuan
--api-url	OGMA_API_URL	http://127.0.0.1:8181	URL API backend Ogma yang berjalan.
--body-preview-bytes	tidak ditetapkan	512	Jumlah byte pratinjau isi maksimum yang dikembalikan alat baca.
--allow-write-findings	OGMA_MCP_ALLOW_WRITE_FINDINGS	nonaktif	Mengaktifkan pembuatan, pembaruan, pemberian tag, dan penautan bukti temuan.
--allow-export-data	OGMA_MCP_ALLOW_EXPORT_DATA	nonaktif	Mengaktifkan pembuatan tugas ekspor.
--allow-read-secrets	OGMA_MCP_ALLOW_READ_SECRETS	nonaktif	Mengembalikan nilai variabel lingkungan yang tidak disamarkan.
--allow-send-requests	OGMA_MCP_ALLOW_SEND_REQUESTS	nonaktif	Mengaktifkan alat yang mengirim lalu lintas, mengendalikan peramban, melakukan crawling, melakukan probe, menguji autentikasi, atau terhubung ke WebSocket.
--allow-run-workflows	OGMA_MCP_ALLOW_RUN_WORKFLOWS	nonaktif	Mengaktifkan alat pratinjau, eksekusi, dan pembatalan alur kerja.
--allow-intercept-control	OGMA_MCP_ALLOW_INTERCEPT_CONTROL	nonaktif	Mengaktifkan kontrol antrean intersepsi, penerusan, pembuangan, dan modifikasi.
--tool-profile	OGMA_MCP_TOOL_PROFILE	full	Flag kompatibilitas lama. Semua alat selalu diiklankan, termasuk ketika perintah lama memberikan core atau discovery. --mcp-tool-profile adalah alias.

MCP menulis pesan protokol ke stdout, sehingga pencatatan runtime diarahkan ke stderr.

Variabel lingkungan izin boolean menerima true untuk mengaktifkan kapabilitas. Server tidak memiliki kuota aktivitas per menit/per sesi; batas masing-masing alat tetap berlaku. Flag kuota yang telah dihapus tidak diterima. Flag stdio mengonfigurasi proses tersebut secara independen dari pengaturan MCP tertanam.

Build Pengembangan

Skrip build lokal tersedia di root repositori:

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

Gunakan build desktop saat menguji pengalaman Electron yang dipaketkan. Gunakan build backend/frontend saat menguji perilaku API dan UI web.