# spronk

> Easily cluster your apps via the CLI or with code.

Latest version **1.0.1** (published 2017-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install spronk
pnpm add spronk
yarn add spronk
bun add spronk
```

Provides the command `spronk`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-09-23 |
| First published | 2017-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alec Mekarzel |
| Maintainers | alecmekarzel |

## Links

- npm: https://www.npmjs.com/package/spronk
- npm.io page: https://npm.io/package/spronk

## Dependencies (4)

- [commander](https://npm.io/package/commander.md) ^2.9.0
- [lodash.defaults](https://npm.io/package/lodash.defaults.md) ^4.0.1
- [lodash.isfunction](https://npm.io/package/lodash.isfunction.md) ^3.0.8
- [lodash.isplainobject](https://npm.io/package/lodash.isplainobject.md) ^4.0.6

## Recent versions

- 1.0.1 (latest) — 2017-09-23
- 1.0.0 — 2017-09-23

## README

# spronk

Easily cluster your apps via the CLI or with code.

## Installation
```bash
# NPM
$ npm install spronk
$ npm install spronk -g

# Yarn
$ yarn add spronk
$ yarn global add spronk
```

## Getting Started

#### With CLI

```bash
# View Help
$ spronk --help

# Basic Usage
$ spronk <file> [options]

# Basic Example
$ spronk example.js --workers 4
```

#### With Code

```js
const spronk = require('spronk')

spronk({
	workers: 4, // number of workers to start [#CPUS]
	grace: 1000, // ms grace period after worker SIGTERM [5000]
	lifetime: 10000, // ms to keep cluster alive if workers exit [Infinity]
	start: function() {} // worker functions, this would typically contain your server code
})
```

## Testing

Simply run `npm test` or `yarn test` (depending on your package manager) and all of the tests in the `test/` directory will be run.

## Issues

We don't accept issues; we accept pull requests.

## Changelog

For milestones, visit the [project's releases](https://github.com/alecmekarzel/spronk/releases).

## License

For license information, visit the [project's license](https://github.com/alecmekarzel/spronk/blob/master/LICENSE).

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