Command-line runner

codestamp-cli runs the HTTP and GraphQL requests of a collection in notebook order, with their scripts and tests, like Run all. It uses an in-memory database for the run, with a temporary random encryption key, so it never reads or changes the app’s data.

The Windows installer and the Linux .deb both install it. See Install. On Linux it goes to /usr/bin next to codestamp-desktop.

Run a collection

codestamp-cli run ./collection-folder --environment staging.postman_environment.json --var API_TOKEN --junit report.xml

The collection can be a Collaboration folder, a Codestamp or Postman v2.1 collection file, or an OpenAPI 3 or Swagger 2 file.

Flags

Flag	What it does
<collection>	The Collaboration repository folder, or a collection file (Codestamp or Postman Collection v2.1, OpenAPI 3, Swagger 2)
-e, --environment <file>	An environment file exported from Codestamp or Postman
--var <name>=<value>	Sets an environment variable
--var <name>	Takes the value from the process environment, so CI secrets stay off the command line
-d, --data <file>	A CSV or JSON file, one iteration per row
-n, --iterations <1-100>	The number of iterations
--bail	Stops after the first failed request
--delay <ms>	A pause between requests
--timeout <seconds>	A timeout from 1 to 300 seconds
--junit <file>	Writes a JUnit XML report for CI
--json <file>	Writes a JSON report in the same shape as Export report in the app

Exit codes

Code	Meaning
0	Everything passed
1	Something failed
2	The run could not start, or a report could not be written

Colour appears only in a terminal, and NO_COLOR turns it off.

What the CLI skips

• WebSocket, MCP and gRPC requests are skipped with a note.
• Orchestration flows cannot run through the CLI yet.
• The CLI cannot open restricted values yet.