# plucky-runner

> A standalone runner for plucky

Latest version **0.0.3** (published 2016-10-27) · ISC license · 0 weekly downloads

## Install

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

Provides the command `plucky-runner`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2016-10-27 |
| First published | 2016-10-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jeremy Darling |
| Maintainers | jdarling |

## Links

- npm: https://www.npmjs.com/package/plucky-runner
- Repository: https://github.com/plucky-ci/plucky-runner
- Homepage: https://github.com/plucky-ci/plucky-runner#readme
- Issues: https://github.com/plucky-ci/plucky-runner/issues
- npm.io page: https://npm.io/package/plucky-runner

## Dependencies (3)

- [plucky-loader](https://npm.io/package/plucky-loader.md) 0.0.5
- [plucky-pipeliner](https://npm.io/package/plucky-pipeliner.md) 0.0.4
- [plucky-plugin-manager](https://npm.io/package/plucky-plugin-manager.md) 0.0.1

## Recent versions

- 0.0.3 (latest) — 2016-10-27
- 0.0.2 — 2016-10-24
- 0.0.1 — 2016-10-21

## README

Plucky Runner
===

Standalone pipeline runner for Plucky-CI.

install
---

```shell
npm install -g plucky-runner
```

Usage
---

```shell
plucky-runner <options>
```

###Options

 * --basedir [folder], -b [folder] - Base directory to execute from, defaults to process.cwd()
 * --pluginsfolder [folder], -p [folder] - Path where plugins should be stored, defaults to [baseDir]/plugins
 * --configfile [folder], -c [folder] - Configuration file to use, default searches for one of
  * [baseDir]/.plucky
  * [baseDir]/plucky.js
  * [baseDir]/plucky.json
  * [baseDir]/plucky.yaml
  * [baseDir]/plucky.config
 * --param [param], -P [param] - Set a parameter, defined as [key]:[value]

**NOTE:** pluginsfolder is expanded from baseDir unless you specify a full path.

####Example

Example usage to run one of the test scenaiors manually:

```shell
plucky-runner -c configs/multi.js -p plugins/ -b ~/plucky-runner/test/
```

Would output:

```
{ status: 'Foo Bar' }
```

Example usage to run one of the test scenaiors manually with parameters:

```shell
plucky-runner -c configs/multi.js -p plugins/ -b ~/plucky-runner/test/ -P "status: Command Line Param"
```

Would output:

```
{ status: 'Command Line Param Foo Bar' }
```

Programmatic Usage
---

First install it into your project:

```
npm install --save plucky-runner
```

Then use it in your code:

```javascript
const {
  Runner
} = require('plucky-runner');
const path = require('path');

const baseDir = path.resolve(__dirname);
const pluginsFolder = path.resolve(baseDir, 'plugins');

const runner = new Runner({pluginsFolder, baseDir});
const globalConfig = {};
const params = {};

runner.run('/path/to/plucky.json', {globalConfig, params}, (err, result)=>{
  if(err){
    return console.error(err);
  }
  console.log('Result:');
  console.log(result);
});
```

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