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.txtTarget 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.jsonNewline-delimited file example (domains.txt):
acme.com
api.acme.com
staging.acme.comStructured 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.jsonCLI 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 falseReference Values
Project Types
| Value | Description |
|---|---|
internal_network | Internal network penetration test. |
external_network | External network / perimeter test. |
cloud | Cloud configuration review (AWS, GCP, Azure). |
webapp | Web 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
| Value | Description |
|---|---|
executive_pdf | Executive summary PDF. |
technical_pdf | Technical detail PDF. |
full_pdf | Combined executive and technical PDF. |
attestation_pdf | Attestation letter PDF. |
letter_of_engagement_pdf | Letter of engagement PDF. |
testing_certificate | Public testing certificate (verifiable). |
issues_csv | Findings export as CSV. |
Webapp Auth Types
none, basic, bearer, header, form, session
Cloud Providers
aws, gcp, azure
Port Scan Modes
fast, full