An open API service indexing awesome lists of open source software.

https://github.com/banphlet/herokudep

A plugin for deploying apps on heroku
https://github.com/banphlet/herokudep

application-health cli heroku heroku-app heroku-cli-plugin heroku-deployment nodejs

Last synced: 4 months ago
JSON representation

A plugin for deploying apps on heroku

Awesome Lists containing this project

README

          

@banphlet/herokudep
====================

Simple Cli for managing heroku deployments. This Cli allows you to deploy single or multiple heroku apps. After each deployment we make a request to the application health route `/health`. Ensure you have provided a health route in your application with the path `/health` or you can pass `-s`to skip checking the application health.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@banphlet/herokudep.svg)](https://npmjs.org/package/@banphlet/herokudep)
[![Downloads/week](https://img.shields.io/npm/dw/@banphlet/herokudep.svg)](https://npmjs.org/package/@banphlet/herokudep)
[![License](https://img.shields.io/npm/l/@banphlet/herokudep.svg)](https://github.com/banphlet/herokudep/blob/master/package.json)

* [Usage](#usage)
* [Commands](#commands)

# Usage

```sh-session
$ npm install -g @banphlet/herokudep
$ herokudep COMMAND
running command...
$ herokudep (-v|--version|version)
@banphlet/herokudep/0.1.0 darwin-x64 node-v8.16.1
$ herokudep --help [COMMAND]
USAGE
$ herokudep COMMAND
...
```

# Commands

* [`herokudep deploy`](#herokudep-deploy)
* [`herokudep help [COMMAND]`](#herokudep-help-command)
* [`herokudep start`](#herokudep-start)

## `herokudep deploy`

Deploy heroku applications using one command.

```
USAGE
$ herokudep deploy

OPTIONS
-a, --app=app (required) app to run command against
-h, --help show CLI help
-s, --skipHealthCheck=skipHealthCheck [default: false] Skip checking /health endpoint for application health status
-t, --token=token (required) Heroku api token
-v, --version show CLI version

EXAMPLES
$ herokudep deploy -t heroku-token -a heroku-app
$ herokudep deploy -t heroku-token -a heroku-app -s // pass -s to skip checking application health
```

_See code: [src/commands/deploy.ts](https://github.com/banphlet/herokudep/blob/v0.1.0/src/commands/deploy.ts)_

## `herokudep help [COMMAND]`

display help for herokudep

```
USAGE
$ herokudep help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_

## `herokudep start`

Deploy multiple services to different heroku apps. Requires you have services.json in the root of your application

```
USAGE
$ herokudep start

OPTIONS
-h, --help show CLI help
-t, --token=token (required) Heroku api token
-v, --version show CLI version

EXAMPLE
$ herokudep -t heroku token
```

_See code: [src/commands/start.ts](https://github.com/banphlet/herokudep/blob/v0.1.0/src/commands/start.ts)_

See examples here [examples](/examples)

HAPPY HACKING ❤