Newmannium

What is Newmaninum

Newmannium is a simple wrapper around Postman's newman and the Postman APIs

Newmannium is also the name of Newman's Millenium party (of which Jerry was not invited)

Why Newmannium

While Postman's cloud-based Workspaces making collaborating on collections easy, there is not any way to remotely execute a Postman collection easily (for example in a CI pipeline). Newmannium gives the ability to pull collections from a shared Postman Workspace, and execute it via the newman command line runner

Docs

• Installation
• Commands
• Usage

Installation

$ npm install -g newmannium
$ newmannium COMMAND
running command...
$ newmannium (--version)
newmannium/0.0.10 darwin-arm64 node-v16.15.0
$ newmannium --help [COMMAND]
USAGE
  $ newmannium COMMAND
...

Commands

• newmannium collections
• newmannium run

newmannium collections

List all collections user has access to

USAGE
  $ newmannium collections [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  List all collections user has access to

EXAMPLES
  $ oex newmannium collections

See code: dist/commands/collections.ts

newmannium run

Execute postman cloud collection via newman

USAGE
  $ newmannium run -c <value> [-h] [-e <value>]

FLAGS
  -c, --collection=<value>   (required) name of collection in postman cloud to run
  -e, --environment=<value>  name of environment to use with collection
  -h, --help                 Show CLI help.

DESCRIPTION
  Execute postman cloud collection via newman

EXAMPLES
  $ oex newmannium run -c test.postman_collection.json

See code: dist/commands/run.ts

• newmannium run
• newmannium collections

Usage

In order for Newmannium to access your Postman API Collections, Newmannium expects an environment named POSTMAN_API_KEY to be available in the shell. You can generate a Postman API Key from their site here: Generate Token

newmannium run

Execute Postman Cloud Workspace Collection via newman

USAGE
  $ newmannium run -c <name_of_collection>

FLAGS
  -c, --collection=<value>  (required) name of collection in postman cloud to run
  -h, --help                Show CLI help.

DESCRIPTION
  Execute postman cloud collection via newman

EXAMPLES
  $ newmannium run -c test.postman_collection.json

If the collection does not exist, or the user token does not have access to the collection, an error is returned

newmannium collections

List all Postman Workspace Collections user has access to

USAGE
  $ newmannium collections [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  List all collections user has access to

EXAMPLES
  $ newmannium collections