CLI reference
ironcall run
Run a collection and execute all requests in order.
ironcall run <PATH> [OPTIONS]
PATH is the path to a YAML collection file, a single request file, or a folder exported by the desktop app.
Options
| Option | Default | Description |
|---|---|---|
--env <FILE> |
none | Load environment variables from a YAML or JSON file |
--reporter <FORMAT> |
pretty |
Output format: pretty, json, or tap |
--no-fail-fast |
off | Continue running after a request error or test failure |
--include-body |
off | json reporter only: keep response bodies (stripped by default) |
--include-secrets |
off | json reporter only: keep sensitive headers (redacted by default) |
--no-color |
off | Disable ANSI colours. Also honoured via the NO_COLOR environment variable |
The json reporter strips response bodies and redacts the Authorization, Cookie, Set-Cookie, and Proxy-Authorization headers by default, so its output is safe to attach to a CI artifact. Use --include-body and --include-secrets only when you need the full payload.
Exit codes
| Code | Meaning |
|---|---|
0 |
All requests succeeded and all tests passed |
1 |
At least one request errored or one test assertion failed |
2 |
No requests were found at the given path (likely a wrong path or empty collection) |
Examples
# Run with a specific environment
ironcall run ./api.yaml --env ./envs/staging.yaml
# Output TAP for CI
ironcall run ./api.yaml --reporter tap > results.tap
# Run all requests even if some fail, output JSON with bodies
ironcall run ./api.yaml --no-fail-fast --reporter json --include-body | jq '.[] | select(.error)'