Bitrise RDE CLI
Bitrise RDE CLI を使うと、ターミナルから Remote Dev Environments を管理できます。セッションの作成と接続、セッション内でのコマンド実行、ファイル転送、AIコーディングエージェントの起動が可能です。CLIはオープンソースで、すべての RDE コマンドは bitrise-cli rde の下にあります。
すぐに使い始めたい場合は、クイックスタートに従ってください。このページでは、CLIでできることを幅広くまとめたリファレンスを紹介します。
CLIのインストールClick to copy link
インストールスクリプトで latest version をインストールします。
curl -fsSL https://app.bitrise.io/cli/install.sh | bash
これにより、bitrise-cli バイナリが ~/.local/bin にインストールされます。このディレクトリが PATH に含まれていることを確認してください。GitHub のリリースからビルドをダウンロードするか、go install github.com/bitrise-io/bitrise-cli@latest でソースからインストールすることもできます。
サインインClick to copy link
Bitrise アカウントにサインインします。ブラウザーが開き、認証を行います。
bitrise-cli auth login
ステータスは bitrise-cli auth status で確認でき、サインアウトは bitrise-cli auth logout で行います。CIなどの非対話的な利用では、BITRISE_TOKEN 環境変数にパーソナルアクセストークンを設定するか、bitrise-cli auth login --with-token にトークンをパイプで渡してください。
workspaceの選択Click to copy link
RDE コマンドは workspaceに対して実行されます。所属しているのが 1 つだけの場合は、CLIが自動的にそれを選択します。複数に所属している場合は、CLIが選択を求めます。プロンプトを省略するには、デフォルトを保存します。
bitrise-cli config set default_workspace_id WORKSPACE_ID
1 つのコマンドだけに適用する場合は、--workspace フラグが最優先され、次に BITRISE_WORKSPACE_ID 環境変数、最後に保存したデフォルトの順に適用されます。
セッションの管理Click to copy link
bitrise-cli rde sessionコマンドを使うと、セッションの作成から削除までを管理できます。SESSION_IDを受け取るコマンドは、名前が一意であれば、セッションの名前も指定できます。
| コマンド | 機能 |
|---|---|
bitrise-cli rde session create NAME | --templateからセッションを作成します。テンプレートなしで作成するには、--stackと--machine-typeを指定します。--device-platform iosまたはandroidを追加すると、仮想デバイスも一緒に起動します。--waitを追加すると、セッション、そのセットアップ、デバイスの準備が完了するまで待機します。 |
bitrise-cli rde session list | 自分のセッションとそのステータスを一覧表示します。 |
bitrise-cli rde session view SESSION_ID | 接続用の認証情報を含む、セッションの詳細を表示します。 |
bitrise-cli rde session update SESSION_ID | セッションの名前や説明を変更したり、自動終了タイマーを調整し たりします。 |
bitrise-cli rde session exec SESSION_ID -- COMMAND | SSHを介して、セッションでコマンドを実行します。セッションでのコマンドの実行を参照してください。 |
bitrise-cli rde session upload SESSION_ID LOCAL_PATH REMOTE_FOLDER | ファイルまたはフォルダーをセッションにアップロードします。 |
bitrise-cli rde session download SESSION_ID REMOTE_PATH LOCAL_PATH | セッションからファイルまたはフォルダーをダウンロードします。 |
bitrise-cli rde session ssh SESSION_ID | セッションのSSHコマンドとパスワードを出力します。scp用、またはデバイスセッションのポートをトンネリングする際に使用します。 |
bitrise-cli rde session vnc SESSION_ID | セッションのVNC接続の詳細を出力します。--forwardを使うと、ローカルポートにトンネリングします(macOSのみ)。 |
bitrise-cli rde session open-vnc SESSION_ID | セッションのデスクトップを、デフォルトのVNCビューアーで開きます(macOSのみ)。 |
bitrise-cli rde session logs SESSION_ID --stage on-create | セッションのセットアップのログを出力します。ライフサイクルフックにはon-create、on-claim、on-restore、personalize、ウォームアップスクリプトと起動スクリプトを持つテンプレートにはwarmupまたはstartupを使用します。--followを追加するとリアルタイムでストリーミングし、--attempt 2を追加するとフックの2回目の実行のみを表示します。 |
bitrise-cli rde session run-hook SESSION_ID --hook on_claim | 失敗した On claim、On restore、またはSystem setup(personalize)を、同じマシンで再実行します。 |
bitrise-cli rde session rebuild SESSION_ID | セッションのマシンを入れ替え、On create からセットアップを再実行します。 |
bitrise-cli rde session notifications SESSION_ID | エージェントの停止や権限のプロンプトなど、セッションが発行したイベントを一覧表示します。 |
bitrise-cli rde session diff SESSION_ID | セッションの作成後に、そのテンプレートがどのように変更されたかを表示します。 |
bitrise-cli rde session terminate SESSION_ID | マシンを停止し、セッションは後のために保持します。 |
bitrise-cli rde session restore SESSION_ID | 終了したセッションを、永続ディスクから再起動します。--waitを追加すると、実行中になるまで待機します。 |
bitrise-cli rde session delete SESSION_ID | 終了したセッションを完全に削除します。 |
bitrise-cli rde session delete-terminated | workspace内の、終了したすべてのセッションを完全に削除します。 |
セッション内でのコマンド実行Click to copy link
bitrise-cli rde session exec は、インタラクティブシ ェルを開かずに、セッション内で 1 つのコマンドを実行し、その出力をストリーミングで返します。セッションのスクリプト化や、AIエージェントによるセッション操作の基本となる機能です。
bitrise-cli rde session exec SESSION_ID -- npm test
コマンドはログインシェルで実行されるため、セッションの PATH、Homebrew パッケージ、言語バージョンマネージャーをすべて利用できます。ローカルで SSH エージェントが動作している場合、CLI がそれをセッションに転送するため、セッション内での SSH 経由の Git ではローカルのキーが使われます。
-- 以降のすべては、リテラルの引数を持つプログラムとして渡されます。パイプ、&&、リダイレクトを使うには、--shell を追加し、コマンドを引用符で囲んでください。
bitrise-cli rde session exec SESSION_ID --shell -- 'cd my-app && xcodebuild | xcpretty'
よく使うフラグは次のとおりです。
--timeout: リモートコマンドは、デフォルトで 10 分後に停止されます。長時間のビルド (--timeout 30m) では上限を引き上げるか、--timeout 0で無効にします。--env: ローカルの環境変数をリモートコマンドに転送するか(--env NPM_TOKEN)、リテラル値を設定します(--env CI=1)。転送された値はローカルには表示されませんが、コマンドの実行中はセッションのプロセス一覧で確認できます。--output json: 終了コード、stdout、stderr を含む単一の JSON オブジェクトを出力します。スクリプトやエージェントから簡単に解析できます。
転送する environment variables のリストをチームと共有するには、リポジトリ内の .bitrise/rde.yml に追加します。
exec:
env:
- API_BASE_URL
- NPM_TOKEN=abc123
exec コマンドは、作業ディレクトリまたは任意の親フォルダーからこのファイルを読み込み、実行のたびに、記載された変数を転送します。--env は同名のエントリを上書きし、--no-env-file はファイルを完全にスキップします。
AIコーディングエージェントの実行Click to copy link
bitrise-cli rde claude コマンドは、セッションを作成し、現在のリポジトリのブランチをセッションにクローンして、クラウドマシン上で動作する Claude Code に接続します。エージェントの作業中は、CLI が安全な接続を維持するため、VNC ビューアーを開いたり、ローカルマシンとの間でファイルを転送したりできます。
これが推奨される開始方法です。詳しい手順については、クイックスタートを参照してください。知っておくと便利な動作は次のとおりです。
- CLI はスタックとマシンタイプの選択を求め、リポジトリごとに選択内容を記憶します。スクリプトなどでプロンプトを省略するには、
--stackと--machine-typeを指定します。 - workspace に Claude Code の認証情報がまだ保存されていない場合、CLI はローカルの認証情報を取得するか、ブラウザーを開いて作成できるようにし、今後のセッション用に保存します。この認証情報は、Bitrise RDE UIでも管理できます。
- 接続が切断された場合、CLI は自動的に再接続し、Claude Code はセッション内で実行され続けます。再接続中に Ctrl-C を押すと、切り離してマシンを実行したままにできます。
- Claude Code を終了すると、セッションは自動的に終了されますが、後で復元できるよう保持されます。
セッションに戻るには、直近のセッションには bitrise-cli rde claude --continue を、一覧から選ぶには bitrise-cli rde claude --resume を使用します。再開すると、実行中のセッションに再接続するか、終了したセッションを復元して、同じ Claude Code の会話を続行します。
仮想デバイスClick to copy link
CLI は、仮想デバイスを使う両方の方法をカバーしています。
bitrise-cli rde session create NAME --device-platform ios|android: デバイスセッションを作成します。--device-model、--device-os-version、--device-system-image、--artifact-url-stdinフラグで、デバイスとインストールするアプリを指定します。bitrise-cli rde device-guide [ios|android]: デバイスの待機、接続、操作に関するガイドを表示します。bitrise-cli rde preview-link create --device-platform ios|android --artifact-url URL: デバイスプレビューリンクを発行します。
Warm poolsClick to copy link
bitrise-cli rde warm-poolはwarm poolsを管理し、セッションコマンドとプレビューリンクコマンドは、そこから割り当てを行います。WARM_POOL_IDを受け取るコマンドは、プールの名前も指定できます。
| コマンド | 機能 |
|---|---|
bitrise-cli rde warm-pool create NAME --template TEMPLATE --size N | プールを作成します。テンプレートの入力には--inputと--secret-inputを追加し、テンプレートを上書きするには--stack、--machine-type、--device-*フラグを使用します。 |
bitrise-cli rde warm-pool list | workspaceのプールを、サイズと準備ができているセッションの数とともに一覧表示します。--allは、同じプールの読み取り専用のコスト表示で、workspaceのオーナーと、課 金を管理するメンバー向けです。 |
bitrise-cli rde warm-pool view WARM_POOL_ID | プールのステータス、設定、ウォームセッションを表示します。 |
bitrise-cli rde warm-pool set-size WARM_POOL_ID N | プールが起動した状態で保持するセッションの数を変更します。0は、設定は保持したまま、プールを空にします。 |
bitrise-cli rde warm-pool update WARM_POOL_ID | プールの名前を変更したり、設定を変更したりします。設定を変更すると、ウォームセッションが置き換えられます。 |
bitrise-cli rde warm-pool delete WARM_POOL_ID | プールとそのウォームセッションを削除します。 |
bitrise-cli rde warm-pool retry WARM_POOL_ID | On create が3回連続で失敗した後に、プールのウォームアップを再開します。 |
bitrise-cli rde session create NAME --warm-pool WARM_POOL_ID | プールからセッションを割り当てます。 |
bitrise-cli rde preview-link create --warm-pool WARM_POOL_ID --artifact-url URL | リンクを開いたときにwarm poolから提供される、デバイスプレビューリンクを発行します。 |
テンプレート、保存済み入力、マシンオプションClick to copy link
CLI は、セッションの基盤となる設定オブジェクトも管理します。
bitrise-cli rde template: テンプレートを一覧表示、作成、表示、更新、削除します。bitrise-cli rde saved-input: 保存済み入力を一覧表示、作成、表示、更新、削除します。bitrise-cli rde stack list: workspace で利用可能なスタックを一覧表示します。bitrise-cli rde machine-type list --stack STACK_ID: 指定したスタックと互換性のあるマシンタイプを一覧表示します。
Workspace の使用状況Click to copy link
Workspace のオーナーと、請求を管理するメンバーは、workspace のアクティブなセッションが消費しているリソースを確認できます。
bitrise-cli rde usage
このレポートは、ある時点のスナップショットです。OS ごとに分けたアクティブなセッション数と vCPU およびメモリの合計に加え、ユーザーごとの内訳が含まれます。スクリプトや自動化で使える機械可読版が必要な場合は、--output json を追加します。
コマンドリファレンス全体Click to copy link
すべてのコマンドには詳細な組み込みヘルプがあり、人間と AIエージェントの両方がそこから機能を把握できるように書かれています。ヘルプは機能の更新と同時に更新されるため、最新のリファレンスです。
bitrise-cli rde --help
bitrise-cli rde session exec --help
すべてのコマンド、フラグ、引数を網羅した自動生成リファレンスは、オープンソースのリポジトリにあります: bitrise-io/bitrise-cli。