Run and test collections from the command line using Newman CLI

Newman is a command-line tool for running Postman Collections. Use Newman to run and test collections from the command line instead of in the Postman app. Newman is built with extensibility in mind, so you can incorporate it in your continuous integration (CI) pipelines and build systems.

The topics in this section will help you get started with Newman. For complete usage information, see Newman in the npm registry or on GitHub.

You can also run collections from the command line with the Postman CLI. For more information on the differences between Newman and the Postman CLI, see Deciding which command-line companion to use.

Get started in Newman

To get started, install Node.js and Newman, then run your collections. Learn more about installing and running Newman.

You can also run Newman using Docker. Learn more about running Newman with Docker on macOS, Ubuntu, and Windows.

Newman options

Newman provides a rich set of options to customize a collection run. Learn more about Newman options.

Upload files in Newman

Newman supports file uploads, so you can use a data file (such as a text file) to fill in form data fields. Learn more about uploading files in Newman.

Newman reporters

Reporters can generate collection run reports for specific use cases, for example, logging the response body when a request (or its tests) fail. Learn more about using Newman built-in reporters and Newman external and custom reporters.

Newman and continuous integration (CI)

You can integrate Newman in your continuous integration (CI) environment. Run your collections and tests automatically after every code push. Learn more about using Newman with CI, using Newman with Travis CI, or using Newman with Jenkins.