About Newman
Newman is Postman's command line collection runner. It runs API collections from a terminal or a continuous integration pipeline, and it is an open source tool.
What it does
You export a Postman collection as a JSON file, optionally with an environment file, and run it with newman run. By default Newman exits with status 0 when a run completes without errors. The bail option stops the run and exits with status 1 when a test fails, so the CI tool can fail the build. An official Docker image is available for running in a container.
Key features
- Runs Postman v2.1 collections from the terminal
- Environment files for variables
- Bail option to fail a CI build on errors
- Official Docker image for container runs
Who it's for
API developers and QA teams with existing Postman collections who need command line or CI runs.
Pricing and good to know
Newman is Apache-2.0 licensed and free to use, and it needs Node.js 16 or later. It does not support OAuth 2.0 authentication or scripts from a team's Package Library. The site points to the newer Postman CLI, which supports the v3 collection format and most of Newman's options.
Highlights
- Run Postman collections from the terminal
- Use environment files for variables
- Fail a CI build when a test fails
- Run in a container with the Docker image
