CLI の使用法

最終更新日 2023年06月16日(金)

heroku help​ を実行すると、使用法の概要が表示されます。

Usage: heroku COMMAND

Type heroku help TOPIC for more details.

 access          manage user access to apps
 addons          manage add-ons
 apps            manage apps
 authorizations  OAuth authorizations
 buildpacks      manage the buildpacks for an app
 certs           a topic for the ssl plugin
 ci              run an application test suite on Heroku
 clients         OAuth clients on the platform
 config          manage app config vars
 domains         manage the domains for an app
 drains          list all log drains
 features        manage optional features
 git             manage local git repository for app
 keys            manage ssh keys
 labs            experimental features
 local           run heroku app locally
 logs            display recent log output
 maintenance     manage maintenance mode for an app
 members         manage organization members
 notifications   display notifications
 orgs            manage organizations
 pg              manage postgresql databases
 pipelines       manage collections of apps in pipelines
 plugins         manage plugins
 ps              manage dynos (dynos, workers)
 redis           manage heroku redis instances
 regions         list available regions
 releases        manage app releases
 run             run a one-off process inside a Heroku dyno
 sessions        OAuth sessions
 spaces          manage heroku private spaces
 status          status of the Heroku platform
 teams           manage teams

コマンドは一般コマンドとアプリコマンドの 2 種類に分けられます。

一般コマンド

一般コマンドは Heroku アカウント全体に作用し、特定のアプリに固有ではありません。たとえば、自分が作成したアプリと、共同作業者として関わっているアプリの一覧を表示するには、次のコマンドを実行します。

$ heroku apps
=== user@example.org Apps
example
example2

=== Collaborated Apps
collabapp                 owner@example.org

アプリコマンド

アプリコマンドは通常、アプリのローカル Git クローン内から実行されます。アプリ名は、現在の作業コピーの Git リモートをスキャンすることによって自動的に検出されるため、操作するアプリを明示的に指定するわけではありません。たとえば、heroku apps:info​ コマンドは、--app​ を指定して呼び出すか、作業コピー内で引数なしで実行します。

$ cd example
$ heroku apps:info
=== example-app-69977
Auto Cert Mgmt: false
Dynos:
Git URL:        https://git.heroku.com/example-app-69977.git
Owner:          your@emailaddress.com
Region:         us
Repo Size:      0 B
Slug Size:      0 B
Stack:          heroku-18
Web URL:        https://example-app-69977.herokuapp.com/

複数のリモートがあるか、ローカル作業コピーの外でアプリコマンドを実行する場合、次のようにリモート名または明示的なアプリ名を指定できます。

$ heroku apps:info --app example
$ heroku apps:info --remote production

あるいは、HEROKU_APP​ 環境変数を設定してアプリ名を指定します。

HTTP プロキシの使用

外部の HTTP/HTTPS サービスへの接続にプロキシが必要なファイアウォールを使用している場合は、heroku​ コマンドを実行する前に、ローカルの開発者環境で HTTP_PROXY​ または HTTPS_PROXY​ 環境変数を設定できます。

UNABLE_TO_GET_ISSUER_CERT_LOCALLY​ または ECONNREFUSED​ エラーが発生した場合、おそらくプロキシが必要です。

たとえば、Unix システムでは次のコマンドを実行します。

$ export HTTP_PROXY=http://proxy.server.com:portnumber
or
$ export HTTPS_PROXY=https://proxy.server.com:portnumber
$ heroku login

Windows マシンでは、システムのプロパティ​ の 環境変数​ で設定するか、ターミナルから次のようにして設定します。

> set HTTP_PROXY=http://proxy.server.com:portnumber
or
> set HTTPS_PROXY=https://proxy.server.com:portnumber
> heroku login

このコマンドは、~/.bashrc​ (または同等の設定ファイル) に保存しておけば、新しいシェルセッションを開くたびに実行する必要はありません。

会社のインターネットで MITM プロキシを使用する必要がある場合、SELF_SIGNED_CERT_IN_CHAIN​ エラーが発生することがあります。プロキシの認証局 (CA) 証明書 (pem 形式) のファイルの場所を指定するには、NODE_EXTRA_CA_CERTS​ を設定します。または、自己署名証明書を直接発行した場合は、SSL_CERT_FILE​ または SSL_CERT_DIR​ を MITM 証明書を含むファイル/ディレクトリに設定します。

$ export NODE_EXTRA_CA_CERTS=/path/to/ca_cert.pem
$ heroku whoami