# robo-friend

> Your friendly Github PR and issue helper robot

Latest version **0.1.0** (published 2013-06-27) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install robo-friend
pnpm add robo-friend
yarn add robo-friend
bun add robo-friend
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2013-06-27 |
| First published | 2013-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+8 in 2 direct dependencies) |
| Install scripts | no |
| Author | Brian Ford |
| Maintainers | btford |

## Links

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

## Dependencies (6)

- [q](https://npm.io/package/q.md) ~0.9.3
- [github](https://npm.io/package/github.md) ~0.1.8
- [lodash](https://npm.io/package/lodash.md) ~1.2.1
- [express](https://npm.io/package/express.md) ~3.2.6
- [hookshot](https://npm.io/package/hookshot.md) 0.0.2
- [commander](https://npm.io/package/commander.md) ~1.1.1

## Recent versions

- 0.1.0 (latest) — 2013-06-27
- 0.0.1 — 2013-06-25

## README

# Robo-Friend

Your friendly Github PR and issue helper robot.

## Config

The config file is just JavaScript.
See `example-config.js` for an example.

## Install

Install `robo-friend` via `npm`:

```shell
npm install -g robo-friend
```

Then you need to add the appropriate [Github repository hook](http://developer.github.com/v3/repos/hooks/).
Robo-Friend can do this for you.
Run:

```shell
robo-friend install config.js
```

If you need to make changes to the config, uninstall then re-install.

## Uninstall

Uninstall disables and removes the Github hook.
You can uninstall by running the following:

```shell
robo-friend remove
```

To verify that the hook isn't there anymore, you can run:

```shell
robo-friend hooks
```

Which will log something like this:

```
#12345678
  active: true
  url:    http://example.com:3000/
```

## Running

Once Robo-Friend's GitHub hook is installed, you can have it respond to PRs like this:

```shell
robo-friend start config.js
```

## Cache

Robo-friend caches Github repo data to reduce the number of Github calls it needs to make.
This cache is stored in `.cache` by default.
Robo-Friend is pretty good at knowing when it has a dirty cache, but you can remove this directory if you'd like to.

## License
MIT

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