renovate/readme.md

# renovate

> Keep npm dependencies up-to-date

##  Why

- Creates or updates Pull Requests for each dependency that needs updating
- Supports multiple `package.json` files per repository
- Supports multiple major versions per-dependency at once
- Configurable via file, environment, CLI, and `package.json`
- Self-hosted

Inspired by the services at [Greenkeeper](https://greenkeeper.io) and [Doppins](https://doppins.com).

## Install

```
$ npm install -g renovate
```

## Authentication

You need to select a GitHub user for `renovate` to assume the identity of. It's recommended that you use a dedicated "bot" account for this to avoid user confusion.

The script will need a GitHub Personal Access Token with "repo" permissions. You can find instructions for generating it here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/

This token needs to be configured via file, environment variable, or CLI. See [docs/configuration.md](docs/configuration.md) for details.

## Usage (CLI)

```
$ renovate --help

  Usage: renovate [options] [repositories...]

  Options:

    -h, --help                  output usage information
    -d, --dep-types <list>      List of dependency types
    -i, --ignore-deps <list>    List of dependencies to ignore
    -b, --labels <list>         List of labels to apply
    -l, --log-level <level>     Log Level
    -p, --package-files <list>  List of package.json file names
    -r, --recreate-prs          Recreate PRs if previously closed
    -t, --token <token>         GitHub Auth Token

  Examples:

    $ renovate --token abc123 singapore/lint-condo
    $ renovate --token abc123 -l verbose singapore/lint-condo
    $ renovate --token abc123 singapore/lint-condo singapore/package-test
```
Update README.md 2016-12-17 16:26:06 +00:00			`# renovate`

Update docs 2017-01-15 17:59:32 +00:00			`> Keep npm dependencies up-to-date`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`## Why`
Update README (#27) Closes #26 2017-01-12 19:56:46 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`- Creates or updates Pull Requests for each dependency that needs updating`
			- Supports multiple `package.json` files per repository
			`- Supports multiple major versions per-dependency at once`
			- Configurable via file, environment, CLI, and `package.json`
			`- Self-hosted`
Update README (#27) Closes #26 2017-01-12 19:56:46 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`Inspired by the services at [Greenkeeper](https://greenkeeper.io) and [Doppins](https://doppins.com).`
Add inspirations 2017-01-13 08:47:23 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`## Install`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			```
			`$ npm install -g renovate`
			```
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`## Authentication`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			You need to select a GitHub user for `renovate` to assume the identity of. It's recommended that you use a dedicated "bot" account for this to avoid user confusion.
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`The script will need a GitHub Personal Access Token with "repo" permissions. You can find instructions for generating it here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`This token needs to be configured via file, environment variable, or CLI. See [docs/configuration.md](docs/configuration.md) for details.`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`## Usage (CLI)`
Update README.md 2016-12-18 11:00:41 +00:00
			```
Update docs 2017-01-15 17:59:32 +00:00			`$ renovate --help`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`Usage: renovate [options] [repositories...]`
Update README.md 2016-12-18 11:00:41 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`Options:`
Update README.md 2017-01-09 06:17:22 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`-h, --help output usage information`
			`-d, --dep-types <list> List of dependency types`
			`-i, --ignore-deps <list> List of dependencies to ignore`
			`-b, --labels <list> List of labels to apply`
			`-l, --log-level <level> Log Level`
			`-p, --package-files <list> List of package.json file names`
			`-r, --recreate-prs Recreate PRs if previously closed`
			`-t, --token <token> GitHub Auth Token`
Update README.md 2017-01-09 06:17:22 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`Examples:`
Update README (#27) Closes #26 2017-01-12 19:56:46 +00:00
Update docs 2017-01-15 17:59:32 +00:00			`$ renovate --token abc123 singapore/lint-condo`
			`$ renovate --token abc123 -l verbose singapore/lint-condo`
			`$ renovate --token abc123 singapore/lint-condo singapore/package-test`
Update README.md 2016-12-18 11:00:41 +00:00			```