Build CLIは、管理するリソースに基づいてコマンドをグループに整理しています。このページでは利用可能なすべてのコマンドをリファレンスとして掲載しています。インストールと認証についてはコマンドラインインターフェース(CLI)を参照してください。
これらのオプションはすべてのコマンドで使用できます:
| フラグ | 説明 |
|---|
-h, --help | 指定したコマンドのヘルプを表示 |
-q, --quiet | メッセージを出力しない |
-V, --version | CLIのバージョンを表示 |
--ansi / --no-ansi | ANSI出力を強制(または無効化) |
-n, --no-interaction | 対話的な質問を行わない |
-v, -vv, -vvv, --verbose | 詳細度を上げる(通常・詳細・デバッグ) |
コマンドのヘルプを表示するには、--helpフラグを使用します:
またはhelpコマンドを使用します:
| コマンド | 説明 |
|---|
bld login | Buildアカウントにログイン(ブラウザベースのOAuth) |
bld oidc-login | OIDC経由でBuildクラスターにログイン(SSO、クラスターアクセス) |
bld whoami (me) | 現在ログインしているユーザーを表示 |
bld logs (log) | アプリケーションのログを表示 |
bld run | 一時的なdynoでワンオフコマンドを実行 |
bld list | 利用可能なコマンドを一覧表示 |
bld help | コマンドのヘルプを表示 |
bld completion | シェル補完スクリプトを出力 |
| コマンド | 説明 |
|---|
bld apps:create <name> | 新しいアプリケーションを作成(-t チーム、-r リージョン) |
bld apps:list (apps) | アクセス可能なアプリを一覧表示(-t チーム) |
bld apps:info [app] | 特定のアプリケーションの詳細を表示 |
bld apps:stacks (stack) | アプリの現在のスタックを表示 |
bld apps:stacks:set <stack> | アプリのビルドスタックを設定(例:heroku-24) |
| コマンド | 説明 |
|---|
bld config:list (config) | アプリまたは環境のすべてのConfig Varを一覧表示 |
bld config:get <KEY...> | 特定のConfig Varを1つ以上取得 |
bld config:set <KEY=VALUE...> | Config Varを設定。パイプで渡された場合はSTDINから読み込む |
bld config:unset <KEY...> | Config Varを1つ以上解除 |
config:listとconfig:getは、シェル形式(KEY=value)で出力する-sと、JSON形式で出力する-jをサポートしています。config:setとconfig:unsetはどちらも、-a APPの代わりにパイプライン環境を指定する-e ENV-IDを受け付けます。
| コマンド | 説明 |
|---|
bld buildpacks:list (buildpacks) | アプリに設定されたbuildpackを順番に一覧表示 |
bld buildpacks:add <buildpack> | buildpackを追加(-iで挿入位置を指定) |
bld buildpacks:set <buildpack> | 最初のbuildpackを置き換え(または-iでインデックス指定) |
bld buildpacks:remove [buildpack] | 名前/URLまたは-iインデックスで削除 |
bld buildpacks:clear | アプリからすべてのbuildpackを削除 |
| コマンド | 説明 |
|---|
bld ps:list (ps, ps:ls) | 実行中のプロセスとその状態/サイズを一覧表示 |
bld ps:scale <TYPE=QTY[:SIZE]...> | プロセス数および/またはdynoサイズをスケール |
bld ps:restart [process] | すべてのプロセス、または特定のプロセスタイプを再起動 |
bld ps:exec | 実行中のdyno内でコマンドを実行(-d dyno、-s ステータス) |
| コマンド | 説明 |
|---|
bld domains | アプリのすべてのドメイン(プラットフォーム+カスタム)を一覧表示 |
bld domains:add <hostname> | カスタムドメインを追加(-wでアクティブになるまで待機) |
bld domains:info <hostname> | ドメインの詳細なステータスを表示 |
bld domains:update <hostname> | ドメインのSSL証明書を更新 |
bld domains:wait <hostname> | ドメインのプロビジョニング完了を待機 |
bld domains:remove <hostname> | カスタムドメインを削除 |
bld domains:clear | アプリからすべてのカスタムドメインを削除 |
| コマンド | 説明 |
|---|
bld namespaces:list (namespaces) | メンバーまたは所有しているネームスペースを一覧表示(-t チーム) |
bld namespaces:create <name> | ネームスペースを作成(-t チーム、-r リージョン、-z ゾーン) |
bld namespaces:info [namespace] | ネームスペースの詳細を表示 |
bld namespaces:delete <namespace> | ネームスペースを削除 |
詳しい使い方はネームスペースを参照してください。
| コマンド | 説明 |
|---|
bld teams:list (teams) | メンバーまたは所有しているチームを一覧表示 |
bld teams:info [team] | チームの詳細を表示 |
| コマンド | 説明 |
|---|
bld pipelines:list (pipelines) | アクセス可能なパイプラインを一覧表示(-t チーム) |
bld pipelines:info <pipeline> | パイプラインの詳細情報を表示 |
bld pipelines:diff | 起点となるアプリの最新リリースと下流(ステージング→本番などの後段)のアプリを比較 |
bld pipelines:promote | 起点となるアプリの最新リリースを下流のアプリにプロモート(--to、--no-wait) |
| コマンド | 説明 |
|---|
bld addons:services | 利用可能なadd-onサービスを一覧表示 |
bld addons:plans <service> | add-onサービスのプランを一覧表示 |
bld addons:create <service:plan> | アプリ用にadd-onをプロビジョニング |
bld addons:list (addons) | アプリまたはチームにプロビジョニングされたadd-onを一覧表示 |
bld addons:info <addon> | プロビジョニングされたadd-onの詳細を表示 |
bld addons:attach <addon> | 既存のadd-onを別のアプリにアタッチ |
bld addons:detach <attachment> | アプリからadd-onをデタッチ |
bld addons:destroy <addon> | add-onを完全に削除 |
全カタログと利用例はbuild.io/add-onsを参照してください。