Skip to content

apps.md

Latest commit

 

History

History
505 lines (350 loc) · 12.2 KB

apps.md

File metadata and controls

505 lines (350 loc) · 12.2 KB

heroku apps

manage apps on Heroku

heroku apps

list your apps

USAGE
  $ heroku apps [--prompt] [-A] [-j] [-p] [-s <value>] [-t <value>]

FLAGS
  -A, --all            include apps in all teams
  -j, --json           output in json format
  -p, --personal       list apps in personal account when a default team is set
  -s, --space=<value>  filter by space
  -t, --team=<value>   team to use

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

DESCRIPTION
  list your apps

EXAMPLES
   $ heroku apps

See code: src/commands/apps/index.ts

heroku apps:create [APP]

creates a new app

USAGE
  $ heroku apps:create [APP] [--prompt] [--addons <value>] [-b <value>] [--json] [-n] [--region <value>] [-r
    <value>] [--space <value>] [-s <value>] [-t <value>]

ARGUMENTS
  [APP]  name of app to create

FLAGS
  -b, --buildpack=<value>  buildpack url to use for this app
  -n, --no-remote          do not create a git remote
  -r, --remote=<value>     [default: heroku] the git remote to create, default "heroku"
  -s, --stack=<value>      the stack to create the app on
  -t, --team=<value>       team to use
      --addons=<value>     comma-delimited list of addons to install
      --json               output in json format
      --region=<value>     specify region for the app to run in
      --space=<value>      the private space to create the app in

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

DESCRIPTION
  creates a new app

EXAMPLES
   $ heroku apps:create 
  Creating app... done, stack is heroku-24
  https://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git

  # or just
   $ heroku create 

  # use a heroku.yml manifest file
   $ heroku apps:create --manifest 

  # specify a buildpack
   $ heroku apps:create --buildpack https://github.com/some/buildpack.git 

  # specify a name
   $ heroku apps:create example 

  # create a staging app
   $ heroku apps:create example-staging --remote staging 

  # create an app in the eu region
   $ heroku apps:create --region eu

See code: src/commands/apps/create.ts

heroku apps:destroy

permanently destroy an app

USAGE
  $ heroku apps:destroy [--prompt] [-a <value>] [-c <value>] [-r <value>]

FLAGS
  -a, --app=<value>      app to run command against
  -c, --confirm=<value>
  -r, --remote=<value>   git remote of app to use

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

DESCRIPTION
  permanently destroy an app

See code: src/commands/apps/destroy.ts

heroku apps:diff APP1 APP2

diffs two apps

USAGE
  $ heroku apps:diff APP1 APP2 [--prompt]

ARGUMENTS
  APP1  first app to compare
  APP2  second app to compare

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

DESCRIPTION
  diffs two apps

See code: src/commands/apps/diff.ts

heroku apps:errors

view app errors

USAGE
  $ heroku apps:errors -a <value> [--prompt] [--dyno] [--hours <value>] [--json] [-r <value>] [--router]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
      --dyno            show only dyno errors
      --hours=<value>   [default: 24] number of hours to look back (default 24)
      --json            output in json format
      --router          show only router errors

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

DESCRIPTION
  view app errors

See code: src/commands/apps/errors.ts

heroku apps:favorites

list favorited apps

USAGE
  $ heroku apps:favorites [--prompt] [-j]

FLAGS
  -j, --json  output in json format

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

DESCRIPTION
  list favorited apps

See code: src/commands/apps/favorites/index.ts

heroku apps:favorites:add

favorites an app

USAGE
  $ heroku apps:favorites:add -a <value> [--prompt] [-r <value>]

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
  favorites an app

See code: src/commands/apps/favorites/add.ts

heroku apps:favorites:remove

unfavorites an app

USAGE
  $ heroku apps:favorites:remove -a <value> [--prompt] [-r <value>]

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
  unfavorites an app

See code: src/commands/apps/favorites/remove.ts

heroku apps:info

show detailed app information

USAGE
  $ heroku apps:info [--prompt] [-a <value>] [-j] [-r <value>] [-s]

FLAGS
  -a, --app=<value>     app to run command against
  -j, --json            output in json format
  -r, --remote=<value>  git remote of app to use
  -s, --shell           output more shell friendly key/value pairs

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

DESCRIPTION
  show detailed app information

EXAMPLES
   $ heroku apps:info 

   $ heroku apps:info --shell

See code: src/commands/apps/info.ts

heroku apps:join

add yourself to a team app

USAGE
  $ heroku apps:join -a <value> [--prompt] [-r <value>]

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
  add yourself to a team app

ALIASES
  $ heroku join

See code: src/commands/apps/join.ts

heroku apps:leave

remove yourself from a team app

USAGE
  $ heroku apps:leave -a <value> [--prompt] [-r <value>]

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 yourself from a team app

ALIASES
  $ heroku leave

EXAMPLES
   $ heroku apps:leave -a APP

See code: src/commands/apps/leave.ts

heroku apps:lock

prevent team members from joining an app

USAGE
  $ heroku apps:lock -a <value> [--prompt] [-r <value>]

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
  prevent team members from joining an app

ALIASES
  $ heroku lock

See code: src/commands/apps/lock.ts

heroku apps:open [PATH]

open the app in a web browser

USAGE
  $ heroku apps:open [PATH] -a <value> [--prompt] [-r <value>]

ARGUMENTS
  [PATH]  base URL path of app

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
  open the app in a web browser

EXAMPLES
   $ heroku open -a myapp 

   $ heroku open -a myapp /foo

See code: src/commands/apps/open.ts

heroku apps:rename NEWNAME

rename an app

USAGE
  $ heroku apps:rename NEWNAME -a <value> [--prompt] [-r <value>]

ARGUMENTS
  NEWNAME  new unique name of the app

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
  rename an app

EXAMPLES
   $ heroku apps:rename --app oldname newname

See code: src/commands/apps/rename.ts

heroku apps:stacks

show the list of available stacks

USAGE
  $ heroku apps:stacks -a <value> [--prompt] [-r <value>]

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
  show the list of available stacks

See code: src/commands/apps/stacks/index.ts

heroku apps:stacks:set STACK

set the stack of an app

USAGE
  $ heroku apps:stacks:set STACK -a <value> [--prompt] [-r <value>]

ARGUMENTS
  STACK  unique name or identifier of the stack

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
  set the stack of an app

EXAMPLES
   $ heroku stack:set heroku-24 -a myapp 
  Setting stack to heroku-24... done
  You will need to redeploy myapp for the change to take effect.
  Run git push heroku main to trigger a new build on myapp.

See code: src/commands/apps/stacks/set.ts

heroku apps:transfer RECIPIENT

transfer applications to another user or team

USAGE
  $ heroku apps:transfer RECIPIENT [--prompt] [-a <value>] [--bulk] [-l] [-r <value>]

ARGUMENTS
  RECIPIENT  user or team to transfer applications to

FLAGS
  -a, --app=<value>     app to run command against
  -l, --locked          lock the app upon transfer
  -r, --remote=<value>  git remote of app to use
      --bulk            transfer applications in bulk

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

DESCRIPTION
  transfer applications to another user or team

EXAMPLES
   $ heroku apps:transfer collaborator@example.com 
  Transferring example to collaborator@example.com... done

   $ heroku apps:transfer acme-widgets 
  Transferring example to acme-widgets... done

   $ heroku apps:transfer --bulk acme-widgets 
  ...

See code: src/commands/apps/transfer.ts

heroku apps:unlock

unlock an app so any team member can join

USAGE
  $ heroku apps:unlock -a <value> [--prompt] [-r <value>]

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
  unlock an app so any team member can join

ALIASES
  $ heroku unlock

See code: src/commands/apps/unlock.ts