Skip to content

container.md

Latest commit

 

History

History
202 lines (135 loc) · 5.86 KB

container.md

File metadata and controls

202 lines (135 loc) · 5.86 KB

heroku container

deploy your Docker-based app to Heroku

heroku container:login

log in to Heroku Container Registry

USAGE
  $ heroku container:login [--prompt] [-v]

FLAGS
  -v, --verbose

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  log in to Heroku Container Registry

See code: src/commands/container/login.ts

heroku container:logout

log out from Heroku Container Registry

USAGE
  $ heroku container:logout [--prompt] [-v]

FLAGS
  -v, --verbose

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  log out from Heroku Container Registry

See code: src/commands/container/logout.ts

heroku container:pull -a APP [-v] PROCESS_TYPE...

pulls an image from an app's process type

USAGE
  $ heroku container:pull -a APP [-v] PROCESS_TYPE...

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  -v, --verbose

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  pulls an image from an app's process type

EXAMPLES
   $ heroku container:pull web         # Pulls the web image from the app

   $ heroku container:pull web worker  # Pulls both the web and worker images from the app

   $ heroku container:pull web:latest  # Pulls the latest tag from the web image

See code: src/commands/container/pull.ts

heroku container:push

builds, then pushes Docker images to deploy your Heroku app

USAGE
  $ heroku container:push -a <value> [--prompt] [--arg <value>] [--context-path <value>] [-R] [-r <value>] [-v]

FLAGS
  -R, --recursive             pushes Dockerfile.<process> found in current and subdirectories
  -a, --app=<value>           (required) app to run command against
  -r, --remote=<value>        git remote of app to use
  -v, --verbose
      --arg=<value>           set build-time variables
      --context-path=<value>  path to use as build context (defaults to Dockerfile dir)

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  builds, then pushes Docker images to deploy your Heroku app

EXAMPLES
   $ heroku container:push web                           # Pushes Dockerfile to web process type

   $ heroku container:push worker                        # Pushes Dockerfile to worker process type

   $ heroku container:push web worker --recursive        # Pushes Dockerfile.web and Dockerfile.worker

   $ heroku container:push --recursive                   # Pushes Dockerfile.*

   $ heroku container:push web --arg ENV=live,HTTPS=on   # Build-time variables

   $ heroku container:push --recursive --context-path .  # Pushes Dockerfile.* using current dir as build context

See code: src/commands/container/push.ts

heroku container:release

Releases previously pushed Docker images to your Heroku app

USAGE
  $ heroku container:release

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  -v, --verbose

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  Releases previously pushed Docker images to your Heroku app

EXAMPLES
   $ heroku container:release web         # Releases the previously pushed web process type

   $ heroku container:release web worker  # Releases the previously pushed web and worker process types

See code: src/commands/container/release.ts

heroku container:rm -a APP [-v] PROCESS_TYPE...

remove the process type from your app

USAGE
  $ heroku container:rm -a APP [-v] PROCESS_TYPE...

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  remove the process type from your app

EXAMPLES
   $ heroku container:rm web         # Destroys the web container

   $ heroku container:rm web worker  # Destroys the web and worker containers

See code: src/commands/container/rm.ts

heroku container:run -a APP [-v] PROCESS_TYPE...

builds, then runs the docker image locally

USAGE
  $ heroku container:run -a APP [-v] PROCESS_TYPE...

FLAGS
  -a, --app=<value>     (required) app to run command against
  -p, --port=<value>    [default: 5000] port the app will run on
  -r, --remote=<value>  git remote of app to use
  -v, --verbose

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  builds, then runs the docker image locally

EXAMPLES
   $ heroku container:pull web         # Pulls the web image from the app

   $ heroku container:pull web worker  # Pulls both the web and worker images from the app

   $ heroku container:pull web:latest  # Pulls the latest tag from the web image

See code: src/commands/container/run.ts