newman 4.4.0

Newman is a command-line collection runner for Postman that lets you effortlessly run and test a Postman collection straight from the command-line interface. It is designed with extensibility at its core, so it can be seamlessly integrated with your continuous integration servers and build systems.

Using Newman is relatively straightforward. To start, ensure that you have Node.js of version 16 or higher installed on your system. Newman can be installed using npm, using the command npm install -g newman. This globally installs Newman, allowing usage from anywhere. For a local installation, skip the -g flag. Moreover, Newman can be installed globally using Homebrew, via brew install newman.

To use Newman, run a command like newman run examples/sample-collection.json to specify a collection to be run. This can be a local or remote resource (like a URL from Postman's Cloud API service).

To use Newman as a library in your JavaScript projects, simply require Newman in your project:

const newman = require('newman');
newman.run({
    collection: require('./sample-collection.json'),
    reporters: 'cli'
}, function (err) {
	if (err) { throw err; }
    console.log('collection run complete!');
});

This will execute your Postman collection and log 'collection run complete!' once finished.

Both Newman's CLI and programmatic capabilities are comprehensive, and include various configurations for reporters (like cli, json, junit), timeouts, delays, bailling, and more. You can find further information and usage examples on Newman's GitHub page.

The comprehensive Newman documentation can be found on its GitHub page at git://github.com/postmanlabs/newman.git. The readme provides an extensive understanding of the library's capabilities, including a Getting Started guide, a usage guide with code examples for both CLI usage and using Newman as a library, command-line options, API references, information on reporters, and more. The documentation is well structured with a detailed table of contents that can guide you through the different sections of the readme.