Collection runner
Running from the UI
Right-click a collection or folder in the sidebar and select Run. The runner executes requests in order, propagating environment variable mutations and the cookie jar between them. Test results and response details are displayed per-request after the run completes.
Requests run sequentially, not in parallel.
By default the run is fail-fast: it stops at the first request error or failing test. The CLI can override this with --no-fail-fast.
CLI
Run a collection from the terminal using ironcall run. The path is a YAML collection file or a folder exported by the desktop app.
ironcall run ./my-collection.yaml
ironcall run ./my-collection.yaml --env ./production.yaml
ironcall run ./my-collection.yaml --reporter json
ironcall run ./my-collection.yaml --no-fail-fast --reporter tap
Reporters
Three output formats are available via --reporter:
| Reporter | Description |
|---|---|
pretty |
Human-readable output with colour and test results per request (default) |
json |
Machine-readable JSON, one object per request |
tap |
TAP version 14, compatible with most CI test reporting tools |
The json reporter is built for safe sharing. By default it strips response bodies and redacts sensitive headers (Authorization, Cookie, Set-Cookie, Proxy-Authorization). Add --include-body to keep response bodies and --include-secrets to keep the redacted headers. See the CLI reference for all flags.
CI/CD
The CLI exits 0 when every request succeeds and every test passes, 1 when a request errors or a test fails, and 2 when no requests are found at the given path. Use --no-fail-fast to continue running after failures; all results are still collected and reported.
# GitHub Actions
- name: Run API tests
run: ironcall run ./tests/api.yaml --env ./tests/ci.yaml --reporter tap
Environment variables can be passed via --env pointing to a YAML file, or injected into the process environment and referenced with {{VAR}} in your collection.