# collections-runner

> Interactive CLI for postman collections on top of newman.

Latest version **1.0.23** (published 2020-05-20) · 0 weekly downloads

## Install

```sh
npm install collections-runner
pnpm add collections-runner
yarn add collections-runner
bun add collections-runner
```

Provides the commands `collections-runner`, `collections-automator`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.23 |
| Published | 2020-05-20 |
| First published | 2020-04-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 19.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Marion Valentin |
| Maintainers | marionvalentin |
| Keywords | newman, postman, collection, testing, collections-runner, ci, api |

## Links

- npm: https://www.npmjs.com/package/collections-runner
- Repository: https://github.com/marionnousvalentin/collections-runner
- Issues: https://github.com/marionnousvalentin/collections-runner/issues
- npm.io page: https://npm.io/package/collections-runner

## Dependencies (12)

- [meow](https://npm.io/package/meow.md) ^6.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [newman](https://npm.io/package/newman.md) ^5.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.1.0
- [typescript](https://npm.io/package/typescript.md) ^3.8.3
- [@types/node](https://npm.io/package/@types/node.md) ^13.13.2
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.150
- [@types/newman](https://npm.io/package/@types/newman.md) ^4.5.0
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^6.5.0
- [console-log-tree](https://npm.io/package/console-log-tree.md) ^1.2.1
- [postman-collection](https://npm.io/package/postman-collection.md) ^3.6.0
- [@types/postman-collection](https://npm.io/package/@types/postman-collection.md) ^3.5.3

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.23 (latest) — 2020-05-20
- 1.0.22 — 2020-05-15
- 1.0.21 — 2020-05-15
- 1.0.20 — 2020-05-13
- 1.0.19 — 2020-05-07
- 1.0.18 — 2020-05-06
- 1.0.17 — 2020-05-01
- 1.0.16 — 2020-05-01
- 1.0.15 — 2020-04-30
- 1.0.14 — 2020-04-28
- 1.0.13 — 2020-04-27
- 1.0.12 — 2020-04-26

## README

# Collections-runner

Interactive CLI for postman collections on top of newman.<br/>
Can be used to test APIs. <br/>
Can be used to develop APIs or applications using APIs.<br/>

![](DEMO.gif)

## Features

<a href="https://www.npmjs.com/package/collections-runner"><img src="https://img.shields.io/badge/npm%20package-1.0.23-brightgreen"></a>

- Run postman collections with custom environment variables in a unique command line
- Display all available routes and collections
- Quickly set default development or staging environment variables
- Multi-select routes to run
- Enable CI environment to be integrated to CI tests
- Select environment variables to update among the ones used in the selected routes
- Store environment variables in a local file to be used on next run
- Display run report on an html file

## Install

```
# If you use npm:
npm install --save-dev collections-runner

# Or if you use Yarn:
yarn add -D collections-runner
```

Create a `postman` folder at the root of your project.

This folder contains :

- Add a `postman_collection.json` containing your postman collections
- Add a `postman_environment.json` containing your postman environment
- Add a `postman_environment.local.json` containing your local postman environment, this file should be gitignored as it is updating after each run
- Add a `default.dev.json` containing default environment variables for your dev environment (typically your local url)
- Add a `default.staging.json` containing default environment variables for your staging environment (typically your staging url)

## Usage

Runs postman collections.

```
yarn collections-runner [routes names] [collections flags or vars]
```

```
# Exemple for CI job:
yarn collections-runner --ciEnvironment --updateLocalEnvironment=false --reporter=html --reporterPath='./newman/output/report.html'
```

Is used to interactively construct collections-runner commands.

```
yarn collections-automator
```

---
_Source: https://npm.io/package/collections-runner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._