REDVEIL/Docs
CLI

Scans

Start, schedule, pause, resume, and cancel penetration test scans.

The scan command group (alias: scans) controls the scan lifecycle.

scan status

Show the current scan status and ops estimate for a project.

pentest-agent scan status <projectId>

Returns the project record and an ops cost estimate.

scan start

Start a scan immediately.

pentest-agent scan start <projectId>

scan schedule

Schedule a scan to run at a future time.

pentest-agent scan schedule <projectId> --at 2026-03-15T02:00:00Z

Options

OptionRequiredDescription
--at <timestamp>YesWhen to start. Accepts Unix epoch milliseconds or an ISO-8601 string.

scan cancel-scheduled

Cancel a previously scheduled scan (before it starts).

pentest-agent scan cancel-scheduled <projectId>

scan pause

Pause a running scan. It can be resumed later.

pentest-agent scan pause <projectId>

scan resume

Resume a paused scan.

pentest-agent scan resume <projectId>

scan cancel

Cancel an active or paused scan.

pentest-agent scan cancel <projectId>

On this page