/heroku-tarball-deploy

Heroku Tarball Deploy tool

Primary LanguageJavaScriptMIT LicenseMIT

Heroku Tarball Deploy npm version Build Status

A library and CLI script for automating a deployment of a tarball (tgz or tar file) to Heroku.

CLI tool

Instalation:

npm install heroku-tarball-deploy --global

How to use

Usage:

htd --app APP [--file FILE] [--username USERNAME] [--password PASSWORD]

Required arguments:

  • -a APP, --app APP - Heroku application name.

Optional arguments:

  • -a APP, --app APP - Heroku application name.
  • -f FILE, --file FILE - Path to tarball file
  • -u USERNAME, --username USERNAME - Heroku username, default: git
  • -p PASSWORD, -k PASSWORD, --password PASSWORD - Heroku user spassword or API key

Library

Instalation:

npm install heroku-tarball-deploy --save

Usage

Example usage:

const htd = require('heroku-tarball-deploy');

htd(opts)
  .then(() => console.log('Done'));

Available options:

  • app - required, Heroku application name
  • file - path to file (tgz or tar), default: build.tgz
  • credentials - Heroku credentials
    • username - user name, use git if you pass Heroku API key as password, default: git
    • password - required, user password or Heroku API Key
  • logger - logger object (compatible with Console - required methods: error and info)

Authors

This tool based on a project Rounded/heroku-deploy-tarball developed by John Shanley.