Run and test collections from the command line using Newman CLI

Newman is a command-line Collection Runner for Postman. It enables you to run and test a Postman Collection directly from the command line. It's built with extensibility in mind so that you can integrate it with your continuous integration (CI) servers and build systems.

Newman maintains feature parity with Postman and allows you to run collections the way they're executed inside the collection runner in Postman.

Newman resides in the npm registry and on GitHub.

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

Running Newman

Contents

Getting started

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

Options

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

File uploads

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.

Reporters

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

Last modified: 2023/09/26