メインコンテンツまでスキップ

Bitrise CLIによるbitrise.ioのビルド管理

bitrise buildコマンドは、bitrise.io上でビルドをトリガーし、完了するまで追跡します。ビルドの一覧表示、詳細の確認、中止もできます。お使いのコンピューター、スクリプト、他のビルドの内部から利用できます。

ローカルビルドを実行するには、最初のローカルビルドの実行: CLIを参照してください。

Bitrise CLI 3.0.0以降

bitrise buildコマンドには、Bitrise CLI 3.0.0以降とアクセストークンが必要です。認証: Bitrise CLIを参照してください。

すべてのコマンドは1つのprojectに対して実行されます。--appで指定するか、デフォルトを保存してください。選択: Workspaceとプロジェクトを参照してください。このページの例では、毎回--appを指定しています。

コマンドリファレンスClick to copy link​

コマンド機能プロジェクトのチームで必要なロール
bitrise build trigger新しいビルドをトリガーします。Owner、Admin、またはDeveloper
bitrise build watchビルドが完了するまで追跡します。Developer
bitrise build listプロジェクトのビルドを一覧表示します。Tester/QA
bitrise build viewビルドの詳細を表示します。Tester/QA
bitrise build logビルドのログを出力します。Developer
bitrise build ymlビルドの実行時に使われたbitrise.ymlを出力します。Developer
bitrise build abort実行中またはキュー内のビルドを中止します。Owner、Admin、またはDeveloper

ロールの一覧については、ロールと権限: Bitrise CIを参照してください。

ビルドのトリガーClick to copy link​

bitrise build triggerは、新しいビルドを開始してその詳細を出力します。

bitrise build trigger --app my-app-id --workflow primary

実行する対象は、--workflowとWorkflowのID、または--pipelineとPipelineのIDで選択します。両方は使用できません。どちらも指定しない場合、Bitriseは、Webhookによるビルドと同様に、プロジェクトのtriggersからWorkflowまたはPipelineを選択します。ビルドトリガーのYAML構文を参照してください。

ブランチ、コミット、タグの設定Click to copy link​

ビルドするコードは、次のフラグで選択します。

フラグ設定内容
--branchビルドするブランチ。ブランチ、タグ、コミットハッシュのいずれも設定しない場合、CLIはmainをビルドします。
--commit-hashビルドする特定のコミット。
--tagビルドするGitタグ。
--commit-messageビルドに表示するコミットメッセージ。
bitrise build trigger --app my-app-id --workflow deploy --branch release/1.2
bitrise build trigger --app my-app-id --workflow primary --tag v1.2.3

--commit-hash、--tag、--branchを複数設定した場合、Git Clone Stepは最も具体的なものをチェックアウトします。優先順位は、コミット、タグ、ブランチの順です。

pull requestビルドのパラメーター設定Click to copy link​

pull requestをビルドするには、--branchでsource branch、--branch-destでターゲットブランチ、--pull-request-idで番号を設定します。

bitrise build trigger --app my-app-id --workflow primary --branch my-feature --branch-dest main --pull-request-id 42

Environment Variablesと優先度の設定Click to copy link​

--envを使用して、追加のEnvironment VariablesをJSONオブジェクトとしてビルドに渡します。

bitrise build trigger --app my-app-id --workflow primary --env '{"MY_VAR":"hello","OTHER":"world"}'

これらの変数はSecretsを上書きできますが、設定で定義されたEnvironment Variablesは上書きできません。

Bitriseは、値の中の$VAR参照を展開します。値をそのまま渡すには、"is_expand": falseを持つオブジェクトとして指定します。これは、ビルドを手動で開始する際にReplace variables in inputのチェックを外すことに相当します。

bitrise build trigger --app my-app-id --workflow primary --env '{"API_URL":"https://staging.example.com","PRICE":{"value":"$5","is_expand":false}}'

キュー内のビルドの位置は、-100から100の範囲で--priorityを使って設定します。この値は、bitrise.ymlおよびトリガーで設定された優先度を上書きします。値が0の場合も同様です。それらの設定を維持するには、このフラグを省略してください。Build priorityを参照してください。

bitrise build trigger --app my-app-id --pipeline my-pipeline --priority 0

スタック、マシンタイプ、ライセンスプールの設定Click to copy link​

ビルドを実行する場所と方法は、次のフラグで上書きします。

フラグ設定内容
--stackビルドを実行するstackのID(例: osx-xcode-16.0.x)。Workflowのスタックを上書きします。ビルドのスタックの設定を参照してください。
--machine-typeビルドを実行するマシンタイプのID(例: g2-m1.4core)。Workflowのマシンタイプを上書きします。Build machineのタイプを参照してください。
--license-poolビルドの実行に使用するライセンスプールのID。
bitrise build trigger --app my-app-id --workflow primary --stack osx-xcode-16.0.x --machine-type g2-m1.4core

ビルドの完了待ちClick to copy link​

デフォルトでは、Bitriseがビルドを受け付けると、bitrise build triggerはすぐに戻ります。ビルドの結果を待つには、次のいずれかのフラグを追加します。

フラグ待機中にCLIが表示する内容
--wait何も表示しません。
--watchビルドの進行状況。インタラクティブなターミナルではステータス表示、それ以外ではプレーンテキストのビルドログです。
bitrise build trigger --app my-app-id --workflow primary --watch

どちらのフラグを使っても、CLIは、ビルドが成功した場合または成功として中止された場合は終了コード0で、それ以外の場合は終了コード1で終了します。これにより、スクリプトや別のビルドは、トリガーしたビルドが失敗した時点で停止できます。

すでに実行中のビルドを追跡するには、ビルドのIDを指定してbitrise build watchを使用します。

bitrise build watch abc123 --app my-app-id

--watchと同様に動作し、同じ終了コードで終了します。

CLIがビルドを待機する場合は、次のとおりです。

  • --format jsonまたは--format ymlを使用すると、ビルドの完了時に、CLIがビルドの最終的な詳細を標準出力に書き込みます。--watchとbitrise build watchは、ビルドログを標準エラー出力(stderr)に出力するため、結果を別のツールにパイプで渡すこともできます。
  • --intervalは、CLIがビルドを確認する間隔を設定します。デフォルトは3sです。
  • Ctrl+Cを押すとCLIは停止しますが、ビルドは停止しません。

ビルドの一覧表示Click to copy link​

bitrise build listは、プロジェクトのビルドを新しい順に一覧表示します。

bitrise build list --app my-app-id

一覧は、次のフラグで絞り込めます。

フラグフィルター
--branchビルドのブランチ。
--workflowビルドのWorkflow。
--statusビルドのステータス: in-progress、success、failed、aborted、またはaborted-with-success。
--trigger-event-typeビルドをトリガーしたもの: push、pull-request、またはtag。
--pull-request-idpull requestの番号。
--build-numberビルド番号。
--commit-messageコミットメッセージ。
--pipeline-buildビルドがPipelineの一部かどうか。
--after、--beforeビルドがトリガーされた日時(RFC 3339タイムスタンプ形式。例: 2026-09-01T00:00:00Z)。

たとえば、mainブランチの失敗したビルドを一覧表示するには、次のようにします。

bitrise build list --app my-app-id --branch main --status failed

実行中のビルドを先頭に表示するには、--sort-by running_firstを追加します。

一覧はページ分割されています。さらに結果を取得するには、--limit、--cursor、--allを使用します。ページネーションを参照してください。

200日間のビルド保持

プロジェクトのBuildsページと同様に、bitrise build listは過去200日間のビルドのみを返します。ビルドのIDがわかっていれば、それより古いビルドも表示できます。

ビルドの表示Click to copy link​

ビルドの詳細を表示するには、そのIDをbitrise build viewに渡します。代わりにビルドのページをブラウザーで開くには、--webを追加します。

bitrise build view abc123 --app my-app-id
bitrise build view abc123 --app my-app-id --web

ビルドログを出力するには、bitrise build logを使用します。ビルドがまだ実行中の場合は、--waitを追加すると、ビルドの完了後にログを出力します。ログはプレーンテキストなので、ファイルに保存できます。

bitrise build log abc123 --app my-app-id --wait > build.log

ビルドの実行時に使われたbitrise.ymlを出力するには、bitrise build ymlを使用します。ビルドの実行後に誰かが変更した場合、このファイルはプロジェクトの現在の設定と異なることがあります。Bitrise CLIによるbitrise.ymlの操作を参照してください。

bitrise build yml abc123 --app my-app-id > bitrise.yml

ビルドの中止Click to copy link​

bitrise build abortは、実行中またはキュー内のビルドを中止します。

bitrise build abort abc123 --app my-app-id --reason "no longer needed"
フラグ動作
--reason中止の理由を記録します。ビルドのページに表示されます。
--abort-with-success中止したビルドを成功として扱います。Gitプロバイダーに送信されるステータスレポートではビルドが成功として表示されますが、BitriseではAborted with successとして表示されます。
--skip-notifications中止したビルドに関する通知を送信しません。
--skip-git-status-report中止をGitプロバイダーに報告しません。