Skip to content

Latest commit

 

History

History
400 lines (273 loc) · 9.02 KB

ps.md

File metadata and controls

400 lines (273 loc) · 9.02 KB
Raw

heroku ps

Client tools for Heroku Exec

heroku ps [TYPE [TYPE ...]]

list dynos for an app

list dynos for an app


USAGE
  $ heroku ps [TYPE [TYPE ...]]

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use
  --json               display as json

EXAMPLES
  $ heroku ps
  === run: one-off dyno
  run.1: up for 5m: bash

  === web: bundle exec thin start -p $PORT
  web.1: created for 30s

  $ heroku ps run # specifying types
  === run: one-off dyno
  run.1: up for 5m: bash

heroku ps:autoscale:disable

disable web dyno autoscaling

disable web dyno autoscaling

USAGE
  $ heroku ps:autoscale:disable

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

See code: @heroku-cli/plugin-ps

heroku ps:autoscale:enable

enable web dyno autoscaling

enable web dyno autoscaling

USAGE
  $ heroku ps:autoscale:enable

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use
  --max=max            (required) maximum number of dynos
  --min=min            (required) minimum number of dynos
  --notifications      receive email notifications when the max dyno limit is reached
  --p95=p95            desired p95 response time

See code: @heroku-cli/plugin-ps

heroku ps:copy FILE

Copy a file from a dyno to the local filesystem

Copy a file from a dyno to the local filesystem
Example:

    $ heroku ps:copy FILENAME --app murmuring-headland-14719

USAGE
  $ heroku ps:copy FILE

OPTIONS
  -a, --app=app        (required) app to run command against
  -d, --dyno=dyno      specify the dyno to connect to
  -o, --output=output  the name of the output file
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Example:

       $ heroku ps:copy FILENAME --app murmuring-headland-14719

heroku ps:exec

Create an SSH session to a dyno

Create an SSH session to a dyno
Example:

    $ heroku ps:exec 'node -i' --app murmuring-headland-14719

USAGE
  $ heroku ps:exec

OPTIONS
  -a, --app=app        (required) app to run command against
  -d, --dyno=dyno      specify the dyno to connect to
  -r, --remote=remote  git remote of app to use
  --ssh                use native ssh
  --status             lists the status of the SSH server in the dyno

DESCRIPTION
  Example:

       $ heroku ps:exec 'node -i' --app murmuring-headland-14719

heroku ps:forward PORT

Forward traffic on a local port to a dyno

Forward traffic on a local port to a dyno
Provide a port or comma-separated list of ports to forward.

    For example, "4000,9000:9001" will forward port 4000 to port 4000 and
    port 9000 to port 9001.

    Example:

    $ heroku ps:forward 8080 --app murmuring-headland-14719

USAGE
  $ heroku ps:forward PORT

OPTIONS
  -a, --app=app        (required) app to run command against
  -d, --dyno=dyno      specify the dyno to connect to
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Provide a port or comma-separated list of ports to forward.

       For example, "4000,9000:9001" will forward port 4000 to port 4000 and
       port 9000 to port 9001.

       Example:

       $ heroku ps:forward 8080 --app murmuring-headland-14719

heroku ps:kill DYNO

stop app dyno

stop app dyno

stop app dyno or dyno type

USAGE
  $ heroku ps:kill DYNO

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  stop app dyno or dyno type

EXAMPLES
  $ heroku ps:stop run.1828
  Stopping run.1828 dyno... done

  $ heroku ps:stop run
  Stopping run dynos... done

heroku ps:resize

manage dyno sizes

manage dyno sizes

Called with no arguments shows the current dyno size.

Called with one argument sets the size.
Where SIZE is one of free|hobby|standard-1x|standard-2x|performance

Called with 1..n TYPE=SIZE arguments sets the quantity per type.


USAGE
  $ heroku ps:resize

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Called with no arguments shows the current dyno size.

  Called with one argument sets the size.
  Where SIZE is one of free|hobby|standard-1x|standard-2x|performance

  Called with 1..n TYPE=SIZE arguments sets the quantity per type.

heroku ps:restart [DYNO]

restart app dynos

restart app dynos
if DYNO is not specified, restarts all dynos on app

USAGE
  $ heroku ps:restart [DYNO]

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  if DYNO is not specified, restarts all dynos on app

EXAMPLES
  $ heroku ps:restart web.1
  Restarting web.1 dyno... done

  $ heroku ps:restart web
  Restarting web dynos... done

  $ heroku ps:restart
  Restarting dynos... done

heroku ps:scale

scale dyno quantity up or down

scale dyno quantity up or down
Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing.

Omitting any arguments will display the app's current dyno formation, in a
format suitable for passing back into ps:scale.

USAGE
  $ heroku ps:scale

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing.

  Omitting any arguments will display the app's current dyno formation, in a
  format suitable for passing back into ps:scale.

EXAMPLES
  $ heroku ps:scale web=3:Standard-2X worker+1
  Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X.

  $ heroku ps:scale
  web=3:Standard-2X worker=1:Standard-1X

heroku ps:socks

Launch a SOCKS proxy into a dyno

Launch a SOCKS proxy into a dyno
Example:

    $ heroku ps:socks --app murmuring-headland-14719
    Establishing credentials... done
    SOCKSv5 proxy server started on port 1080
    Use CTRL+C to stop the proxy

USAGE
  $ heroku ps:socks

OPTIONS
  -a, --app=app        (required) app to run command against
  -d, --dyno=dyno      specify the dyno to connect to
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Example:

       $ heroku ps:socks --app murmuring-headland-14719
       Establishing credentials... done
       SOCKSv5 proxy server started on port 1080
       Use CTRL+C to stop the proxy

heroku ps:stop DYNO

stop app dyno

stop app dyno

stop app dyno or dyno type

USAGE
  $ heroku ps:stop DYNO

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  stop app dyno or dyno type

EXAMPLES
  $ heroku ps:stop run.1828
  Stopping run.1828 dyno... done

  $ heroku ps:stop run
  Stopping run dynos... done

heroku ps:type

manage dyno sizes

manage dyno sizes

Called with no arguments shows the current dyno size.

Called with one argument sets the size.
Where SIZE is one of free|hobby|standard-1x|standard-2x|performance

Called with 1..n TYPE=SIZE arguments sets the quantity per type.


USAGE
  $ heroku ps:type

OPTIONS
  -a, --app=app        (required) app to run command against
  -r, --remote=remote  git remote of app to use

DESCRIPTION
  Called with no arguments shows the current dyno size.

  Called with one argument sets the size.
  Where SIZE is one of free|hobby|standard-1x|standard-2x|performance

  Called with 1..n TYPE=SIZE arguments sets the quantity per type.

heroku ps:wait

wait for all dynos to be running latest version after a release

wait for all dynos to be running latest version after a release

USAGE
  $ heroku ps:wait

OPTIONS
  -R, --with-run                     whether to wait for one-off run dynos
  -a, --app=app                      (required) app to run command against
  -r, --remote=remote                git remote of app to use
  -t, --type=type                    wait for one specific dyno type

  -w, --wait-interval=wait-interval  [default: 10] how frequently to poll in seconds (to avoid hitting Heroku API rate
                                     limits)

See code: @heroku-cli/plugin-ps