CLI and exit codes

Use the CLI to validate and execute declarative HTTP/AMQP test suites. Its exit codes let local scripts and automated jobs distinguish a passing suite, failed expectations, and setup errors.

Global command

payloadstash [--version] COMMAND [ARGS]...

Command	Purpose
validate	Validate and resolve a configuration without sending requests
run	Validate, resolve, write artifacts, and execute sequences
hello	Installation smoke test

validate

payloadstash validate [--writeResolved] [--secrets FILE] CONFIG

• --writeResolved writes <config-stem>-resolved.yml beside CONFIG.
• --secrets FILE loads case-sensitive KEY=VALUE entries needed by operators.
• Success returns 0; invalid configuration or secret resolution returns 1.

run

payloadstash run --out DIRECTORY [--dry-run] [--yes] [--secrets FILE] CONFIG

• --out DIRECTORY is required and becomes the artifact root.
• --dry-run resolves and logs without making HTTP requests or AMQP publishes.
• --yes skips the confirmation prompt.
• --secrets FILE loads secret values; written resolved data and logs are redacted.

Run configuration/output setup failures return 9. Failed Expect assertions return 1; a successful run returns 0. Individual operation errors are recorded and execution continues, so add explicit expectations for statuses that must fail automation.

Note

There is no payloadstash resolve command. Use validate --writeResolved, or inspect the resolved file written by run.

Verify options for the installed version with payloadstash COMMAND --help.