コンテンツにスキップ

Build CLIコマンドリファレンス

Build CLIのコマンドは、操作対象のリソースごとにグループ分けされています。このページでは、利用可能なコマンドを掲載しています。インストールと認証の手順については、コマンドラインインターフェース(CLI)を参照してください。

次のオプションは、どのコマンドでも指定できます。

フラグ説明
-h, --help指定したコマンドのヘルプを表示
-q, --quietメッセージを出力しない
-V, --versionCLIのバージョンを表示
--ansi / --no-ansiANSI出力を強制的に有効化(または無効化)
-n, --no-interaction対話的な質問をしない
-v, -vv, -vvv, --verbose出力の詳細度を上げる(通常・詳細・デバッグ)

コマンドのヘルプは--helpフラグで表示できます:

bld apps:create --help

helpコマンドでも表示できます:

bld help apps:create
コマンド説明
bld loginBuild.ioアカウントにログイン(ブラウザベースのOAuth)
bld oidc-loginOIDCでBuild.ioのクラスターにログイン(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を取得(複数指定可)
bld config:set <KEY=VALUE...>Config Varを設定(パイプ入力時はSTDINから読み込み)
bld config:unset <KEY...>指定したConfig Varを解除(複数指定可)

config:listとconfig:getでは、-sでシェル形式(KEY=value)、-jでJSON形式に出力を切り替えられます。config:setとconfig:unsetでは、-a APPの代わりに-e ENV-IDを指定すると、パイプラインの環境を対象にできます。

コマンド説明
bld buildpacks:list (buildpacks)アプリに設定されたビルドパックを適用順に一覧表示
bld buildpacks:add <buildpack>ビルドパックを末尾に追加(-iで挿入位置を指定)
bld buildpacks:set <buildpack>先頭のビルドパックを置き換え(-iで位置を指定)
bld buildpacks:remove [buildpack]名前・URLまたは-iの位置指定で削除
bld buildpacks:clearアプリからすべてのビルドパックを削除
コマンド説明
bld builds:list (builds)アプリのビルドを新しい順に一覧表示(--numでページサイズ、--allでページネーションを最後まで辿る)
bld builds:info <build-id>ビルドの詳細を表示:状態、ソースバージョン、説明、スタック、buildpack
コマンド説明
bld deployments:list (deployments, releases)アプリのデプロイメントを新しい順に一覧表示。*が現在のデプロイメントを示す(--num、--all)
bld deployments:info <deployment-id> (releases:info)デプロイメントの詳細を表示:バージョン、状態、現在かどうか、元になったビルド
コマンド説明
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利用できるアドオンサービスを一覧表示
bld addons:plans <service>アドオンサービスのプランを一覧表示
bld addons:create <service:plan>アプリにアドオンをプロビジョニング
bld addons:list (addons)アプリまたはチームにプロビジョニング済みのアドオンを一覧表示
bld addons:info <addon>プロビジョニング済みアドオンの詳細を表示
bld addons:attach <addon>既存のアドオンを別のアプリにアタッチ
bld addons:detach <attachment>アプリからアドオンをデタッチ
bld addons:destroy <addon>アドオンを完全に削除

全カタログと利用例はbuild.io/add-onsを参照してください。