# grappler

> Pluggable deploy system

Latest version **0.1.1** (published 2014-03-25) · MIT license · 0 weekly downloads

## Install

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

## 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.1.1 |
| Published | 2014-03-25 |
| First published | 2014-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Cameron Bytheway |
| Maintainers | camshaft |
| Keywords | deploy, grappler |

## Links

- npm: https://www.npmjs.com/package/grappler
- Repository: https://github.com/camshaft/grappler
- Issues: https://github.com/camshaft/grappler/issues
- npm.io page: https://npm.io/package/grappler

## Dependencies (3)

- [mktemp](https://npm.io/package/mktemp.md) ~0.3.4
- [rimraf](https://npm.io/package/rimraf.md) ~2.2.6
- [simple-stack-common](https://npm.io/package/simple-stack-common.md) ~0.2.3

## Recent versions

- 0.1.1 (latest) — 2014-03-25
- 0.1.0 — 2014-03-20

## README

grappler [![Build Status](https://travis-ci.org/camshaft/grappler.png?branch=master)](https://travis-ci.org/camshaft/grappler)
========

Pluggable deploy system

Usage
-----

```js
var grappler = require('grappler');

var app = grappler();

app.hook('github', '/github', function(task, log, fn) {
  // extract webhook info from `task.body` and clone the repo to `task.dir`

  // pass back the extracted info
  fn(err, repoName, branch, sha, event);
});

app.deploy('heroku', function(task, log, fn) {
  // deploy the code in `task.dir`

  // finish the deploy
  fn(err);
});

app.logger(function(namespace, level, str, task) {
  // log messages here
});

// The plugin function can be used to register pre-packaged hooks, deployments, and loggers
var stdout = require('grappler-logger-stdout');
app.plugin(stdout());

var opsworks = require('grappler-deploy-opsworks');
app.plugin(opsworks({
  key: 'key123',
  secret: 'secret456'
}));
```

Tests
-----

```sh
$ npm test
```

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