DevTools コマンドライン (IBConsole)
Incredibuild のインストール フォルダ内の「IBConsole.exe」はパラメーターに応じて、様々な動作モードで Incredibuild を設定できるコンソール アプリケーションです。ここでは、コマンドの構文規則やパラメーターについて解説しています。
コマンドラインの構文規則
インターセプション インターフェイスを使ってジョブを実行する際の基本的なコマンドラインは次の通りです。
IBConsole.exe /command="<TOOL COMMAND>" /profile="<PROFILE XML>" [Command Line Options]
注意 「IBConsole」の以前の名称は「xgConsole」です。このコマンドも、同じ構文で引き続きサポートされています。
使い方
IBConsole.exe を実行する際は次のコマンドを入力します。
IBConsole.exe /COMMAND="<job command line>" [options]または
IBConsole.exe <Target> [Options]
コマンドの詳細:
-
/COMMAND: サブミッション インターフェイスとインターセプション インターフェイスを組み合わせて使用するために任意のコマンドラインを指定できます。
-
<Target> には以下のいずれかを指定します。- 分散ジョブを定義する .xml/.xpx ファイルへのパス (XML Interface と組み合わせて使用) - .bat ファイルへのパス (Submission Interface または Automatic Interception Interface と組み合わせて使用)
DevTools で IBConsole を使用する場合は、高速化したいソフトウェアやスクリプトと Incredibuild を連携するために、Incredibuild のいずれかのインターフェイスを使用する必要があります。
注意:
-
IBConsole を実行した際に「IBConsole' is not recognized as an internal or external command, operable program or batch file.」というエラーが表示された場合は、手動で Incredibuild インストール フォルダをシステムパスに追加するか、Incredibuild セットアップ アプリをマシンで実行して [Add Incredibuild folder to system path] オプションを選択してください。
コマンドライン オプション
| オプション | 機能 | 備考 |
|---|---|---|
| @ | IBConsole のコマンドラインが含まれる応答ファイルを指定します。 | IBConsole を実行するためのコマンドラインが長すぎて、スクリプトで明示的に指定できない場合に使用します。 |
| /Attach | 現在または直近のビルドの出力を表示します。 | ビルド中の場合は、現時点までのプロセスの出力を表示し、ビルドが終了するまで表示し続けます。ビルドを実行していない場合は、当該マシンで開始した最後のビルドの出力をすべて表示します。 |
| /AvoidLocal=[On/Off] | [Avoid task execution on local machine when possible] オプション (Agent Settings) を上書きします。 | 値 (ON / OFF) が必須です。 |
| /Beep | プロセスの完了を通知音で知らせます。 | |
| /Disable | Agent を Helper としてビルドに参加させません。 | |
| /Enable | Agent を Helper としてビルドに参加させます。 | |
| /Help | 使い方のヘルプやバージョン情報を表示します。 | |
| /Log[=filename] | プロセスの出力をファイルに書き込みます。 | filename を指定しない場合は「IB_<target-name>.log」という名前のファイルがカレント ディレクトリに作成されます。 |
| /LogLevel="<Level>" | このビルドのログレベルを上書きします。 | <Level> には「Minimal」「Basic」「Intermediate」「Extended」「Detailed」のいずれかを入力します。 |
| /MaxCPUS=<n> | ビルド設定の最大 CPU / コア数を上書きします。 | |
| /MaxWinVer="<Version>" | ビルドに参加できるリモート Agent の OS (最新のバージョン) を指定します。 | これより新しい OS を搭載した Agent はビルドに参加できません。「XP」「2003」「VISTA」「2008」「7」「8」「10」を設定できます。 |
| /MinWinVer="<Version>" | ビルドに参加できるリモート Agent の OS (最古のバージョン) を指定します。 | これより古い OS を搭載した Agent はビルドに参加できません。「XP」「2003」「VISTA」「2008」「7」「8」「10」を設定できます。 |
| /Mon[=filename] | ビルド プログレス (.ib_mon) ファイルのコピーの保存場所を指定します。 |
フォルダ名のみ指定した場合は該当ファイル名の GUID が生成されます。 .ib_mon ファイルの保存場所がプロセスの出力の最後に追加されます。 |
| /NO_DOTNET_VIRT | Helper マシン上の .NET 環境の仮想化を無効にします。 | このオプションを指定すると、Initiator マシンの .NET 環境を Helper マシンに仮想化しません。様々な OS が混在する環境で .NET の互換性がない場合に使用します。 |
| /NoLogo | ビルド出力の「Incredibuild」ヘッダーを非表示にします。 | |
| /NoWait | この Agent が開始した別のプロセスが実行中の場合、IBConsole は「Another build already running」というメッセージを表示して終了します。 | |
| /OpenMonitor | プロセスの進行状況を表示するビルドモニター画面を開きます。 | |
| /out=filename | コマンドラインの全出力をファイルにリダイレクトします。 | |
| /QueryLicense | 有効なライセンス、割り当て済みのパッケージ、メンテナンスの有効期限などの情報を表示します。 | |
| /QueryPackage="<Package>" | 特定の Incredibuild 拡張パッケージが Agent に割り当てられているかどうかを確認して、終了コードとして「0」(割り当て済み) または「1」(未割り当て) を返します。 | <Package> には「VC」「C#」「BuildTools」「DevToolAcc」「XGE」「Xbox One」「PlayStation」「Cafe」「3DS」「KlocWorkPro」「Coverity」のソリューション パッケージまたは、「4Cores」「8Cores」「12Cores」「16Cores」「24Cores」「32Cores」「48Cores」「64Cores」のコア パッケージを指定します。 |
| /Reset | Agent のファイルのキャッシュを消去します。 | |
| /SetEnv="<name>=<value>" | コマンド実行のコンテキストに合わせて環境変数を設定または上書きします。 | 複数の変数を設定 / 上書きしたい場合は複数回指定します。 |
| /ShowAgent | タスクの実行で使用した Agent を出力ファイルに表示します。 | |
| /ShowCmd | タスクの実行で使用したコマンドラインを表示します。 | XML インターフェイスのみ。 |
| /ShowTime | タスクの開始時刻と終了時刻を出力ファイルに表示します。 | |
| /Silent | 標準出力に何も書き込みません。 | デフォルトではビルドモニターの出力ディスプレイの通りにビルド結果を書き込みます。 |
| /Stop[=<build-id>] | ローカルマシンで実行中のビルドを停止します。複数のビルドを実行している場合は <build-id> を指定します。 | ビルドが停止すると IBConsole はコード「3」を返します。ビルドが実行されていない場合はコード「2」を返します。 |
| /StopOnErrors | 有効にするとエラーが発生した時点でビルドを停止します。 | |
|
/StopAll |
実行中のビルドをすべて停止します。 |
|
| /Title=<build title> | 実行の出力をテキスト表示する際にテキストの先頭に表示するカスタム ヘッダーを設定します。ここで設定した文字列が実行履歴と実行モニターにも表示されます。 | 値を引用符 (”) で囲みます。 |
| /UseIDEMonitor | このオプションを指定して Visual Studio IDE から IBConsole を実行すると、VS の実行モニターに処理の進行況が表示されます。 | |
| /wait | この Agent が開始した別のプロセスが実行中の場合、終了を待って新しいプロセスを開始します。これはデフォルトの動作です。 |
リターンコード
IBConsole は次のリターン コードを返します。
「0」: エラーは発生しませんでした。「1」: 実行中にエラーが発生しました。「2」: 致命的なエラーが発生しました (パラメーターが無効、入力ファイルが見つからないなど)。「3」: 完了前に実行を停止しました。
注意:
-
1 台のマシン上で一度に 1 つの IBConsole しか実行できないため、実行中のビルドがある場合は、ビルドが完了してから次のビルド開始まで一時停止が発生します。
インターフェイス別の使用方法と使用例
IBConsole.exe を使って各種インターフェイスを使用する方法や使用例は次のページをご覧ください。