Heroku CLI

概要

Heroku CLI は、Heroku アプリケーションとサービスを管理するためのコマンドラインインターフェースです。Node.js と oclif で構築されており、Heroku プラットフォームとやり取りするための拡張可能なアーキテクチャを提供します。

Heroku の詳細については、https://www.heroku.com/home をご覧ください。

使い始めるには、https://devcenter.heroku.com/start をご覧ください。

CLI の主な機能は次のとおりです。

• アプリ管理 - アプリケーションのデプロイ、スケーリング、監視
• Heroku Postgres データベース管理 - Heroku Postgres データベースのバックアップ、復元、管理
• Heroku CI/CD パイプライン - 自動テストを実行し、レビューアプリを管理して、デプロイのワークフローを効率化
• アドオンマーケットプレイス - アプリケーションを拡張するツールやサービスをプロビジョニングして管理
• SSL 証明書とドメイン - カスタムドメインを設定し、SSL/TLS 証明書を自動的に管理
• チームでのコラボレーション - きめ細かな権限で組織とチームのアクセスを管理
• Private Spaces - VPN をサポートするネットワーク分離環境にアプリケーションをデプロイ
• ログと監視 - アプリケーションログをストリーミングし、外部サービスに転送
• プラグインエコシステム - コミュニティ製およびカスタムプラグインで機能を拡張

プラグイン開発の詳細については、Developing CLI Plugins をご覧ください。

問題

CLI に直接関連する問題については、GitHub で issue を作成してください。

その他の問題については、サポートチケットを送信してください。

コントリビューター

コマンドのトピック

• heroku access - アプリへのユーザーアクセスを管理します
• heroku accounts - キャッシュ内のHerokuアカウントを一覧表示します
• heroku addons - アプリの開発、拡張、運用のためのツールとサービス
• heroku apps - Heroku上のアプリを管理します
• heroku auth - Herokuアカウントの認証を管理します
• heroku authorizations - OAuth認可
• heroku autocomplete - オートコンプリートのインストール手順を表示します
• heroku buildpacks - アプリのコンパイルに使用するスクリプト
• heroku certs - SSL証明書
• heroku ci - Heroku Pipelines用のテストランナー
• heroku clients - プラットフォーム上のOAuthクライアント
• heroku config - アプリの環境変数
• heroku container - DockerベースのアプリをHerokuにデプロイします
• heroku data - アプリのデータアドオンのメンテナンスを一覧表示します
• heroku domains - アプリのカスタムドメイン
• heroku drains - ログをsyslogまたはHTTPSに転送します
• heroku features - アプリの機能を追加／削除します
• heroku git - gitリモートを設定し、Herokuリポジトリをクローンします
• heroku help - herokuのヘルプを表示します。
• heroku keys - アカウントのSSHキーを追加／削除します
• heroku labs - 実験的な機能を追加／削除します
• heroku local - Herokuアプリをローカルで実行します
• heroku logs - 最近のログ出力を表示します
• heroku maintenance - アプリへのアクセスを有効／無効にします
• heroku mcp - HerokuプラットフォームのMCPサーバーをstdioモードで起動します
• heroku members - 組織のメンバーを管理します
• heroku notifications - 通知を表示します
• heroku orgs - 組織を管理します
• heroku pg - postgresqlデータベースを管理します
• heroku pipelines - パイプラインを管理します
• heroku plugins - インストール済みのプラグインを一覧表示します。
• heroku ps - アプリのdynoを管理します
• heroku redis - heroku redisインスタンスを管理します
• heroku regions - デプロイ可能なリージョンを一覧表示します
• heroku releases - アプリのリリースを表示します
• heroku repl - Heroku CLIコマンドを実行する対話型REPLセッションを開始します
• heroku reviewapps - パイプライン内のreviewappsを管理します
• heroku run - Heroku dyno内でワンオフプロセスを実行します
• heroku search - コマンドを検索します。
• heroku sessions - OAuthセッション
• heroku spaces - 利用可能なスペースを一覧表示します
• heroku status - Herokuプラットフォームの現在のステータスを表示します
• heroku teams - チームを管理します
• heroku telemetry - テレメトリドレインを一覧表示します
• heroku update - Heroku CLIを更新します
• heroku usage - チーム内のアプリに関連付けられた従量制アドオンの使用状況を一覧表示します
• heroku version - 特定のCLIバージョンの変更履歴情報を表示します
• heroku webhooks - アプリのWebhookを一覧表示します

開発

リポジトリをクローンした後

1. npm installを実行して依存関係をインストールします
2. npm run buildを実行してCLIをビルドします。変更をローカルでテストする場合は、変更のたびに再実行する必要があります。

Heroku CLIコマンドをローカルで実行するには、./bin/run <command>を使用します。たとえば、ローカルのコードでheroku appsコマンドを実行するには、ルートディレクトリから./bin/run appsを実行します。

テスト

すべてのテストを実行するには、npm testを実行します。

デバッグ

WebStorm（JetBrains / IntelliJ 製）を使用すると、個別のテストケースを実行／デバッグできます。

• 新しい実行／デバッグ構成を作成します
• 「Mocha」タイプを選択します

貢献

貢献ガイドラインとPR テンプレートをご確認ください。