最終更新日 2021年04月27日(火)

Heroku Command Line Interface (CLI) を使用すると、Heroku アプリをターミナルから直接、簡単に作成および管理できます。Heroku CLI は、Heroku を利用する際に必要なツールです。

ダウンロードおよびインストール

​macOS

​$ ​brew tap heroku/brew && brew install heroku

​Windows

​ご使用の Windows に合ったインストーラをダウンロードします。

​64 ビット用インストーラ

​32 ビット用インストーラ

​Ubuntu 16 以降

​ターミナルで以下を実行します。

$ sudo snap install --classic heroku

_{​その他の Linux OS では Snap も利用できます​。}

その他のインストール方法

スタンドアロンインストール

スタンドアロンインストールは、バイナリを使用した単純な tar 書庫です。独自の node.js バイナリが含まれ、上記のインストール方法のように自動更新します。

/usr/local/lib/heroku​ および /usr/local/bin/heroku​ にすばやく設定するには、このスクリプトを実行します (スクリプトは sudo を必要とし、Windows 互換ではありません)。

$ curl https://cli-assets.heroku.com/install.sh | sh

それ以外の場合は、下記のいずれかの tar 書庫をダウンロード後、展開してください。

tar 書庫

これらは gz​ または xz​ 圧縮で使用できます。xz​ は非常に小さくなりますが、gz​ は互換性が高くなります。

• macOS
• Linux (x64)
• Linux (arm)
• Windows (x64)
• Windows (x86)

Ubuntu / Debian apt-get

$ curl https://cli-assets.heroku.com/install-ubuntu.sh | sh

このバージョンは、自動更新せず、apt-get​ を介して手動で更新する必要があります。CLI のバージョンの自動更新には、snap​ またはスタンドアロンインストール​を使用します。

Arch Linux

このパッケージ​はコミュニティで管理されており、Heroku によって管理されていません​。

$ yay -S heroku-cli

npm

CLI は Node.js でビルドされ、npm​ を介してインストールできます。これは、自動更新が理想的ではない環境や、Heroku が事前ビルドされた Node.js バイナリを提供していない環境で使用できる手動インストール方法です。

このインストール方法は、ARM と BSD でのユーザーに必要です。node​ と npm​ がすでにインストールされている必要があります。

$ npm install -g heroku

インストールの検証

CLI インストールを検証するには、heroku --version​ コマンドを使用します。

$ heroku --version
heroku/7.0.0 (darwin-x64) node-v8.0.0

出力に heroku/x.y.z​ が表示されます。表示されないが、Heroku CLI をインストールしている場合は、システム上に古い heroku​ gem が存在している可能性があります。これらの手順​を使用してアンインストールしてください。

はじめに

CLI をインストールした後、heroku login​ コマンドを実行します。いずれかのキーを入力し、Web ブラウザに移動してログインを完了するように求められます。続いて CLI から自動的にログインします。

$ heroku login
heroku: Press any key to open up the browser to login or q to exit
 ›   Warning: If browser does not open, visit
 ›   https://cli-auth.heroku.com/auth/browser/***
heroku: Waiting for login...
Logging in... done
Logged in as me@example.com

そのまま CLI を使用して資格情報を入力する場合、heroku login -i​ を実行できます。

$ heroku login -i
heroku: Enter your login credentials
Email: me@example.com
Password: ***************
Two-factor code: ********
Logged in as me@heroku.com

CLI は、将来使用できるように、メールアドレスと API トークンを ~/.netrc​ に保存します。詳細については、「Heroku CLI Authentication​」(Heroku CLI 認証) を参照してください。

これで、最初の Heroku アプリを作成する準備ができました。

$ cd ~/myapp
$ heroku create
Creating app... done, ⬢ sleepy-meadow-81798
https://sleepy-meadow-81798.herokuapp.com/ | https://git.heroku.com/sleepy-meadow-81798.git

最初のアプリのデプロイの包括的な概要については、ご希望の言語のスターターガイド​を確認してください。

最新の状態の維持

Debian/Ubuntu パッケージをインストールした、または npm install​ を使用した場合以外は​、Heroku CLI はそれ自体とそのプラグイン (リンク先のプラグインを除く) を自動的に最新の状態に保ちます。

heroku​ コマンドを実行すると、バックグラウンドプロセスによって CLI の最新の使用可能バージョンが確認されます。新しいバージョンが見つかると、ダウンロードされ、~/.local/share/heroku/client​ に保存されます。このバックグラウンドチェックは最大 4 時間ごとに 1 度行われます。

heroku​ バイナリは、元々インストールされていたクライアントを使用する前に、~/.local/share/heroku/client​ の最新のクライアントをチェックします。

最新リリースの SHA

Darwin

• x64

Linux

• arm
• x64

Windows

• x64
• x86

有用な CLI プラグイン

CLI プラグインを使用すると、CLI インストールを拡張できます。heroku plugins:install someplugin で CLI プラグインをインストールします。プラグイン管理の詳細については、「Using CLI Plugins」(CLI プラグインの使用) を参照してください。

試用できる便利なプラグインを紹介します。

• heroku-builds — ビルドを表示し、ビルドキャッシュをパージし、tar 書庫からビルドを作成します
• heroku-repo — アプリの Heroku Git リポジトリを操作するためのコマンド
• api — アドホックな API リクエスト (heroku api GET /account など) を作成します
• heroku-pg-extras — さらに heroku pg:* コマンドを追加します
• heroku-slugs — アプリ slug をダウンロードします
• heroku-kafka — Heroku Kafka を管理します
• heroku-papertrail — Papertrail でログを表示、末尾監視、および検索します

CLI アーキテクチャ

Heroku CLI は、Heroku/Salesforce 内で開発された Open CLI Framework (oclif) でビルドされます。 oclif は、開発者が大型または小型の CLI をビルドするためのフレームワークとして使用できます。フレームワークには、CLI ジェネレーター、ドキュメント自動作成、テストインフラストラクチャが含まれます。

Heroku CLI のコードはオープンソースでもあります。Node.js や他の依存関係を実行する必要はありません​。Debian/Ubuntu パッケージをインストールしたり、npm install を使用したりする場合以外は、CLI には、他のアプリケーションと競合しない独自の Node.js バイナリが含まれます。

トラブルシューティング

CLI に問題が生じている場合は、最初に、最新バージョンを使用していることを確認します。使用していない場合は、heroku update で更新してみてください。

CLI が更新できない場合、下の手順でアンインストールしてから再インストールしてみてください。which heroku または where heroku (Windows の場合) を使用して heroku コマンドが示しているものを確かめることによって、従来の Heroku Toolbelt または Heroku Ruby gem がインストールされていないことを確認します。/usr/local/bin/heroku を含めるように PATH を変更する必要が生じる場合があります (多くのインストール方法で必要な場合があります)。

引き続き問題が発生する場合は、次のデバッグ環境変数を設定し、診断に役立ててください。

オペレーティングシステムに応じて次の場所のいずれかに保存された CLI のエラーログファイルもチェックできます。

問題の発生が続き、CLI が最新の場合、またはその他の理由で更新が失敗した場合、ユーザーディレクトリを削除することよって、CLI をリセットできます。これらのディレクトリは自動的に置き換えられ、ログアウトされませんが、インストールしたプラグインが失われます。__

まず、確実に再インストールできるように、heroku plugins を実行してインストールしたプラグインを一覧表示します。

続いて次のディレクトリを削除します。

Windows:

• %LOCALAPPDATA%\heroku

macOS/Linux/その他:

• ~/.local/share/heroku (または設定されている場合は XDG_DATA_HOME)
• macOS では ~/Library/Caches/heroku、Linux/その他では ~/.cache/heroku (または設定されている場合は XDG_CACHE_HOME)

ログイン問題

ログインに問題が発生している場合は、.netrc​ ファイルを移動してみてください。これは、CLI が証明書を保存する場所です。

$ mv ~/.netrc ~/.netrc.backup
$ heroku login

Windows では、ファイルに _netrc​ という名前が付けられます。

Homebrew 固有の問題

最新の Homebrew バージョンの Heroku をインストールしていても、従来の警告が表示された場合、これは、PATH​ 環境変数内のバイナリ heroku​ コマンドが、brew がインストールしたバージョンを示していないために起きています。

まず、which heroku​ を実行して、バイナリ heroku​ が示しているものを表示します。これが /usr/local/bin/heroku​ でない場合、示しているバイナリを削除するか、~/.bashrc​ ファイルまた同等のファイルを変更することにより、PATH​ 環境変数内で /usr/local/bin/​ をさらに上位にする必要があります。

次に brew link --overwrite heroku​ を実行して、/usr/local/bin/heroku​ が新しい CLI を示していることを確認します。トラブルが続く場合、システムの問題を示す brew doctor​ を実行します。

Heroku CLI のアンインストール

macOS

macOS で、次のように入力して CLI をアンインストールできます。

$ rm -rf /usr/local/heroku /usr/local/lib/heroku /usr/local/bin/heroku ~/.local/share/heroku ~/Library/Caches/heroku

Homebrew

Homebrew を使用して Heroku CLI をインストールした場合、次のように入力して CLI をアンインストールできます。

$ brew uninstall heroku
$ rm -rf ~/.local/share/heroku ~/Library/Caches/heroku

Linux

スタンドアロンインストール

スタンドアロンインストールの場合、次のように入力して CLI をアンインストールできます。

$ rm /usr/local/bin/heroku
$ rm -rf /usr/local/lib/heroku /usr/local/heroku
$ rm -rf ~/.local/share/heroku ~/.cache/heroku

Debian および Ubuntu のインストール

Debian/Ubuntu の場合、次のように入力して CLI をアンインストールできます。

$ sudo apt-get remove heroku heroku-toolbelt
$ sudo rm /etc/apt/sources.list.d/heroku.list

$XDG_DATA_HOME​ や $XDG_CACHE_HOME​ がある場合、~/.local/share​ と ~/.cache​ の代わりにこれらの変数を使用します。

次のコマンドを実行することでリリースキーを削除できます。

$ sudo apt-key list
$ sudo apt-key del KEYFROMABOVE

Windows

Windows で、Heroku CLI をアンインストールするには次の手順を実行します。

1. Start > Control Panel > Programs > Programs and Features​ (スタート > コントロールパネル > すべてのプログラム > プログラムと機能) をクリックします。
2. Heroku CLI​ (Heroku CLI) を選択してから、Uninstall​ (アンインストール) をクリックします。(アンインストーラーが署名されていないことに注意してください)

これがうまくいかない場合、Program Files 内のディレクトリと一緒に %LOCALAPPDATA%\heroku​ を手動で削除してください。

従来の Heroku gem のアンインストール

実行可能ファイルが置かれている場所を見つけるには、which​ を実行します。

$ which heroku
/usr/local/heroku/bin/heroku

heroku​ コマンドへのパスは Ruby gem ディレクトリにしないでください。

そのようになっている場合、これと他のすべての heroku​ gem をアンインストールします。

$ gem uninstall heroku --all