Tài liệu tham khảo CLI

Backend Rust của Ogma có thể chạy dưới dạng máy chủ proxy cục bộ, tiến trình MCP nhúng hoặc lệnh kiểm thử xâm nhập không có giao diện đồ họa.

Người dùng bản ứng dụng máy tính đã đóng gói thường khởi động Ogma từ ứng dụng. CLI hữu ích cho phát triển, tự động hóa và kiểm thử cục bộ theo kiểu máy chủ.

Chế độ máy chủ

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

Tùy chọn thường dùng

Tùy chọn	Mặc định	Mục đích
--listen	127.0.0.1:8080	Địa chỉ lắng nghe của proxy.
--api-port	127.0.0.1:8181	Địa chỉ máy chủ API REST và frontend.
--data-dir	./ogma-data	Cơ sở dữ liệu dự án, chứng chỉ, plugin, bản xuất và trạng thái cục bộ.
--max-plugin-size	52428800	Kích thước tối đa của gói plugin tính bằng byte.
--intercept-queue-cap	1000	Số mục tối đa trong hàng đợi chặn bắt trước khi lưu lượng mới được chuyển tiếp.
--ui-dir	chưa đặt	Thư mục chứa các tệp frontend đã biên dịch để máy chủ API phục vụ.

Tùy chọn OAST

Tùy chọn	Mặc định	Mục đích
--oast-http-port	8888	Dịch vụ lắng nghe callback HTTP. Dùng 0 để tắt.
--oast-https-port	8443	Dịch vụ lắng nghe callback HTTPS. Dùng 0 để tắt.
--oast-dns-port	5353	Dịch vụ lắng nghe callback DNS. Dùng 0 để tắt.
--oast-smtp-port	2525	Dịch vụ lắng nghe callback SMTP. Dùng 0 để tắt.
--oast-domain	oast.local	Tên miền dùng cho các tên máy chủ callback được tạo.
--oast-public-ip	chưa đặt	IP công khai được trả về trong phản hồi bản ghi A của DNS OAST.

Chế độ kiểm thử xâm nhập không có giao diện đồ họa

Lệnh con pentest chạy khám phá nội dung, phân tích thụ động và quét chủ động tùy chọn, sau đó tạo báo cáo Markdown.

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

Tùy chọn kiểm thử xâm nhập

Tùy chọn	Mặc định	Mục đích
--depth	3	Độ sâu khám phá nội dung. 0 nghĩa là không giới hạn.
--concurrency	10	Số yêu cầu đồng thời tối đa.
--no-active	tắt	Tắt quét chủ động; chỉ chạy khám phá nội dung và phân tích thụ động.
--min-severity	medium	Mức độ nghiêm trọng tối thiểu khiến chương trình trả về mã thoát 1. Giá trị hợp lệ: info, low, medium, high, critical.
--output	stdout	Ghi báo cáo vào tệp thay vì stdout.

Mã thoát:

Mã	Ý nghĩa
0	Hoàn tất và không có phát hiện nào đạt ngưỡng mức độ nghiêm trọng.
1	Hoàn tất và có ít nhất một phát hiện đạt ngưỡng mức độ nghiêm trọng.
2	Lỗi khi chạy hoặc lỗi cấu hình.

Chế độ MCP

Có thể khởi động MCP từ cài đặt Ogma hoặc qua tệp nhị phân độc lập ogma-mcp. Các tùy chọn backend ẩn cũng hỗ trợ chế độ MCP nhúng khi Ogma khởi chạy tiến trình MCP nội bộ.

Để thiết lập thông thường, xem Thiết lập MCP.

Tùy chọn của ogma-mcp độc lập

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

Tùy chọn	Biến môi trường	Mặc định	Mục đích
--api-url	OGMA_API_URL	http://127.0.0.1:8181	URL API của backend Ogma đang chạy.
--body-preview-bytes	chưa đặt	512	Số byte xem trước nội dung tối đa được các công cụ đọc trả về.
--allow-write-findings	OGMA_MCP_ALLOW_WRITE_FINDINGS	tắt	Bật tạo và cập nhật phát hiện, gắn thẻ và liên kết bằng chứng.
--allow-export-data	OGMA_MCP_ALLOW_EXPORT_DATA	tắt	Bật tạo tác vụ xuất dữ liệu.
--allow-read-secrets	OGMA_MCP_ALLOW_READ_SECRETS	tắt	Trả về giá trị biến môi trường không được che.
--allow-send-requests	OGMA_MCP_ALLOW_SEND_REQUESTS	tắt	Bật các công cụ gửi lưu lượng, điều khiển trình duyệt, thu thập dữ liệu, thăm dò, kiểm thử xác thực hoặc kết nối WebSocket.
--allow-run-workflows	OGMA_MCP_ALLOW_RUN_WORKFLOWS	tắt	Bật công cụ xem trước, chạy và hủy quy trình.
--allow-intercept-control	OGMA_MCP_ALLOW_INTERCEPT_CONTROL	tắt	Bật điều khiển hàng đợi chặn bắt, chuyển tiếp, loại bỏ và sửa đổi.
--tool-profile	OGMA_MCP_TOOL_PROFILE	full	Tùy chọn tương thích với phiên bản cũ. Tất cả công cụ luôn được công bố, kể cả khi lệnh cũ truyền core hoặc discovery. --mcp-tool-profile là bí danh.

MCP ghi thông điệp giao thức vào stdout, vì vậy nhật ký khi chạy được gửi đến stderr.

Biến môi trường quyền kiểu boolean chấp nhận true để bật khả năng tương ứng. Máy chủ không có hạn ngạch hoạt động theo phút hoặc theo phiên; giới hạn của từng công cụ vẫn được áp dụng. Các tùy chọn hạn ngạch đã bị loại bỏ không được chấp nhận. Tùy chọn stdio cấu hình tiến trình đó độc lập với cài đặt MCP nhúng.

Bản biên dịch phục vụ phát triển

Các tập lệnh biên dịch cục bộ có sẵn tại thư mục gốc của kho mã:

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

Dùng bản biên dịch ứng dụng máy tính khi kiểm thử trải nghiệm Electron đã đóng gói. Dùng bản biên dịch backend/frontend khi kiểm thử hoạt động của API và giao diện web.