REDVEIL/Docs
CLI

Reference

Input conventions, reference values, and enumerations for the pentest-agent CLI.

Input Conventions

Several options across the CLI accept flexible input formats.

File References (@path)

Prefix a value with @ to read it from a file:

--aws-secret-access-key @/secrets/aws.txt
--input @payload.json
--targets @targets.txt

Target Lists

Targets can be provided in multiple equivalent ways:

# Repeatable flag
--target acme.com --target api.acme.com
# Comma-separated
--targets "acme.com,api.acme.com"
# JSON array
--targets '["acme.com","api.acme.com"]'
# From a file (newline-delimited)
--targets-file domains.txt
# From a file (JSON array)
--targets @domains.json

Newline-delimited file example (domains.txt):

acme.com
api.acme.com
staging.acme.com

Structured Input (--input)

The --input option on project edit and finding edit accepts either inline JSON or a file reference:

# Inline JSON
--input '{"name": "Updated Name", "status": "archived"}'
# From file
--input @update-payload.json

CLI flags override any conflicting fields from --input.

Timestamps

Commands that accept timestamps (like scan schedule --at) accept:

  • Unix epoch milliseconds: 1741824000000
  • ISO-8601 strings: 2026-03-10T12:00:00Z

Boolean Values

Boolean options must be the literal strings "true" or "false":

--include-subdomains true
--credentials-provided false

Reference Values

Project Types

ValueDescription
internal_networkInternal network penetration test.
external_networkExternal network / perimeter test.
cloudCloud configuration review (AWS, GCP, Azure).
webappWeb application DAST.

Project Statuses

active, archived

Scan Statuses

not_started, scheduled, running, pausing, cancelling, paused, completed, failed, cancelled

Finding Statuses

open, remediated, false positive

Report Types

ValueDescription
executive_pdfExecutive summary PDF.
technical_pdfTechnical detail PDF.
full_pdfCombined executive and technical PDF.
attestation_pdfAttestation letter PDF.
letter_of_engagement_pdfLetter of engagement PDF.
testing_certificatePublic testing certificate (verifiable).
issues_csvFindings export as CSV.

Webapp Auth Types

none, basic, bearer, header, form, session

Cloud Providers

aws, gcp, azure

Port Scan Modes

fast, full

On this page