コマンドとオプション

問題を報告 ソースを表示

このページでは、bazel build、bazel run、bazel test などのさまざまな Bazel コマンドで使用できるオプションについて説明します。このページは、Bazel を使用したビルドの Bazel のコマンドのリストに関連するものです。

ターゲットの構文

build や test など、一部のコマンドは、ターゲットのリストで操作できます。ラベルよりも柔軟な構文を使用します。詳細については、ビルドするターゲットの指定をご覧ください。

オプション

以降のセクションでは、ビルドで使用できるオプションについて説明します。ヘルプコマンドで --long を使用すると、オンライン ヘルプ メッセージに、各オプションの意味、タイプ、デフォルト値に関する概要情報が表示されます。

ほとんどのオプションは 1 回だけ指定できます。複数回指定すると、最後のインスタンスが優先されます。複数回指定できるオプションは、オンライン ヘルプに「複数回使用できる」というテキスト付きで示されています。

パッケージの場所

--package_path

このオプションでは、特定のパッケージの BUILD ファイルを見つけるために検索されるディレクトリのセットを指定します。

Bazel は、パッケージパスを検索してパッケージを見つけます。これは bazel ディレクトリをコロンで区切った順序付きリストで、それぞれが部分的なソースツリーのルートです。

--package_path オプションを使用してカスタム パッケージ パスを指定するには:

  % bazel build --package_path %workspace%:/some/other/root

パッケージパス要素は、次の 3 つの形式で指定できます。

  1. 最初の文字が / の場合、パスは絶対パスです。
  2. パスが %workspace% で始まる場合、パスは、最も近い bazel ディレクトリを基準とする相対パスになります。たとえば、作業ディレクトリが /home/bob/clients/bob_client/bazel/foo の場合、package-path の文字列 %workspace% は /home/bob/clients/bob_client/bazel に展開されます。
  3. それ以外はすべて、作業ディレクトリを基準とする相対パスになります。 これは通常、意図したことではないため、bazel ワークスペースの下のディレクトリから Bazel を使用すると、予期しない動作が発生することがあります。たとえば、package-path 要素 . を使用してから cd でディレクトリ /home/bob/clients/bob_client/bazel/foo に移動すると、パッケージは /home/bob/clients/bob_client/bazel/foo ディレクトリから解決されます。

デフォルト以外のパッケージパスを使用する場合は、便宜上 Bazel 構成ファイルで指定します。

Bazel では、現在のディレクトリにパッケージが存在する必要はありません。したがって、必要なすべてのパッケージがパッケージパスの別の場所に存在する場合は、空の bazel ワークスペースからビルドできます。

例: 空のクライアントからのビルド

  % mkdir -p foo/bazel
  % cd foo/bazel
  % touch WORKSPACE
  % bazel build --package_path /some/other/path //foo

--deleted_packages

このオプションでは、Bazel で削除済みと見なし、パッケージパスのディレクトリから読み込まないようにする必要があるパッケージのカンマ区切りのリストを指定します。これを使用すると、パッケージを実際に削除せずに削除をシミュレートできます。このオプションは複数回渡すことができ、その場合は個々のリストが連結されます。

チェックエラー

Bazel によるエラーチェックや警告は、以下のオプションで制御します。

--[no]check_visibility

このオプションを false に設定した場合、公開設定チェックは警告に降格されます。 このオプションのデフォルト値は true であるため、デフォルトで公開設定の確認が行われます。

--output_filter=regex

--output_filter オプションは、正規表現に一致するターゲットに対してのみ、ビルドとコンパイルの警告を表示します。ターゲットが指定された正規表現と一致せず、その実行が成功した場合、その標準出力と標準エラーは破棄されます。

このオプションの一般的な値は次のとおりです。

`--output_filter='^//(first/project|second/project):'` 指定したパッケージの出力を表示します。
`--output_filter='^//((?!(first/bad_project|second/bad_project):).)*$'` 指定したパッケージの出力を表示しません。
`--output_filter=` すべてを表示します。
`--output_filter=DONT_MATCH_ANYTHING` 何も表示しない。

ツールフラグ

これらのオプションは、Bazel が他のツールに渡すオプションを制御します。

--copt=cc-option

このオプションは、コンパイラに渡される引数を取ります。 C、C++、アセンブラ コードの前処理、コンパイル、アセンブルのために呼び出されるたびに、引数がコンパイラに渡されます。リンク時に渡されません。

このオプションは複数回使用できます。例:

  % bazel build --copt="-g0" --copt="-fpic" //foo

は、デバッグ テーブルなしで foo ライブラリをコンパイルし、位置に依存しないコードを生成します。

--host_copt=cc-option

このオプションは、実行構成にコンパイルされるソースファイルについてコンパイラに渡される引数を取ります。これは --copt オプションと似ていますが、exec 構成にのみ適用されます。

--host_conlyopt=cc-option

このオプションは、実行構成にコンパイルされる C ソースファイルについてコンパイラに渡される引数を取ります。これは --conlyopt オプションと似ていますが、exec 構成にのみ適用されます。

--host_cxxopt=cc-option

このオプションは、実行構成にコンパイルされる C++ ソースファイルについてコンパイラに渡される引数を取ります。これは --cxxopt オプションと似ていますが、exec 構成にのみ適用されます。

--host_linkopt=linker-option

このオプションは、実行構成にコンパイルされるソースファイルのリンカーに渡される引数を取ります。これは --linkopt オプションと似ていますが、exec 構成にのみ適用されます。

--conlyopt=cc-option

このオプションは、C ソースファイルのコンパイル時にコンパイラに渡される引数を取ります。

これは --copt と似ていますが、C コンパイルにのみ適用され、C++ コンパイルまたはリンクには適用されません。そのため、--conlyopt を使用して C 固有のオプション（-Wno-pointer-sign など）を渡すことができます。

--cxxopt=cc-option

このオプションは、C++ ソースファイルのコンパイル時にコンパイラに渡される引数を取ります。

これは --copt と似ていますが、C++ コンパイルにのみ適用され、C コンパイルまたはリンクには適用されません。そのため、--cxxopt を使用して C++ 固有のオプション（-fpermissive や -fno-implicit-templates など）を渡すことができます。

例:

  % bazel build --cxxopt="-fpermissive" --cxxopt="-Wno-error" //foo/cruddy_code

--linkopt=linker-option

このオプションは、リンク時にコンパイラに渡される引数を取ります。

これは --copt と似ていますが、リンクにのみ適用され、コンパイルには適用されません。そのため、--linkopt を使用して、リンク時にのみ有効なコンパイラ オプション（-lssp や -Wl,--wrap,abort など）を渡すことができます。例:

  % bazel build --copt="-fmudflap" --linkopt="-lmudflap" //foo/buggy_code

ビルドルールでは、属性にリンク オプションを指定することもできます。このオプションの設定が常に優先されます。cc_library.linkopts もご覧ください。

--strip (always|never|sometimes)

このオプションは、-Wl,--strip-debug オプション付きでリンカーを呼び出すことで、Bazel がすべてのバイナリと共有ライブラリからデバッグ情報を削除するかどうかを決定します。--strip=always は、常にデバッグ情報を削除することを意味します。 --strip=never は、デバッグ情報を削除しないことを意味します。--strip=sometimes のデフォルト値は、--compilation_mode が fastbuild の場合に除去することを意味します。

  % bazel build --strip=always //foo:bar

ターゲットをコンパイルし、生成されたすべてのバイナリからデバッグ情報を削除します。

Bazel の --strip オプションは、ld の --strip-debug オプションに対応しています。デバッグ情報のみを削除します。なんらかの理由で、デバッグ シンボルだけでなく、すべてのシンボルを削除する場合は、ld の --strip-all オプションを使用する必要があります。これは --linkopt=-Wl,--strip-all を Bazel に渡すことで行えます。また、Bazel の --strip フラグを設定すると --linkopt=-Wl,--strip-all がオーバーライドされるため、どちらか一方のみを設定する必要があります。

ビルドするバイナリを 1 つだけにして、すべてのシンボルを削除する場合は、--stripopt=--strip-all を渡して //foo:bar.stripped バージョンのターゲットを明示的にビルドすることもできます。--stripopt のセクションで説明したように、これにより、ビルドのすべてのリンク アクションでストリップを含めるのではなく、最終バイナリがリンクされた後にストリップ アクションが適用されます。

--stripopt=strip-option

これは、*.stripped バイナリを生成するときに strip コマンドに渡す追加のオプションです。デフォルト値は -S -p です。このオプションは複数回使用できます。

--fdo_instrument=profile-output-dir

--fdo_instrument オプションを使用すると、ビルドされた C/C++ バイナリの実行時に FDO（フィードバック指向最適化）プロファイル出力を生成できます。GCC の場合、指定された引数は、各 .o ファイルのプロファイル情報を含む .gcda ファイルのオブジェクトごとのファイル ディレクトリ ツリーのディレクトリ プレフィックスとして使用されます。

プロファイル データツリーが生成されたら、プロファイル ツリーを圧縮して --fdo_optimize=profile-zip Bazel オプションに提供し、FDO 向けに最適化されたコンパイルを有効にする必要があります。

LLVM コンパイラの場合、引数は未加工の LLVM プロファイル データファイルがダンプされるディレクトリにもなります。例: --fdo_instrument=/path/to/rawprof/dir/。

--fdo_instrument オプションと --fdo_optimize オプションは同時に使用できません。

--fdo_optimize=profile-zip

--fdo_optimize オプションを使用すると、オブジェクトごとのファイル プロファイル情報を使用して、コンパイル時に FDO（フィードバック指向最適化）の最適化を実行できます。GCC の場合、指定される引数は、各 .o ファイルのプロファイル情報を含む、以前に生成された .gcda ファイルのファイルツリーを含む zip ファイルです。

指定された引数が、拡張子 .afdo で識別される自動プロファイルを指すこともできます。

LLVM コンパイラの場合、指定する引数は、llvm-profdata ツールによって準備されたインデックス登録済みの LLVM プロファイル出力ファイルを指す必要があり、拡張子は .profdata である必要があります。

--fdo_instrument オプションと --fdo_optimize オプションは同時に使用できません。

--java_language_version=version

このオプションでは、Java ソースのバージョンを指定します。例:

  % bazel build --java_language_version=8 java/com/example/common/foo:all

は Java 8 仕様と互換性のある構造のみをコンパイルし、許可します。 デフォルト値は 11 です。--> 有効な値は 8、9、10、11、14、15 です。default_java_toolchain を使用してカスタム Java ツールチェーンを登録することで拡張できます。

--tool_java_language_version=version

ビルド時に実行されるツールのビルドに使用される Java 言語バージョン。デフォルト値は 11 です。

--java_runtime_version=version

このオプションでは、コードの実行とテストの実行に使用する JVM のバージョンを指定します。次に例を示します。

  % bazel run --java_runtime_version=remotejdk_11 java/com/example/common/foo:java_application

リモート リポジトリから JDK 11 をダウンロードし、それを使用して Java アプリケーションを実行します。

デフォルト値は local_jdk です。有効な値は local_jdk、local_jdk_version、remotejdk_11、remotejdk_17 です。local_java_repository または remote_java_repository リポジトリ ルールを使用してカスタム JVM を登録することで、値を拡張できます。

--tool_java_runtime_version=version

ビルド時に必要なツールの実行に使用される JVM のバージョン。デフォルト値は remotejdk_11 です。

--jvmopt=jvm-option

このオプションを使用すると、オプション引数を Java VM に渡すことができます。1 つの大きな引数とともに使用することも、個々の引数と一緒に複数回使用することもできます。例:

  % bazel build --jvmopt="-server -Xms256m" java/com/example/common/foo:all

すべての Java バイナリの起動にサーバー VM を使用し、VM の起動ヒープサイズを 256 MB に設定します。

--javacopt=javac-option

このオプションを使用すると、オプション引数を javac に渡すことができます。1 つの大きな引数とともに使用することも、個々の引数と一緒に複数回使用することもできます。例:

  % bazel build --javacopt="-g:source,lines" //myprojects:prog

（bazel のデフォルトではなく）javac のデフォルトのデバッグ情報で java_binary が再ビルドされます。

このオプションは、javac の Bazel 組み込みデフォルト オプションの後、ルールごとのオプションの前に javac に渡されます。javac のオプションの最後の指定が優先されます。javac のデフォルト オプションは次のとおりです。

  -source 8 -target 8 -encoding UTF-8

--strict_java_deps (default|strict|off|warn|error)

このオプションは、javac が直接的な依存関係の欠落をチェックするかどうかを制御します。Java ターゲットは、直接使用されるすべてのターゲットを依存関係として明示的に宣言する必要があります。このフラグは、各 Java ファイルの型チェックに実際に使用される jar を判別するよう javac に指示します。現在のターゲットの直接的な依存関係の出力でない場合は警告またはエラーを表示します。

  • off は、チェックが無効であることを意味します。
  • warn は、直接依存関係がないそれぞれに対して、javac がタイプ [strict] の標準 Java 警告を生成することを意味します。
  • default、strict、error は、javac が警告ではなくエラーを生成することを意味します。そのため、直接的な依存関係が欠落していると、現在のターゲットがビルドに失敗します。これは、フラグが指定されていない場合のデフォルトの動作でもあります。

セマンティクスを構築する

これらのオプションは、ビルドコマンドや出力ファイルの内容に影響します。

--compilation_mode (fastbuild|opt|dbg)（-c）

--compilation_mode オプション（多くの場合、-c、特に -c opt と短縮されます）は、fastbuild、dbg、opt のいずれかの引数を取り、最適化レベルやデバッグ テーブルの完全性など、さまざまな C/C++ コード生成オプションに影響します。Bazel は、異なるコンパイル モードごとに異なる出力ディレクトリを使用するため、モードを切り替える際に毎回完全な再ビルドを行う必要はありません。

  • fastbuild は、「できるだけ早く」でビルドすることを意味します。生成されるデバッグ情報（-gmlt -Wl,-S）は最小限で、最適化は行いません。これがデフォルトです。注: -DNDEBUG は設定されません。
  • dbg は、デバッグを有効にした状態でビルドする（-g）ことを意味します。したがって、gdb（または別のデバッガ）を使用できます。
  • opt は、最適化を有効にして assert() 呼び出しを無効にした（-O2 -DNDEBUG）ビルドを意味します。--copt -g を渡さない限り、デバッグ情報は opt モードで生成されません。

--cpu=cpu

このオプションでは、ビルド中のバイナリのコンパイルに使用されるターゲット CPU アーキテクチャを指定します。

--action_env=VAR=VALUE

すべてのアクションの実行中に使用できる環境変数のセットを指定します。 変数は名前で指定できます。名前の場合、値は呼び出し環境から取得されます。name=value ペアの場合は、呼び出し環境とは独立して値が設定されます。

この --action_env フラグは複数回指定できます。複数の --action_env フラグで同じ変数に値が割り当てられている場合は、最新の割り当てが優先されます。

--experimental_action_listener=label

experimental_action_listener オプションは、label で指定された action_listener ルールの詳細を使用して、ビルドグラフに extra_actions を挿入するように Bazel に指示します。

--[no]experimental_extra_action_top_level_only

このオプションを true に設定すると、 --experimental_action_listener コマンドライン オプションで指定された追加のアクションは、トップレベルのターゲットに対してのみスケジュールされます。

--experimental_extra_action_filter=regex

experimental_extra_action_filter オプションは、extra_actions をスケジュールするターゲットのセットをフィルタリングするよう Bazel に指示します。

このフラグは、--experimental_action_listener フラグとの組み合わせでのみ使用できます。

デフォルトでは、ビルド対象のターゲットの推移的クロージャ内のすべての extra_actions の実行がスケジュールされます。--experimental_extra_action_filter は、オーナーのラベルが指定された正規表現に一致する extra_actions にスケジューリングを制限します。

次の例では、extra_actions のスケジューリングを、オーナーのラベルに「/bar/」が含まれているアクションにのみ適用するように制限します。

% bazel build --experimental_action_listener=//test:al //foo/... \
  --experimental_extra_action_filter=.*/bar/.*

--host_cpu=cpu

このオプションでは、ホストツールのビルドに使用する CPU アーキテクチャの名前を指定します。

--android_platforms=platform[,platform]*

android_binary ルールの推移的な deps をビルドするプラットフォーム（特に C++ などのネイティブ依存関係の場合）。たとえば、android_binary ルールの推移的な deps に含まれる cc_library は、android_binary ルールに --android_platforms で指定されたプラットフォームごとに 1 回ビルドされ、最終出力に含まれます。

このフラグにデフォルト値はありません。カスタムの Android プラットフォームを定義して使用する必要があります。

--android_platforms で指定されたプラットフォームごとに 1 つの .so ファイルが作成され、APK にパッケージ化されます。.so ファイルの名前の先頭に、android_binary ルールの名前に「lib」が付加されています。たとえば、android_binary の名前が「foo」の場合、ファイルは libfoo.so です。

--per_file_copt=[+-]regex[,[+-]regex]...@option[,option]...

存在する場合、包含正規表現の 1 つに一致し、除外式のいずれにも一致しないラベルまたは実行パスを持つ C++ ファイルは、指定されたオプションでビルドされます。ラベルのマッチングでは、正規形式のラベルが使用されます（例: //package:label_name）。

実行パスは、ワークスペース ディレクトリへの相対パスです。このパスには、C++ ファイルのベース名（拡張子を含む）が含まれます。プラットフォームに依存する接頭辞も含まれます。

生成されたファイル（genrule 出力など）を一致させるために、Bazel は実行パスのみを使用できます。この場合、実行パスと一致しないため、正規表現の先頭を「//」にしないでください。パッケージ名は --per_file_copt=base/.*\.pb\.cc@-g0 のように使用できます。これは、base というディレクトリにあるすべての .pb.cc ファイルと一致します。

このオプションは複数回使用できます。

このオプションは、使用されているコンパイル モードに関係なく適用されます。たとえば、--compilation_mode=opt を使用してコンパイルし、より強力な最適化をオンにしたり、最適化を無効にしたりして、一部のファイルを選択的にコンパイルできます。

注意: 一部のファイルがデバッグ シンボルで選択的にコンパイルされると、リンク中にシンボルが削除される可能性があります。これを防ぐには、--strip=never を設定します。

構文: [+-]regex[,[+-]regex]...@option[,option]... ここで、regex は正規表現です。正規表現の前に、包含パターンを示す + を、除外するパターンを示す - を前に付けることができます。option は、C++ コンパイラに渡される任意のオプションを表します。オプションに , が含まれている場合は、\, のように引用符で囲む必要があります。オプションに @ を含めることもできます。これは、正規表現をオプションから区切るために最初の @ だけが使用されるためです。

例: --per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs は、//foo/ にあるすべての .cc ファイル（file.cc を除く）について、C++ コンパイラのコマンドラインに -O0 オプションと -fprofile-arcs オプションを追加します。

--dynamic_mode=mode

ビルドルールの linkstatic 属性とやり取りして、C++ バイナリを動的にリンクするかどうかを決定します。

モード:

  • auto: プラットフォーム依存モードに変換します。Linux の場合は default、cygwin の場合は off です。
  • default: bazel が動的にリンクするかどうかを選択できます。詳しくは、linkstatic をご覧ください。
  • fully: すべてのターゲットを動的にリンクします。これにより、リンク時間が短縮され、生成されるバイナリのサイズが削減されます。
  • off: すべてのターゲットをほぼ静的モードでリンクします。linkopts で -static が設定されている場合、ターゲットは完全に静的に変更されます。

--fission (yes|no|[dbg][,opt][,fastbuild])

Fission を有効にします。Fission は、C++ デバッグ情報を .o ファイルではなく専用の .dwo ファイルに書き込みます（それ以外の場合）。これにより、リンクへの入力サイズが大幅に削減され、リンクの時間を短縮できます。

[dbg][,opt][,fastbuild]（例: --fission=dbg,fastbuild）に設定すると、指定されたコンパイル モードセットでのみ、Fission が有効になります。これは bazelrc の設定に便利です。yes に設定すると、Fission が普遍的に有効になります。no に設定すると、Fission は普遍的に無効になります。デフォルトは no です。

--force_ignore_dash_static

このフラグが設定されている場合、cc_* ルールの BUILD ファイルの linkopt の -static オプションは無視されます。これは、C++ 強化ビルドの回避策のみを目的としています。

--[no]force_pic

有効にすると、すべての C++ コンパイルで位置に依存しないコード（-fPIC）が生成されます。リンクでは非 PIC ライブラリよりも PIC のビルド済みライブラリが優先されます。また、リンクでは位置に依存しない実行ファイル（「-pie」）が生成されます。デフォルトは無効になっています。

--android_resource_shrinking

android_binary ルールに対してリソース圧縮を実行するかどうかを選択します。android_binary ルールで srink_resources 属性のデフォルトを設定します。詳細については、そのルールのドキュメントをご覧ください。デフォルトはオフです。

--custom_malloc=malloc-library-target

指定すると、常に特定の malloc 実装が使用され、malloc を指定せずにデフォルトを使用するターゲットを含め、すべての malloc="target" 属性をオーバーライドします。

--crosstool_top=label

このオプションは、ビルド中のすべての C++ コンパイルに使用するクロスツール コンパイラ スイートの場所を指定します。Bazel は、この場所で CROSSTOOL ファイルを探し、それを使用して --compiler の設定を自動的に決定します。

--host_crosstool_top=label

指定しない場合、Bazel は --crosstool_top の値を使用して、ビルド中に実行されるツールなど、実行構成のコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。

--apple_crosstool_top=label

objc*、ios*、apple* ルールの推移的な deps で C/C++ ルールをコンパイルするために使用するクロスツール。これらのターゲットでは、このフラグによって --crosstool_top が上書きされます。

--android_crosstool_top=label

android_binary ルールの推移的な deps で C/C++ ルールをコンパイルするために使用するクロスツール。これは、ビルド内の他のターゲットが別のクロスツールを必要とする場合に役立ちます。デフォルトでは、WORKSPACE ファイルの android_ndk_repository ルールで生成されたクロスツールを使用します。関連情報: --android_platforms.

--compiler=version

このオプションでは、ビルド中にバイナリのコンパイルに使用する C/C++ コンパイラ バージョン（gcc-4.1.0 など）を指定します。カスタム クロスツールでビルドする場合は、このフラグを指定する代わりに CROSSTOOL ファイルを使用する必要があります。

--android_sdk=label

非推奨です。これは直接指定しないでください。

このオプションでは、Android 関連のルールのビルドに使用される Android SDK/プラットフォーム ツールチェーンと Android ランタイム ライブラリを指定します。

WORKSPACE ファイルで android_sdk_repository ルールが定義されている場合は、Android SDK が自動的に選択されます。

--java_toolchain=label

このオプションは、Java ソースファイルのコンパイルに使用される java_ツールチェーン のラベルを指定します。

--host_java_toolchain=label

指定しない場合、bazel は --java_toolchain の値を使用して、ビルド中に実行されるツール用のコードなど、実行構成内のコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。

--javabase=(label)

このオプションは、ベース Java インストールのラベルを設定します。ラベルは、bazel run、bazel test、java_binary ルールと java_test ルールによってビルドされた Java バイナリに使用されます。JAVABASE と JAVA の「Make」変数は、このオプションから派生します。

--host_javabase=label

このオプションは、実行構成で使用するベース Java インストールのラベルを設定します（JavaBuilder や Singlejar などのホストビルド ツール用など）。

Java ソースファイルのコンパイルに使用される Java コンパイラは選択されません。コンパイラは、--java_toolchain オプションの設定で選択できます。

実行戦略

これらのオプションは、Bazel によるビルドの実行方法に影響します。ビルドによって生成される出力ファイルに影響はありません。通常、ビルドの速度に主な影響があります。

--spawn_strategy=strategy

このオプションでは、コマンドの実行場所と方法を制御します。

  • standalone は、コマンドをローカル サブプロセスとして実行します。この値は非推奨になりました。代わりに local を使用してください。
  • sandboxed は、ローカルマシンのサンドボックス内でコマンドを実行します。そのためには、すべての入力ファイル、データ依存関係、ツールを、srcs 属性、data 属性、tools 属性で直接依存関係としてリストする必要があります。Bazel は、サンドボックス化された実行をサポートするシステムでは、デフォルトでローカル サンドボックスを有効にします。
  • local は、コマンドをローカル サブプロセスとして実行します。
  • worker は、永続ワーカー（使用可能な場合）を使用してコマンドを実行します。
  • docker は、ローカルマシンの Docker サンドボックス内でコマンドを実行します。そのためには Docker がインストールされている必要があります。
  • remote は、コマンドをリモートで実行します。これは、リモート エグゼキュータが個別に構成されている場合にのみ使用できます。

--strategy mnemonic=strategy

このオプションは、コマンドの実行場所と実行方法を制御し、--spawn_strategy（およびニーモニック Genrule による --genrule_strategy）をニーモニックごとにオーバーライドします。サポートされている戦略とその効果については、--spawn_strategy をご覧ください。

--strategy_regexp=<filter,filter,...>=<strategy>

このオプションでは、特定の regex_filter に一致する説明を持つコマンドを実行する際に使用する戦略を指定します。regex_filter の一致の詳細については、--per_file_copt をご覧ください。サポートされている戦略とその効果については、--spawn_strategy をご覧ください。

説明に一致する最後の regex_filter が使用されます。このオプションは、戦略を指定するための他のフラグをオーバーライドします。

  • 例: --strategy_regexp=//foo.*\\.cc,-//foo/bar=local は、説明が //foo.*.cc に一致するが //foo/bar と一致しない場合、local 戦略を使用してアクションを実行することを意味します。
  • 例: --strategy_regexp='Compiling.*/bar=local' --strategy_regexp=Compiling=sandboxed は //foo/bar/baz のコンパイルを sandboxed 戦略で実行しますが、順序を逆にすると local で実行されます。
  • 例: --strategy_regexp='Compiling.*/bar=local,sandboxed' は、local 戦略を指定して「//foo/bar/baz のコンパイル」を実行し、失敗した場合は sandboxed にフォールバックします。

--genrule_strategy=strategy

これは非推奨になった --strategy=Genrule=strategy の省略形です。

--jobs=n（-j）

整数引数を取るこのオプションは、ビルドの実行フェーズで同時に実行するジョブの数の制限を指定します。

--progress_report_interval=n

Bazel は、まだ完了していないジョブ（長時間実行テストなど）に関する進行状況レポートを定期的に出力します。このオプションはレポートの頻度を設定します。進行状況は n 秒ごとに出力されます。

デフォルトは 0 で、これは増分アルゴリズムを意味します。つまり、最初のレポートは 10 秒後に出力され、その後 30 秒後に出力され、その進行状況は 1 分ごとに報告されます。

bazel が --curses で指定されているカーソル コントロールを使用している場合、進行状況が 1 秒ごとに報告されます。

--local_{ram,cpu}_resources resources or resource expression

これらのオプションでは、ビルドとテストのアクティビティをローカルで実行するようにスケジュール設定するときに、Bazel が考慮できるローカル リソースの量（MB 単位の RAM、CPU 論理コア数）を指定します。整数またはキーワード（HOST_RAM または HOST_CPUS）で、オプションで [-|*float] を続けます（例: --local_cpu_resources=2、--local_ram_resources=HOST_RAM*.5、--local_cpu_resources=HOST_CPUS-1）。フラグは独立しており、いずれかまたは両方を設定できます。デフォルトでは、Bazel は RAM の量と CPU コア数をローカル システムの構成から直接推定します。

このオプションはデフォルトで有効になっています。テストとバイナリの runfile シンボリック リンクを出力ディレクトリにビルドするかどうかを指定します。--nobuild_runfile_links は、runfiles ツリーのビルドに関するオーバーヘッドを発生させることなく、すべてのターゲットがコンパイルされるかどうかを検証するのに役立ちます。

テスト（またはアプリケーション）を実行すると、ランタイム データの依存関係が 1 か所に集められます。Bazel の出力ツリー内では、この「runfiles」ツリーは通常、対応するバイナリまたはテストの兄弟としてルート化されます。テスト実行中、実行ファイルには $TEST_SRCDIR/workspace/packagename/filename という形式のパスを使用してアクセスできます。runfiles ツリーにより、依存関係が宣言されているすべてのファイルにテストからアクセスできるようになります。デフォルトでは、必要なファイルへのシンボリック リンクのセットを構築することで、runfiles ツリーを実装します。リンクのセットが大きくなるにつれて、この処理のコストも増加します。特に個々のテスト（またはアプリケーション）ごとに独自の実行ファイル ツリーが必要なため、一部の大規模なビルドでは全体的なビルド時間が大幅に増加する可能性があります。

--[no]build_runfile_manifests

このオプションはデフォルトで有効になっており、runfile マニフェストを出力ツリーに書き込むかどうかを指定します。無効にすると、--nobuild_runfile_links になります。

runfile ツリーはメモリ内マニフェストからリモートで作成されるため、リモートでテストを実行する場合は、これを無効にできます。

--[no]discard_analysis_cache

このオプションを有効にすると、Bazel は実行開始直前に分析キャッシュを破棄して、実行フェーズの追加メモリ（約 10%）を解放します。欠点は、それ以降の増分ビルドに時間がかかることです。メモリ節約モードもご覧ください。

--[no]keep_going（-k）

GNU Make と同様に、ビルドの実行フェーズは、最初のエラーが発生すると停止します。エラーが発生した場合でも、可能な限り多くのビルドを作成することが有効な場合があります。このオプションを使用すると、この動作が有効になります。指定すると、ビルドは前提条件が正常にビルドされているすべてのターゲットのビルドを試みますが、エラーを無視します。

このオプションは通常、ビルドの実行フェーズに関連付けられますが、分析フェーズにも影響します。ビルドコマンドに複数のターゲットを指定しても、そのターゲットの一部しか正常に分析できない場合、ビルドはエラーで停止します。--keep_going が指定されていなければ、ビルドは実行フェーズに進みますが、分析に成功したターゲットのみが対象になります。

--[no]use_ijars

このオプションは、java_library ターゲットを Bazel でコンパイルする方法を変更します。依存する java_library ターゲットのコンパイルに java_library の出力を使用する代わりに、Bazel は、非プライベート メンバー（パブリック、保護された、デフォルト（パッケージ）のアクセスメソッドとフィールド）の署名のみを含むインターフェース JAR を作成し、インターフェース JAR を使用して依存ターゲットをコンパイルします。これにより、メソッド本体またはクラスのプライベート メンバーのみに変更が加えられた場合の再コンパイルを回避できます。

--[no]interface_shared_objects

このオプションを使用すると、インターフェース共有オブジェクトが有効になります。これにより、バイナリやその他の共有ライブラリは共有オブジェクトの実装ではなくインターフェースに依存するようになります。実装のみが変更された場合、Bazel は、変更された共有ライブラリに不必要に依存するターゲットの再構築を回避できます。

出力の選択

これらのオプションにより、ビルドまたはテストの対象が決まります。

--[no]build

このオプションを使用すると、ビルドの実行フェーズが発生します。デフォルトではオンです。オフにすると、実行フェーズがスキップされ、最初の 2 つのフェーズ（読み込みと分析）のみが発生します。

このオプションは、実際にビルドせずに、BUILD ファイルを検証し、入力内のエラーを検出する場合に役立ちます。

--[no]build_tests_only

指定すると、サイズ、タイムアウト、タグ、または言語が原因で除外されなかった *_test ルールと test_suite ルールを実行するために必要なもののみがビルドされます。これを指定すると、Bazel はコマンドラインで指定された他のターゲットを無視します。 このオプションはデフォルトで無効になっており、Bazel は、テストから除外された *_test ルールや test_suite ルールなど、リクエストされたすべてのものをビルドします。bazel test --build_tests_only foo/... を実行しても foo ツリー内のすべてのビルド破損が検出されるわけではないため、これは便利です。

--[no]check_up_to_date

このオプションを使用すると、Bazel はビルドを実行せず、指定されたすべてのターゲットが最新かどうかをチェックするだけです。その場合、ビルドは通常どおり正常に完了します。ただし、いずれかのファイルがビルドされずに古い場合は、エラーが報告され、ビルドが失敗します。このオプションは、ビルドのコストを発生させることなく、ビルドがソース編集よりも最近実行されたかどうかを判断するのに役立ちます（送信前のチェックなど）。

--check_tests_up_to_date もご覧ください。

--[no]compile_one_dependency

引数ファイルの単一の依存関係をコンパイルします。これは、IDE でソースファイルの構文チェックを行う場合に便利です。たとえば、編集/ビルド/テストサイクルのできるだけ早い段階でエラーを検出するために、ソースファイルに依存する単一のターゲットを再ビルドする場合などです。この引数は、フラグ以外のすべての引数の解釈方法に影響します。各引数は、ファイル ターゲット ラベルまたは現在の作業ディレクトリを基準とするプレーン ファイル名にする必要があります。また、各ソースファイル名に依存するルールが 1 つビルドされます。ソースが C++ と Java の場合、同じ言語空間のルールが優先的に選択されます。同じ設定を持つ複数のルールについては、BUILD ファイルで最初に記述されているルールが選択されます。明示的に指定されたターゲット パターンがソースファイルを参照しない場合は、エラーが発生します。

--save_temps

--save_temps オプションを使用すると、コンパイラからの一時的な出力が保存されます。これには、.s ファイル（アセンブラ コード）、.i（前処理された C）、.ii（前処理された C++）ファイルが含まれます。多くの場合、これらの出力はデバッグに役立ちます。一時は、コマンドラインで指定された一連のターゲットに対してのみ生成されます。

現在、--save_temps フラグは cc_* ルールでのみ機能します。

Bazel が追加の出力ファイルの場所を出力するようにするには、--show_result n の設定が十分に大きいことを確認します。

--build_tag_filters=tag[,tag]*

指定すると、Bazel は、必須タグが 1 つ以上指定されている場合、除外されたタグを含まないターゲットのみをビルドします。ビルドタグ フィルタは、タグキーワードのカンマ区切りのリストとして指定します。必要に応じて、除外するタグを示すために「-」記号を前に付けます。必須タグの前に「+」記号が付いていることもあります。

テストの実行時、Bazel は、テスト ターゲットの --build_tag_filters を無視します。テスト ターゲットは、このフィルタと一致していなくてもビルドおよび実行されます。ビルドを回避するには、--test_tag_filters を使用するか、ターゲットを明示的に除外して、テスト ターゲットをフィルタリングします。

--test_size_filters=size[,size]*

指定すると、Bazel は指定されたサイズのテスト ターゲットのみをテスト（--build_tests_only も指定されている場合はビルド）します。テストサイズ フィルタは、許可されたテストサイズ値（小、中、大、大）のカンマ区切りのリストとして指定します。テストサイズを除外するために使用する「-」記号を先頭に付けることもできます。たとえば

  % bazel test --test_size_filters=small,medium //foo:all

このように

  % bazel test --test_size_filters=-large,-enormous //foo:all

//foo 内の小規模および中規模のテストのみをテストします。

デフォルトでは、テストサイズのフィルタリングは適用されません。

--test_timeout_filters=timeout[,timeout]*

指定すると、Bazel は指定されたタイムアウトに達したテスト ターゲットのみをテストします（--build_tests_only も指定されている場合はビルドします）。テスト タイムアウト フィルタは、許可されるテスト タイムアウト値（short、moderate、long、eternal）のカンマ区切りリストとして指定します。テスト タイムアウトを除外することを示す「-」記号を先頭に付けることもできます（省略可）。構文の例については、--test_size_filters をご覧ください。

デフォルトでは、テスト タイムアウト フィルタリングは適用されません。

--test_tag_filters=tag[,tag]*

指定すると、Bazel は、必須タグ（指定されている場合）が 1 つ以上あり、除外されたタグを含まないテスト ターゲットのみをテスト（--build_tests_only も指定されている場合はビルド）します。テストタグ フィルタは、タグキーワードのカンマ区切りのリストとして指定します。また、除外するタグを示すために「-」記号を先頭に付けることもできます。必須タグの前に「+」記号が付いていることもあります。

たとえば

  % bazel test --test_tag_filters=performance,stress,-flaky //myproject:all

performance タグまたは stress タグがタグ付けされているものの、flaky タグがタグ付けされていないターゲットをテストします。

デフォルトでは、テストタグのフィルタリングは適用されません。この方法でテストの size タグと local タグをフィルタすることもできます。

--test_lang_filters=string[,string]*

テストルールクラスの名前を参照する文字列のカンマ区切りリストを指定します。ルールクラス foo_test を参照するには、文字列「foo」を使用します。Bazel は、参照されたルールクラスのターゲットのみをテスト（--build_tests_only も指定されている場合はビルド）します。これらのターゲットを除外するには、文字列「-foo」を使用します。たとえば

  % bazel test --test_lang_filters=foo,bar //baz/...

//baz/... 内で foo_test または bar_test のインスタンスであるターゲットのみをテストしますが、 

  % bazel test --test_lang_filters=-foo,-bar //baz/...

//baz/... のすべてのターゲットをテストします（foo_test インスタンスと bar_test インスタンスを除く）。

--test_filter=filter-expression

実行するテストのサブセットを選択するためにテストランナーが使用するフィルタを指定します。呼び出しで指定されたすべてのターゲットがビルドされますが、式によってはターゲットの一部しか実行されません。特定のテストメソッドのみが実行される場合もあります。

filter-expression の具体的な解釈は、テストを実行するテスト フレームワークで決まります。glob、部分文字列、regexp を使用できます。--test_filter は、さまざまな --test_arg フィルタ引数を渡すことに便利な方法ですが、すべてのフレームワークがサポートしているわけではありません。

読み上げの詳細設定

これらのオプションは、ターミナルまたは追加のログファイルに対する Bazel の出力の詳細度を制御します。

--explain=logfile

このオプションにはファイル名の引数が必要です。bazel build の実行フェーズの依存関係チェッカーは、ビルドステップごとに、実行されている理由と最新状態のいずれかを説明します。説明は logfile に書き込まれます。

予期しない再構築が発生した場合は、このオプションが理由の把握に役立ちます。これを .bazelrc に追加して、後続のすべてのビルドでロギングが行われるようにします。実行ステップが予期せず実行された場合はログを調べます。このオプションは、パフォーマンスを少し低下させる可能性があるため、不要になった場合は削除することをおすすめします。

--verbose_explanations

このオプションを使用すると、--explain オプションが有効な場合に生成される説明の詳細度が高くなります。

特に、詳細説明が有効になっていて、ビルドに使用されたコマンドが変更されたために出力ファイルが再構築される場合、説明ファイルの出力には新しいコマンドの詳細が含まれます（少なくともほとんどのコマンドの場合）。

このオプションを使用すると、生成される説明ファイルの長さが大幅に増加し、--explain を使用するとパフォーマンスが低下する可能性があります。

--explain が有効になっていない場合、--verbose_explanations は適用されません。

--profile=file

このオプションはファイル名の引数を受け取り、Bazel はプロファイリング データをファイルに書き込みます。その後、bazel analyze-profile コマンドを使用してデータを分析または解析できます。ビルド プロファイルは、Bazel の build コマンドが時間を費やしている場所を把握するのに役立ちます。

--[no]show_loading_progress

このオプションを使用すると、Bazel からパッケージ読み込みの進行状況メッセージが出力されます。無効になっている場合、メッセージは表示されません。

--[no]show_progress

このオプションを使用すると、進行状況のメッセージが表示されます（デフォルトではオンになっています）。無効にすると、進行状況のメッセージが表示されなくなります。

--show_progress_rate_limit=n

このオプションを使用すると、bazel は n 秒ごとに最大 1 つの進行状況メッセージを表示します（n は実数）。このオプションのデフォルト値は 0.02 です。つまり、bazel は進行状況メッセージを 0.02 秒ごとに 1 つに制限します。

--show_result=n

このオプションは、bazel build コマンドの最後に結果情報が出力されるかどうかを制御します。デフォルトでは、単一のビルド ターゲットが指定されている場合、Bazel は、ターゲットが正常に更新されたかどうかを示すメッセージと、ターゲットによって作成された出力ファイルのリストを出力します。複数のターゲットが指定されている場合、結果情報は表示されません。

結果情報は、単一のターゲットまたは少数のターゲットのビルドには便利ですが、大規模なビルド（トップレベル プロジェクト ツリー全体など）では、この情報が負担になり、気が散ることがあります。このオプションを使用すると、制御が可能になります。--show_result は整数の引数を取ります。これは、完全な結果情報を出力するターゲットの最大数です。デフォルト値は 1 です。このしきい値を超えると、個々のターゲットの結果情報は表示されません。ゼロに設定すると結果情報が常に抑制され、値が非常に大きくなると結果が常に出力されます。

小規模なターゲット グループの構築（コンパイル、編集、テストサイクルなど）とターゲットの大規模なグループのビルド（たとえば、新しいワークスペースの確立や回帰テストの実行など）の間で定期的に値を選択するユーザーが増える可能性があります。前者の場合、結果情報は非常に役立ちますが、後者の場合はそれほど有用ではありません。すべてのオプションと同様に、.bazelrc ファイルを介して暗黙的に指定できます。

これらのファイルは、ファイル名をコピーしてシェルに貼り付け、ビルドされた実行可能ファイルを実行できるように、出力されます。各ターゲットの「最新」または「失敗した」メッセージは、ビルドを実行するスクリプトによって簡単に解析できます。

--sandbox_debug

このオプションを指定すると、サンドボックス化を使用してアクションを実行する際に、Bazel が追加のデバッグ情報を出力します。また、このオプションではサンドボックス ディレクトリが保持されるため、実行中にアクションに表示されるファイルを調べることができます。

--subcommands（-s）

このオプションを使用すると、Bazel の実行フェーズでは、各コマンドの実行前に完全なコマンドラインが出力されます。

  >>>>> # //examples/cpp:hello-world [action 'Linking examples/cpp/hello-world']
  (cd /home/johndoe/.cache/bazel/_bazel_johndoe/4c084335afceb392cfbe7c31afee3a9f/bazel && \
    exec env - \
    /usr/bin/gcc -o bazel-out/local-fastbuild/bin/examples/cpp/hello-world -B/usr/bin/ -Wl,-z,relro,-z,now -no-canonical-prefixes -pass-exit-codes -Wl,-S -Wl,@bazel-out/local_linux-fastbuild/bin/examples/cpp/hello-world-2.params)

可能な場合は、コマンドは Bourne シェルと互換性のある構文で出力されるため、シェルのコマンド プロンプトに簡単にコピーして貼り付けることができます。（かっこを囲むかっこは、シェルを cd と exec の呼び出しから保護するために用意されています。必ずコピーしてください）。ただし、シンボリック リンク ツリーの作成など、一部のコマンドは Bazel の内部に実装されています。これらについては、表示するコマンドラインはありません。

--subcommands=pretty_print を渡すと、コマンドの引数を 1 行ではなくリストとして出力できます。これにより、長いコマンドラインが読みやすくなります。

以下の --verbose_failures もご覧ください。

ツールに適した形式でサブコマンドをファイルにロギングする方法については、--execution_log_json_file と --execution_log_binary_file をご覧ください。

--verbose_failures

このオプションを使用すると、Bazel の実行フェーズで、失敗したコマンドの完全なコマンドラインが出力されます。これは、失敗したビルドのデバッグにとって非常に重要です。

失敗したコマンドは Bourne シェルと互換性のある構文で出力されます。これは、シェル プロンプトにコピーして貼り付けるのに適しています。

ワークスペースのステータス

これらのオプションを使用して、Bazel でビルドされたバイナリに「スタンプ」を付けることができます。つまり、ソース管理のリビジョンやその他のワークスペース関連情報など、追加情報をバイナリに埋め込むことができます。このメカニズムは、genrule や cc_binary など、stamp 属性をサポートするルールで使用できます。

--workspace_status_command=program

このフラグを使用すると、各ビルドの前に Bazel が実行するバイナリを指定できます。プログラムは、現在のソース コントロールのリビジョンなど、ワークスペースのステータスに関する情報を報告できます。

フラグの値には、ネイティブ プログラムへのパスを指定する必要があります。Linux/macOS では、任意の実行可能ファイルの可能性があります。Windows では、ネイティブ バイナリ（通常は「.exe」、「.bat」、「.cmd」）である必要があります。

プログラムは 0 個以上の Key-Value ペアを標準出力に出力します（各行に 1 エントリ）。その後、ゼロで終了します（そうでない場合、ビルドは失敗します）。鍵名には自由に使用できますが、使用できるのは大文字とアンダースコアのみです。キー名の後の最初のスペースは、キー名と値を区切ります。値は、行の残りの部分（追加の空白を含む）です。キーも値も複数行にまたがってはいけません。キーは重複してはいけません。

Bazel は、キーを「stable」と「volatile」の 2 つのバケットに分けます。（「stable」と「volatile」という名前は直感に反するため、あまり考えないでください）。

Bazel は、Key-Value ペアを次の 2 つのファイルに書き込みます。

  • bazel-out/stable-status.txt には、キーの名前が STABLE_ で始まるすべてのキーと値が含まれます。
  • bazel-out/volatile-status.txt には、残りのキーとその値が含まれます。

契約内容:

  • 「stable」キーの値は、可能な限り、ほとんど変更しないようにします。bazel-out/stable-status.txt の内容が変更されると、Bazel はそれらに依存するアクションを無効にします。つまり、安定したキーの値が変更された場合、Bazel はスタンプ付きのアクションを再実行します。 したがって、安定ステータスにはタイムスタンプなどが含まれていてはなりません。これらのステータスは常に変更され、ビルドごとに Bazel がスタンプ付きのアクションを再実行するからです。

    Bazel は常に次の安定したキーを出力します。

    • BUILD_EMBED_LABEL: --embed_label の値
    • BUILD_HOST: Bazel が実行されているホストマシンの名前
    • BUILD_USER: Bazel を実行しているユーザーの名前

  • 「volatile」キーの値は頻繁に変更される可能性があります。Bazel は、タイムスタンプと同様に常に変更されることを想定し、bazel-out/volatile-status.txt ファイルを適切に更新します。ただし、スタンプ付きのアクションが何度も再実行されないようにするために、Bazel は volatile ファイルが変更されないふりをします。つまり、内容が変更されたファイルが volatile ステータス ファイルのみである場合、Bazel はそのファイルに依存するアクションを無効にしません。アクションの他の入力が変更された場合、Bazel はそのアクションを再実行し、更新された volatile ステータスがアクションに表示されますが、volatile ステータスが変更されただけではアクションは無効になりません。

    Bazel は、常に次の volatile キーを出力します。

    • BUILD_TIMESTAMP: ビルドの時間（Unix エポックからの経過秒数）（System.currentTimeMillis() の値を 1,000 時間で割った値）
    • FORMATTED_DATE: ビルドの時刻。UTC で yyyy MMM d HH mm ss EEE としてフォーマットされます（例: 2023 年 6 月 2 01 44 29 金）。

Linux/macOS では、--workspace_status_command=/bin/true を渡してワークスペースのステータスの取得を無効にできます。これは、true は何も実行せず（ゼロで終了）、出力がないためです。Windows では、MSYS の true.exe のパスを渡して同じ効果が得られます。

なんらかの理由で workspace status コマンドが失敗する（ゼロ以外で終了する）と、ビルドは失敗します。

Git を使用した Linux でのプログラムの例:

#!/bin/bash
echo "CURRENT_TIME $(date +%s)"
echo "RANDOM_HASH $(cat /proc/sys/kernel/random/uuid)"
echo "STABLE_GIT_COMMIT $(git rev-parse HEAD)"
echo "STABLE_USER_NAME $USER"

このプログラムのパスを --workspace_status_command に渡すと、安定版ステータス ファイルに STABLE 行が含まれ、揮発性ステータス ファイルに残りの行が含まれます。

--[no]stamp

このオプションは、stamp ルール属性と組み合わせて使用することで、ビルド情報をバイナリに埋め込むかどうかを制御します。

スタンプは、stamp 属性を使用してルールごとに明示的に有効または無効にできます。詳細については、Build Encyclopedia をご覧ください。ルールで stamp = -1（*_binary ルールのデフォルト）が設定されている場合、このオプションによってスタンプが有効かどうかが決まります。

このオプションまたは stamp 属性に関係なく、Bazel は、実行構成用にビルドされたバイナリにスタンプすることはありません。stamp = 0（*_test ルールのデフォルト）を設定するルールでは、--[no]stamp に関係なくスタンプが無効になります。--stamp を指定しても、ターゲットの依存関係が変更されていなければ、ターゲットは強制的に再ビルドされません。

--nostamp を設定すると、入力の変動性が減少し、ビルド キャッシュが最大化されるため、一般的にビルド パフォーマンスの向上が期待できます。

プラットフォーム

これらのオプションを使用して、ビルドの動作を構成するホスト プラットフォームとターゲット プラットフォームを制御し、Bazel ルールで使用できる実行プラットフォームとツールチェーンを制御します。

プラットフォームとツールチェーンの背景情報をご覧ください。

--platforms=labels

現在のコマンドのターゲット プラットフォームを記述するプラットフォーム ルールのラベル。

--host_platform=label

ホストシステムを記述するプラットフォーム ルールのラベル。

--extra_execution_platforms=labels

アクションを実行するための実行プラットフォームとして利用できるプラットフォーム。プラットフォームは、正確なターゲットで、またはターゲット パターンとして指定できます。これらのプラットフォームは、register_execution_platforms() によって WORKSPACE ファイル内で宣言されたプラットフォームより優先されます。このオプションには、優先度の高い順にプラットフォームのカンマ区切りリストを指定できます。フラグが複数回渡された場合は、最新のオーバーライドが優先されます。

--extra_toolchains=labels

ツールチェーンの解決時に考慮されるツールチェーン ルールツールチェーンは正確なターゲットで指定することも、ターゲット パターンとして指定することもできます。これらのツールチェーンは、register_toolchains() によって WORKSPACE ファイル内で宣言されたツールチェーンよりも前に考慮されます。

--toolchain_resolution_debug=regex

ツールチェーン タイプが正規表現と一致する場合、ツールチェーンの検索中にデバッグ情報を出力します。複数の正規表現を指定する場合は、カンマで区切ります。先頭に - を使用すると、正規表現を無効にすることができます。これは、ツールチェーンの欠落が原因でデバッグが失敗する Bazel または Starlark ルールのデベロッパーに役立ちます。

その他

--flag_alias=alias_name=target_path

長い Starlark ビルド設定を短い名前にバインドするために使用される便利なフラグ。詳しくは、Starlark の構成をご覧ください。

生成されたコンビニエンス シンボリック リンクのプレフィックスを変更します。シンボリック リンク プレフィックスのデフォルト値は bazel- です。これは、シンボリック リンク bazel-bin、bazel-testlogs、bazel-genfiles を作成します。

なんらかの理由でシンボリック リンクを作成できない場合、警告が発行されますが、ビルドは成功したとみなされます。特に、読み取り専用ディレクトリや書き込み権限のないディレクトリでビルドを行うことができます。ビルドの終了時に情報メッセージに出力されるパスは、シンボリック リンクが所定の場所を指している場合にのみ、シンボリック リンク相対短い形式を使用します。つまり、作成されるシンボリック リンクに依存できなくても、これらのパスの正確性を信頼できます。

このオプションの一般的な値は次のとおりです。

  • シンボリック リンクの作成を抑制する: --symlink_prefix=/ を指定すると、Bazel は、シンボリック リンク bazel-out や bazel-<workspace> などのシンボリック リンクを作成または更新しません。このオプションを使用すると、シンボリック リンクの作成を完全に抑制できます。

  • 不要な情報を減らす: --symlink_prefix=.bazel/ を指定すると、Bazel によって、非表示のディレクトリ .bazel 内に bin などのシンボリック リンクが作成されます。

--platform_suffix=string

構成の略称に接尾辞を追加します。この接尾辞は、出力ディレクトリの決定に使用されます。このオプションを別の値に設定すると、ファイルが別のディレクトリに配置されます。たとえば、互いの出力ファイルを上書きするビルドのキャッシュ ヒット率を改善したり、比較のために出力ファイルを保持したりできます。

--default_visibility=(private|public)

bazel のデフォルトの公開設定の変更をテストするための一時的なフラグ。一般的な使用は意図していませんが、完全性のために文書化されています。

--starlark_cpu_profile=_file_

このフラグにファイル名を指定すると、Bazel がすべての Starlark スレッドによる CPU 使用率に関する統計情報を収集し、プロファイルを pprof 形式で指定のファイルに書き込みます。

このオプションを使用すると、過剰な計算が原因で読み込みと分析が遅くなる Starlark 関数を特定できます。例:

$ bazel build --nobuild --starlark_cpu_profile=/tmp/pprof.gz my/project/...
$ pprof /tmp/pprof.gz
(pprof) top
Type: CPU
Time: Feb 6, 2020 at 12:06pm (PST)
Duration: 5.26s, Total samples = 3.34s (63.55%)
Showing nodes accounting for 3.34s, 100% of 3.34s total
      flat  flat%   sum%        cum   cum%
     1.86s 55.69% 55.69%      1.86s 55.69%  sort_source_files
     1.02s 30.54% 86.23%      1.02s 30.54%  expand_all_combinations
     0.44s 13.17% 99.40%      0.44s 13.17%  range
     0.02s   0.6%   100%      3.34s   100%  sorted
         0     0%   100%      1.38s 41.32%  my/project/main/BUILD
         0     0%   100%      1.96s 58.68%  my/project/library.bzl
         0     0%   100%      3.34s   100%  main

同じデータを別のビューに表示するには、pprof コマンド svg、web、list を試してください。

リリースに Bazel を使用する

Bazel は、開発サイクル中のソフトウェア エンジニアと、本番環境にデプロイするバイナリを準備する際にリリース エンジニアが使用します。このセクションでは、Bazel を使用するリリース エンジニア向けのヒントの一覧を示します。

重要なオプション

リリースビルドに Bazel を使用すると、ビルドを実行する他のスクリプトと同じ問題が発生します。詳しくは、スクリプトから Bazel を呼び出すをご覧ください。特に、次のオプションを強くおすすめします。

これらのオプションも重要です。

  • --package_path
  • --symlink_prefix: 複数の構成のビルドを管理する場合は、「64 ビット」と「32 ビット」のように、各ビルドを個別の識別子で区別すると便利です。このオプションは、bazel-bin などのシンボリック リンクを区別します。

テストの実行

bazel を使用してテストをビルドして実行するには、「bazel test」に続けてテスト ターゲットの名前を入力します。

デフォルトでは、このコマンドはビルドとテスト アクティビティを同時に実行します。つまり、前提条件がビルドされるとすぐに、指定されたすべてのターゲット（コマンドラインで指定された非テスト ターゲットを含む）をビルドして、*_test ターゲットと test_suite ターゲットをテストします。つまり、テスト実行はビルドとインターリーブされます。これにより、通常は速度が大幅に向上します。

「bazel test」のオプション

--cache_test_results=(yes|no|auto)（-t）

このオプションを「auto」（デフォルト）に設定した場合、Bazel は、次のいずれかの条件に該当する場合にのみテストを再実行します。

  • Bazel がテストまたはその依存関係の変更を検出する
  • テストが external とマークされている
  • --runs_per_test で複数のテスト実行がリクエストされました
  • 表示されます。

「no」の場合、すべてのテストが無条件に実行されます。

「yes」の場合、キャッシュの動作は auto と同じですが、テストの失敗と --runs_per_test でのテスト実行がキャッシュに保存される点が異なります。

.bazelrc ファイルでこのオプションをデフォルトで有効にしているユーザーは、-t（オン）または -t-（オフ）という略称を使用して、特定の実行でデフォルトをオーバーライドすることができます。

--check_tests_up_to_date

このオプションは、テストを実行しないように Bazel に指示します。キャッシュされたテスト結果を確認して報告するだけです。以前にビルドおよび実行されていないテストがある場合や、テスト結果が古い場合（ソースコードやビルド オプションが変更されたなど）、Bazel はエラー メッセージ（「テスト結果が最新ではありません」）を報告し、テストのステータスを「NO STATUS」（色出力が有効になっている場合は赤色）として記録し、ゼロ以外のコードを返します。

このオプションは、[--check_up_to_date](#check-up-to-date) の動作も暗黙的に示唆します。

このオプションは、送信前のチェックに便利です。

--test_verbose_timeout_warnings

このオプションは、テストのタイムアウトがテストの実際の実行時間よりも著しく長い場合にユーザーに明示的に警告するよう Bazel に指示します。テストのタイムアウトは不安定にならないように設定する必要がありますが、タイムアウトを非常に長く設定すると、予期せず発生する実際の問題を回避することができます。

たとえば、通常 1 ～ 2 分で実行されるテストの場合、ETERNAL や LONG のタイムアウトはあまりに長すぎるため、設定しないでください。

このオプションは、適切なタイムアウト値の決定や、既存のタイムアウト値のサニティ チェックを行う際に役立ちます。

--[no]test_keep_going

デフォルトでは、すべてのテストが完了まで実行されます。このフラグが無効になっている場合、合格していないテストではビルドが中止されます。後続のビルドステップとテスト呼び出しは実行されず、処理中の呼び出しはキャンセルされます。--notest_keep_going と --keep_going の両方を指定しないでください。

--flaky_test_attempts=attempts

このオプションでは、なんらかの理由でテストが失敗した場合に、テストを試行できる最大回数を指定します。最初は失敗したが、最終的に成功したテストは、テストの概要に FLAKY として報告されます。ただし、Bazel 終了コードまたは合格したテストの合計数を特定する場合は、合格とみなされます。許可されたすべての試行が失敗するテストは、失敗したものとみなされます。

デフォルト（このオプションが指定されていない場合、またはデフォルトに設定されている場合）は、通常のテストでは 1 回だけ試行でき、flaky 属性が設定されたテストルールでは 3 回しか試行できません。整数値を指定して、テストの試行回数の上限をオーバーライドできます。Bazel では、システムの不正使用を防ぐため、テストを最大で 10 回試行できます。

--runs_per_test=[regex@]number

このオプションでは、各テストを実行する回数を指定します。すべてのテスト実行は別々のテストとして扱われます（フォールバック機能はそれぞれに独立して適用されます）。

実行に失敗したターゲットのステータスは、--runs_per_test_detects_flakes フラグの値によって異なります。

  • 存在しない場合、実行が失敗するとテスト全体が失敗します。
  • 同じシャードから実行が 2 回あり、合格と FAIL が返された場合、テストは不安定なステータスになります（他の実行の失敗で失敗しない限り）。

単一の数値を指定すると、すべてのテストがその回数だけ実行されます。また、正規表現を regex@number 構文を使用して指定することもできます。これにより、正規表現に一致するターゲットに対する --runs_per_test の効果が制限されます（--runs_per_test=^//pizza:.*@4 は、//pizza/ の下のすべてのテストを 4 回実行します）。この形式の --runs_per_test は複数回指定できます。

--[no]runs_per_test_detects_flakes

このオプションが指定されている場合（デフォルトでは無効になっています）、Bazel は --runs_per_test を介して不安定なテストシャードを検出します。1 つのシャードに対する 1 つ以上の実行が失敗し、同じシャードパスに対する 1 つ以上の実行が失敗した場合、フラグがあるターゲットは不安定とみなされます。指定しない場合、ターゲットは失敗ステータスを報告します。

--test_summary=output_style

テスト結果の概要の表示方法を指定します。

  • short は、各テストの結果と、テストが失敗した場合はテスト出力を含むファイルの名前を出力します。これがデフォルト値です。
  • terse は short に似ていますが、さらに短くします。合格しなかったテストに関する情報のみを出力します。
  • detailed は、各テストだけでなく、失敗した個々のテストケースを出力します。テスト出力ファイルの名前は省略されます。
  • none はテストサマリーを出力しません。

--test_output=output_style

テスト出力の表示方法を指定します。

  • summary には、各テストの合否の概要が表示されます。失敗したテストの出力ログファイル名も表示されます。概要はビルドの最後に出力されます（ビルド中は、テストの開始、合格、失敗のときに、単純な進行状況のメッセージだけが表示されます）。これがデフォルト設定です。
  • errors は、失敗したテストの stdout/stderr 出力を、テスト完了直後にのみ stdout に送信します。これにより、同時テストからのテスト出力が互いにインターリーブされないようにします。上記のサマリー出力に従って、ビルド時にサマリーを出力します。
  • all は errors に似ていますが、合格したテストを含むすべてのテストの出力を出力します。
  • streamed は、各テストの stdout/stderr 出力をリアルタイムでストリーミングします。

--java_debug

このオプションを使用すると、Java テストの Java 仮想マシンは、JDWP 準拠のデバッガからの接続を待機してからテストを開始します。このオプションは --test_output=streamed を示します。

--[no]verbose_test_summary

このオプションはデフォルトで有効になっています。テスト時間やその他の追加情報（テストの試行など）がテストの概要に出力されます。--noverbose_test_summary が指定されている場合、テストの概要にはテスト名、テスト ステータス、キャッシュされたテスト インジケーターのみが含まれ、可能な限り 80 文字以内に収まるようフォーマットされます。

--test_tmpdir=path

ローカルで実行するテストの一時ディレクトリを指定します。各テストは、このディレクトリ内の個別のサブディレクトリで実行されます。ディレクトリは、各 bazel test コマンドの先頭でクリーンアップされます。デフォルトでは、bazel はこのディレクトリを Bazel 出力ベース ディレクトリの下に配置します。

--test_timeout=seconds または --test_timeout=seconds,seconds,seconds,seconds

指定された秒数を新しいタイムアウト値として使用して、すべてのテストのタイムアウト値をオーバーライドします。値を 1 つだけ指定した場合は、その値がすべてのテスト タイムアウト カテゴリに使用されます。

また、4 つのカンマ区切り値を指定して、短いテスト、中程度のテスト、長いテスト、永続的なテストのタイムアウトを（この順序で）指定することもできます。いずれの場合も、テストの作成ページで定義されているタイムアウト カテゴリのデフォルトのタイムアウトが、テストサイズのゼロまたは負の値に置き換えられます。デフォルトでは、Bazel は、サイズが暗黙的または明示的に設定されているかどうかに関係なく、テストのサイズからタイムアウトの上限を推測することで、すべてのテストでこれらのタイムアウトを使用します。

タイムアウト カテゴリがサイズと異なることを明示的に記述したテストでは、そのタイムアウトがサイズタグによって暗黙的に設定された場合と同じ値を受け取ります。したがって、「長い」タイムアウトを宣言するサイズ「small」のテストの実質的なタイムアウトは、明示的なタイムアウトのない「大規模」テストと同じ有効タイムアウトになります。

--test_arg=arg

各テストプロセスにコマンドライン オプション、フラグ、引数を渡します。このオプションを複数回使用して、複数の引数を渡すことができます。次に例を示します。 --test_arg=--logtostderr --test_arg=--v=3

--test_env=variable=_value_ または --test_env=variable

各テストでテスト環境に挿入する必要がある追加の変数を指定します。value が指定されていない場合は、bazel test コマンドの開始に使用されるシェル環境から継承されます。

テスト内から環境にアクセスするには、System.getenv("var")（Java）、getenv("var")（C または C++）、

--run_under=command-prefix

これは、テストランナーがテストコマンドの前に挿入する接頭辞を指定します。command-prefix は Bourne シェルのトークン化ルールを使用して単語に分割され、実行されるコマンドの先頭に単語のリストが追加されます。

最初の単語が完全修飾ラベル（// で始まる）である場合、ビルドされます。ラベルは対応する実行可能場所に置き換えられ、他の単語と一緒に実行されるコマンドの前に付加されます。

注意点は次のとおりです。

  • テストの実行に使用する PATH が環境の PATH と異なる場合があるため、--run_under コマンドに絶対パス（command-prefix の最初の単語）を使用しなければならない場合があります。
  • stdin が接続されていないため、--run_under をインタラクティブ コマンドに使用することはできません。

例:

        --run_under=/usr/bin/strace
        --run_under='/usr/bin/strace -c'
        --run_under=/usr/bin/valgrind
        --run_under='/usr/bin/valgrind --quiet --num-callers=20'

選択をテスト

出力選択オプションに記載されているように、サイズ、タイムアウト、タグ、または言語でテストをフィルタできます。簡易的な一般名フィルタを使用して、特定のフィルタ引数をテストランナーに転送できます。

「bazel test」のその他のオプション

構文と残りのオプションは bazel build とまったく同じです。

実行可能ファイルの実行

bazel run コマンドは、単一のターゲットのビルドと実行に使用される点を除き、bazel build コマンドと似ています。一般的なセッションは次のとおりです。

  % bazel run java/myapp:myapp -- --arg1 --arg2
  Welcome to Bazel
  INFO: Loading package: java/myapp
  INFO: Loading package: foo/bar
  INFO: Loading complete.  Analyzing...
  INFO: Found 1 target...
  ...
  Target //java/myapp:myapp up-to-date:
    bazel-bin/java/myapp:myapp
  INFO: Elapsed time: 0.638s, Critical Path: 0.34s

  INFO: Running command line: bazel-bin/java/myapp:myapp --arg1 --arg2
  Hello there
  $EXEC_ROOT/java/myapp/myapp
  --arg1
  --arg2

bazel run は、Bazel によってビルドされたバイナリを直接呼び出すのと類似していますが、同一ではありません。また、呼び出すバイナリがテストかどうかによって動作が異なります。

バイナリがテストでない場合、現在の作業ディレクトリはバイナリの runfiles ツリーになります。

バイナリがテストの場合、現在の作業ディレクトリは実行ルートになり、テストが通常実行される環境を誠意を持って複製します。ただし、エミュレーションは完全ではないため、複数のシャードを持つテストはこの方法では実行できません（--test_sharding_strategy=disabled コマンドライン オプションを使用するとこの問題を回避できます）。

次の追加の環境変数もバイナリで使用できます。

  • BUILD_WORKSPACE_DIRECTORY: ビルドが実行されたワークスペースのルート。
  • BUILD_WORKING_DIRECTORY: Bazel の実行元の現在の作業ディレクトリ。

たとえば、コマンドラインでファイル名をユーザー フレンドリーな方法で解釈するために使用できます。

「bazel run」のオプション

--run_under=command-prefix

これは bazel test の --run_under オプション（上記を参照）と同じですが、bazel test によって実行されるテストではなく bazel run によって実行されるコマンドに適用されるため、ラベルの下では実行できません。

Bazel からのロギング出力のフィルタリング

bazel run を使用してバイナリを呼び出すと、Bazel 自体と呼び出し中のバイナリからのロギング出力が出力されます。ログのノイズを減らすには、--ui_event_filters フラグと --noshow_progress フラグを使用して Bazel 自体からの出力を抑制します。

次に例を示します。bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp

テストの実行

bazel run はテストバイナリも実行できます。このため、テストの作成で説明している環境とほぼ同じ環境でテストを実行できます。この方法でテストを実行する場合、--test_arg 以外の --test_* 引数はいずれも効果がありません。

ビルド出力のクリーニング

clean コマンド

Bazel には、Make と同様の clean コマンドがあります。 この Bazel インスタンスによって実行されたすべてのビルド構成の出力ディレクトリ、またはこの Bazel インスタンスによって作成された作業ツリー全体の出力ディレクトリが削除され、内部キャッシュがリセットされます。コマンドライン オプションを指定せずに実行すると、すべての構成の出力ディレクトリがクリーンアップされます。

各 Bazel インスタンスは 1 つのワークスペースに関連付けられているため、clean コマンドを実行すると、そのワークスペース内の Bazel インスタンスに対して行ったすべてのビルドからすべての出力が削除されます。

Bazel インスタンスによって作成された作業ツリー全体を完全に削除するには、--expunge オプションを指定します。--expunge で clean コマンドを実行すると、ビルド出力に加えて、Bazel によって作成されたすべての一時ファイルを含む出力ベースツリー全体が削除されます。また、クリーン後に Bazel サーバーを停止します（shutdown コマンドと同等です）。たとえば、Bazel インスタンスのすべてのディスクとメモリ トレースをクリーンアップするには、次のように指定します。

  % bazel clean --expunge

また、--expunge_async を使用してバックグラウンドで消去することもできます。非同期消去の実行中に同じクライアントで Bazel コマンドを安全に呼び出しても構いません。

clean コマンドは主に、不要になったワークスペースのディスク容量を回収する手段として提供されています。Bazel の増分再ビルドは完全なものではない可能性があるため、clean を使用すると、問題が発生したときに整合性のある状態を復元できます。

Bazel の設計では、これらの問題が修正可能であり、このバグは修正の優先度が高くなります。誤った増分ビルドを見つけた場合は、clean を使用せずに、バグレポートを提出し、ツールでバグを報告してください。

依存関係グラフをクエリする

Bazel には、ビルド中に使用される依存関係グラフについて質問するためのクエリ言語が含まれています。クエリ言語は、query と cquery の 2 つのコマンドで使用されます。2 つのコマンドの主な違いは、クエリは読み込みフェーズの後に実行され、cquery は分析フェーズの後に実行されることです。これらのツールは、多くのソフトウェア エンジニアリング タスクにとって非常に重要です。

クエリ言語はグラフに対する代数演算の考え方に基づいています。詳細については、

Bazel クエリ リファレンス。 参考用、例、クエリ固有のコマンドライン オプションについては、このドキュメントを参照してください。

クエリツールでは、いくつかのコマンドライン オプションを使用できます。--output: 出力形式を選択します。--[no]keep_going（デフォルトでは無効）を指定すると、エラー発生時にクエリツールが処理を続行します。エラーにより不完全な結果が許容されない場合、この動作は無効になる場合があります。

--[no]tool_deps オプションはデフォルトで有効になっています。ターゲット以外の構成の依存関係は、クエリが実行される依存関係グラフに含まれます。

デフォルトで有効になっている --[no]implicit_deps オプションを使用すると、クエリが実行される依存関係グラフに暗黙的な依存関係が含まれます。暗黙的な依存関係とは、BUILD ファイルで明示的に指定されていないが、bazel によって追加された依存関係です。

例: 「PEBL ツリー内のすべてのテストをビルドするために必要なすべての genrule の定義（BUILD ファイル内）の場所を表示する」

  bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'

アクション グラフのクエリ

aquery コマンドを使用すると、ビルドグラフ内でアクションをクエリできます。分析後に構成したターゲット グラフに対して動作し、アクション、アーティファクト、それらの関係に関する情報を公開します。

このツールでは、いくつかのコマンドライン オプションを使用できます。--output: 出力形式を選択します。デフォルトの出力形式（text）は人が読める形式です。機械で読み取れる形式には proto または textproto を使用します。特に、aquery コマンドは通常の Bazel ビルド上で実行され、ビルド中に使用できる一連のオプションを継承します。

従来の query でもあるものと同じ関数セットをサポートしていますが、siblings、buildfiles、tests に対応しています。

詳細については、アクショングラフ クエリをご覧ください。

その他のコマンドとオプション

help

help コマンドを使用すると、オンライン ヘルプが表示されます。デフォルトでは、Bazel を使用したビルドに示すように、使用可能なコマンドとヘルプトピックの概要が表示されます。 引数を指定すると、特定のトピックに関する詳細なヘルプが表示されます。ほとんどのトピックは、build や query などの Bazel コマンドですが、コマンドに対応していないヘルプトピックが他にもいくつかあります。

--[no]long（-l）

デフォルトでは、bazel help [topic] はトピックに関連するオプションの概要のみを出力します。--long オプションを指定すると、各オプションのタイプ、デフォルト値、詳しい説明も出力されます。

shutdown

Bazel サーバー プロセスは、shutdown コマンドを使用して停止できます。このコマンドを実行すると、Bazel サーバーがアイドル状態になるとすぐに（たとえば、現在進行中のビルドやコマンドが完了したら）終了します。詳細については、クライアント/サーバーの実装をご覧ください。

Bazel サーバーはアイドル タイムアウト後に自動的に停止するため、このコマンドが必要になることはほとんどありません。ただし、特定のワークスペースでそれ以上ビルドが行われないことがわかっている場合は、スクリプトで役立ちます。

shutdown は --iff_heap_size_greater_than _n_ という 1 つのオプションを受け入れます。これには整数の引数（MB 単位）が必要です。指定すると、すでに消費しているメモリの量に応じてシャットダウンが行われます。Bazel サーバーでメモリリークがあると、誤ってクラッシュを引き起こす可能性があるため、多数のビルドを開始するスクリプトに役立ちます。条件付き再起動を実行すると、この条件がプリエンプトされます。

info

info コマンドは、Bazel サーバー インスタンスまたは特定のビルド構成に関連するさまざまな値を出力します。 （ビルドを実行するスクリプトで使用される場合があります）。

info コマンドでは、単一の（オプションの）引数を使用できます。これは、以下のリストにあるキーのいずれかの名前です。この場合、bazel info key はそのキーの値のみを出力します。（これは、sed -ne /key:/s/key://p で結果をパイプする必要がないため、Bazel をスクリプト化する場合に特に便利です。

構成に依存しないデータ

  • release: この Bazel インスタンスのリリースラベル。リリース バイナリでない場合は「development version」。
  • workspace は、ベース ワークスペース ディレクトリへの絶対パスです。

  • install_base: 現在のユーザーに対してこの Bazel インスタンスで使用されているインストール ディレクトリへの絶対パス。Bazel は、内部的に必要な実行可能ファイルをこのディレクトリにインストールします。

  • output_base: 現在のユーザーとワークスペースの組み合わせに対してこの Bazel インスタンスで使用されるベース出力ディレクトリへの絶対パス。Bazel は、すべてのスクラッチとビルドの出力をこのディレクトリの下に置きます。

  • execution_root: output_base の実行ルート ディレクトリへの絶対パス。このディレクトリは、ビルド中に実行されるコマンドからアクセス可能なすべてのファイルのルートであり、それらのコマンドの作業ディレクトリです。ワークスペース ディレクトリが書き込み可能な場合、このディレクトリを指す bazel-<workspace> という名前のシンボリック リンクが配置されます。

  • output_path: ビルドコマンドの結果として実際に生成されたすべてのファイルに使用される、実行ルートの下の出力ディレクトリへの絶対パス。ワークスペース ディレクトリが書き込み可能な場合は、このディレクトリを指す bazel-out という名前のシンボリック リンクが配置されます。

  • server_pid: Bazel サーバー プロセスのプロセス ID。

  • server_log: Bazel サーバーのデバッグログ ファイルの絶対パス。このファイルには、Bazel サーバーの存続期間におけるすべてのコマンドのデバッグ情報が含まれており、Bazel のデベロッパーとパワーユーザーが人間が利用するためのものです。

  • command_log: コマンド ログファイルの絶対パス。最新の Bazel コマンドのインターリーブされた stdout ストリームと stderr ストリームが含まれます。bazel info を実行すると、このファイルの内容が上書きされます。これが最新の Bazel コマンドになるからです。ただし、--output_base または --output_user_root オプションの設定を変更しない限り、コマンドのログファイルの場所は変更されません。

  • used-heap-size、committed-heap-size、max-heap-size: さまざまな JVM ヒープサイズ パラメータをレポートします。それぞれ、現在使用されているメモリ、現在システムから JVM で使用できることが保証されているメモリ、可能な最大割り当てです。

  • gc-count、gc-time: この Bazel サーバーの起動以降のガベージ コレクションの累積数と、コレクションの実行にかかった時間。これらの値は、すべてのビルドの開始時にリセットされるわけではありません。

  • package_path: bazel でパッケージを検索するパスのコロン区切りのリスト。形式は、--package_path ビルド コマンドライン引数と同じです。

（例: Bazel サーバーのプロセス ID）。

% bazel info server_pid
1285

構成固有のデータ

これらのデータは、bazel info に渡される構成オプション（--cpu、--compilation_mode など）の影響を受ける場合があります。info コマンドは、依存関係の分析を制御するすべてのオプションを受け入れます。これらのオプションの一部によって、ビルドの出力ディレクトリの場所、コンパイラの選択などが決まるからです。

  • bazel-bin、bazel-testlogs、bazel-genfiles: ビルドによって生成されたプログラムが配置されている bazel-* ディレクトリへの絶対パスを報告します。これは常にではありませんが、通常はビルドが成功した後にベース ワークスペース ディレクトリに作成される bazel-* シンボリック リンクと同じです。ただし、ワークスペース ディレクトリが読み取り専用の場合、bazel-* シンボリック リンクは作成できません。シンボリック リンクが存在することを前提とせずに、bazel info から報告された値を使用するスクリプトは、より堅牢になります。
  • 完全な 「Make」環境。--show_make_env フラグを指定すると、現在の構成の「Make」環境内のすべての変数（CC、GLIBC_VERSION など）も表示されます。これらの変数には、BUILD ファイル内で $(CC) 構文または varref("CC") 構文を使用してアクセスします。

例: 現在の構成の C++ コンパイラ。これは「Make」環境の $(CC) 変数であるため、--show_make_env フラグが必要です。

  % bazel info --show_make_env -c opt COMPILATION_MODE
  opt

例: 現在の構成の bazel-bin 出力ディレクトリ。なんらかの理由で bazel-bin シンボリック リンクを作成できない場合（読み取り専用ディレクトリからビルドしている場合など）でも、正しいことが保証されます。

% bazel info --cpu=piii bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/piii-opt/bin
% bazel info --cpu=k8 bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/k8-opt/bin

version、--version

version コマンドは、ビルドされた Bazel バイナリのバージョンの詳細（ビルドされた変更リストと日付を含む）を出力します。これらは、最新の Bazel を使用しているかどうかの判断や、バグの報告を行う場合に特に役立ちます。興味深い値は次のとおりです。

  • changelist: このバージョンの Bazel がリリースされた変更リスト。
  • label: この Bazel インスタンスのリリースラベル。リリース バイナリでない場合は「development version」。バグの報告に非常に役立ちます。

bazel --version は、他の引数を指定しなかった場合、bazel version --gnu_format と同じ出力を出力します。ただし、Bazel サーバーの起動やサーバー アーカイブの解凍という副作用はありません。bazel --version はどこからでも実行でき、ワークスペース ディレクトリは必要ありません。

mobile-install

mobile-install コマンドを使用すると、モバイル デバイスにアプリをインストールできます。現時点では、ART を実行している Android デバイスのみがサポートされています。

詳細については、bazel mobile-install をご覧ください。

次のオプションがサポートされています。

--incremental

設定すると、Bazel はアプリを段階的にインストールしようとします。つまり、前回のビルド以降に変更された部分だけをインストールしようとします。AndroidManifest.xml から参照されるリソース、ネイティブ コード、Java リソース（Class.getResource() によって参照されるリソースなど）は更新できません。これらを変更する場合は、このオプションを省略する必要があります。Bazel の精神に反し、Android プラットフォームの制限により、このコマンドで十分に適切なタイミングとフルインストールが必要なタイミングを把握するのはユーザーの責任です。

Marshmallow 以降を搭載したデバイスを使用している場合は、--split_apks フラグを検討してください。

--split_apks

分割 APK を使用してデバイスでアプリのインストールと更新を行うかどうかを指定します。Marshmallow 以降を搭載したデバイスでのみ動作します。なお、--split_apks を使用する場合、--incremental フラグは必要ありません。

--start_app

インストール後にアプリをクリーンな状態で起動します。--start=COLD と同じです。

--debug_app

デバッガがアタッチされるのを待ってから、インストール後にクリーンな状態でアプリを起動します。 --start=DEBUG と同じです。

--start=_start_type_

インストール後のアプリを起動する方法。サポートされている _start_type_ は次のとおりです。

  • NO: アプリを起動しません。これがデフォルトです。
  • COLD: インストール後にアプリをクリーンな状態から起動します。
  • WARM: 増分インストール時にアプリケーションの状態を保持して復元します。
  • DEBUG デバッガを待機してから、インストール後にクリーンな状態でアプリを起動します。

--adb=path

使用する adb バイナリを示します。

デフォルトでは、--android_sdk で指定された Android SDK の adb が使用されます。

--adb_arg=serial

adb に追加の引数。これらはコマンドラインのサブコマンドの前に配置され、通常はインストール先のデバイスを指定するために使用されます。 たとえば、使用する Android デバイスまたはエミュレータを選択するには、次のようにします。

% bazel mobile-install --adb_arg=-s --adb_arg=deadbeef

次のように adb を呼び出します。

adb -s deadbeef install ...

--incremental_install_verbosity=number

増分インストールの詳細度。デバッグ ロギングがコンソールに出力されるようにするには、1 に設定します。

dump

dump コマンドは、Bazel サーバーの内部状態のダンプを stdout に出力します。このコマンドは、主に Bazel デベロッパーによる使用を想定しているため、このコマンドの出力は規定されていません。また、変更される可能性があります。

デフォルトでは、Bazel 状態の特定の領域をダンプするオプションの概要を示すヘルプ メッセージが出力されるだけです。内部状態をダンプするには、少なくとも 1 つのオプションを指定する必要があります。

次のオプションがサポートされています。

  • --action_cache は、アクション キャッシュのコンテンツをダンプします。
  • --packages はパッケージ キャッシュのコンテンツをダンプします。
  • --skyframe は、内部の Bazel 依存関係グラフの状態をダンプします。
  • --rules は、各ルールとアスペクト クラスのルールの概要（数やアクション数など）をダンプします。これには、ネイティブ ルールと Starlark ルールの両方が含まれます。メモリ トラッキングが有効になっている場合は、ルールのメモリ消費量も出力されます。
  • --skylark_memory は、pprof 互換の .gz ファイルを指定されたパスにダンプします。この機能を使用するには、メモリ トラッキングを有効にする必要があります。

メモリのトラッキング

一部の dump コマンドにはメモリ トラッキングが必要です。これを有効にするには、起動フラグを Bazel に渡す必要があります。

  • --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
  • --host_jvm_args=-DRULE_MEMORY_TRACKER=1

java-agent は third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar で Bazel にチェックインされるため、Bazel リポジトリを保持する場所に合わせて $BAZEL を調整してください。

コマンドごとにこれらのオプションを Bazel に必ず渡すようにしてください。そうしないと、サーバーが再起動します。

例:

    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    build --nobuild <targets>

    # Dump rules
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --rules

    # Dump Starlark heap and analyze it with pprof
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --skylark_memory=$HOME/prof.gz
    % pprof -flame $HOME/prof.gz

analyze-profile

analyze-profile コマンドは、Bazel の呼び出し中に収集された JSON トレース プロファイルを分析します。

canonicalize-flags

canonicalize-flags コマンド。Bazel コマンドのオプションのリストを受け取り、同じ効果を持つオプションのリストを返します。オプションの新しいリストは正規です。たとえば、効果が同じ 2 つのオプション リストは同じ新しいリストに正規化されます。

--for_command オプションを使用すると、さまざまなコマンドから選択できます。現時点では、build と test のみがサポートされています。指定したコマンドでサポートされていないオプションは、エラーが発生します。

例は次のとおりです。

  % bazel canonicalize-flags -- --config=any_name --test_tag_filters="-lint"
  --config=any_name
  --test_tag_filters=-lint

起動オプション

このセクションで説明するオプションは、Bazel サーバー プロセスで使用される Java 仮想マシンの起動に影響し、そのサーバーで処理される後続のすべてのコマンドに適用されます。すでに実行中の Bazel サーバーが存在し、起動オプションが一致しない場合は、サーバーが再起動されます。

このセクションで説明するオプションはすべて、--key=value 構文または --key value 構文を使用して指定する必要があります。また、これらのオプションは、Bazel コマンド名の前に配置する必要があります。startup --key=value を使用して、これらを .bazelrc ファイルにリストします。

--output_base=dir

このオプションにはパス引数が必要です。また、書き込み可能なディレクトリを指定する必要があります。Bazel は、この場所を使用してすべての出力を書き込みます。出力ベースは、クライアントが Bazel サーバーを見つけるために使用されるキーでもあります。出力ベースを変更することで、コマンドを処理するサーバーを変更します。

デフォルトでは、出力ベースはユーザーのログイン名とワークスペース ディレクトリの名前（実際には、その MD5 ダイジェスト）から取得されます。そのため、一般的な値は /var/tmp/google/_bazel_johndoe/d41d8cd98f00b204e9800998ecf8427e のようになります。

例:

 OUTPUT_BASE=/var/tmp/google/_bazel_johndoe/custom_output_base
% bazel --output_base ${OUTPUT_BASE}1 build //foo  &  bazel --output_base ${OUTPUT_BASE}2 build //bar

このコマンドでは、2 つの Bazel コマンドが同時に実行され（シェルの &amp; 演算子により）、それぞれが異なる Bazel サーバー インスタンスを使用しています（出力ベースが異なるため）。 一方、両方のコマンドでデフォルトの出力ベースが使用された場合、両方のリクエストが同じサーバーに送信され、順次処理されます。つまり、最初に //foo をビルドしてから、//bar の増分ビルドを行います。

--output_user_root=dir

出力ベースとインストール ベースが作成されるルート ディレクトリを指します。ディレクトリが存在しないか、呼び出し元のユーザーによって所有されている必要があります。これまでは、さまざまなユーザー間で共有されるディレクトリを指すことが可能でしたが、現在は使用できなくなりました。これは、問題 #11100 への対処後に許可されます。

--output_base オプションを指定すると、出力ベースの計算に --output_user_root の使用がオーバーライドされます。

インストール ベースの場所は、--output_user_root と、Bazel 埋め込みバイナリの MD5 ID に基づいて計算されます。

ファイルシステム レイアウトに適切な場所がある場合は、--output_user_root オプションを使用して、Bazel のすべての出力（インストール ベースと出力ベース）に代替ベースの場所を選択できます。

--server_javabase=dir

Bazel 自体が実行される Java 仮想マシンを指定します。値には、JDK または JRE を含むディレクトリのパスを指定する必要があります。ラベルは使用できません。 このオプションは、Bazel コマンドの前に表示されます。次に例を示します。

  % bazel --server_javabase=/usr/local/buildtools/java/jdk11 build //foo

このフラグは、アプリケーション、テスト、ツールなどの Bazel サブプロセスで使用される JVM には影響しません。代わりにビルド オプション --javabase または --host_javabase を使用してください。

このフラグは、以前は --host_javabase（「左側」の --host_javabase とも呼ばれます）という名前でしたが、ビルドフラグ --host_javabase（「右側」の --host_javabase と呼ばれることもあります）との混同を避けるために名前が変更されました。

--host_jvm_args=string

Bazel 自体が実行される Java 仮想マシンに渡す起動オプションを指定します。これはスタックサイズの設定に使用できます。次に例を示します。

  % bazel --host_jvm_args="-Xss256K" build //foo

このオプションは、個々の引数を指定して複数回使用できます。このフラグの設定が必要になることはほとんどありません。スペース区切りの文字列リストを渡すこともできます。文字列はそれぞれ個別の JVM 引数として解釈されますが、この機能はまもなく非推奨になります。

Bazel のサブプロセスで使用される JVM（アプリケーション、テスト、ツールなど）に影響がないこと。実行可能な Java プログラムに JVM オプションを渡すには（bazel run とコマンドラインのどちらで実行した場合でも）、すべての java_binary プログラムと java_test プログラムがサポートする --jvm_flags 引数を使用する必要があります。テスト用には、bazel test --test_arg=--jvm_flags=foo ... を使用します。

--host_jvm_debug

このオプションを使用すると、Java 仮想マシンは JDWP 準拠のデバッガからの接続を待機してから、Bazel 自体のメインメソッドを呼び出します。これは、主に Bazel デベロッパーが使用するためのものです。

--autodetect_server_javabase

このオプションを使用すると、Bazel は起動時にインストール済みの JDK を自動的に検索し、埋め込み JRE を使用できない場合はインストール済みの JRE にフォールバックします。--explicit_server_javabase を使用すると、Bazel を実行する明示的な JRE を選択できます。

--batch

バッチモードでは、Bazel は標準のクライアント/サーバーモードを使用せず、1 つのコマンドに対して bazel Java プロセスを実行します。これは、シグナル処理、ジョブ制御、環境変数の継承に関して予測可能なセマンティクスに使用されており、chroot jail で bazel を実行するために必要です。

バッチモードでは、同じ output_base 内で適切なキューイング セマンティクスが保持されます。 つまり、同時呼び出しは重複なしで順番に処理されます。サーバーを実行中のクライアントでバッチモードの Bazel が実行されている場合、コマンドを処理する前に、まずサーバーを強制終了します。

バッチモードでは、または上記の代替方法を使用すると、Bazel の実行速度が遅くなります。 特に、ビルドファイル キャッシュはメモリ常駐であり、連続したバッチ呼び出し間では保持されないためです。したがって、継続的なビルドなど、パフォーマンスの重要性が低い場合は、多くの場合、バッチモードを使用するほうが適しています。

--max_idle_secs=n

このオプションでは、最後のクライアント リクエストから終了までに Bazel サーバー プロセスが待機する時間を秒単位で指定します。デフォルト値は 10,800（3 時間）です。--max_idle_secs=0 は、Bazel サーバー プロセスを無期限に保持します。

このオプションは、Bazel を呼び出すスクリプトで使用され、他の方法では実行されない Bazel サーバー プロセスがユーザーのマシンに残らないようにします。たとえば、presubmit スクリプトは bazel query を呼び出して、ユーザーの保留中の変更によって不要な依存関係が生じないようにすることができます。ただし、ユーザーがそのワークスペースで最近ビルドを行っていない場合、一日中アイドル状態のまま維持するため、presubmit スクリプトが Bazel サーバーを起動することは望ましくありません。クエリ リクエストで小さい値 --max_idle_secs を指定すると、スクリプトによって新しいサーバーが開始された場合if、そのサーバーはすぐに終了しますが、サーバーがすでに稼働している場合は、そのサーバーが通常の時間アイドル状態になるまで実行を継続します。既存のサーバーのアイドル タイマーはリセットされます。

--[no]shutdown_on_low_sys_mem

有効で、--max_idle_secs が正の期間に設定されている場合は、ビルドサーバーがしばらくアイドル状態になってから、システムのメモリ残量が少ないときにサーバーをシャットダウンします。Linux のみ。

ビルドサーバーは、max_idle_secs に対応するアイドル チェックを実行するだけでなく、サーバーがしばらくアイドル状態になると、使用可能なシステムメモリのモニタリングを開始します。使用可能なシステムメモリが非常に少なくなると、サーバーは終了します。

--[no]block_for_lock

有効にすると、Bazel はサーバーロックを保持している他の Bazel コマンドが完了するまで待機してから、処理を続行します。無効になっている場合、Bazel がロックをすぐに取得して続行できない場合、エラーで終了します。

デベロッパーは、presubmit チェックでこれを使用して、同じクライアント内の別の Bazel コマンドによる長い待機を回避することができます。

--io_nice_level=n

ベスト エフォートの IO スケジューリングのレベルを 0 ～ 7 で設定します。0 の優先度が最も高く、7 の優先度が最も低くなります。予測スケジューラは、優先度 4 までしか尊重できません。 負の値は無視されます。

--batch_cpu_scheduling

Bazel 用に batch CPU スケジューリングを使用します。このポリシーは、インタラクティブではないものの、適切な値を低くしたくないワークロードに役立ちます。「man 2 sched_setscheduler」を参照してください。このポリシーにより、Bazel のスループットを犠牲にしてシステムのインタラクティブ性が向上する場合があります。

その他のオプション

--[no]announce_rc

起動時に bazelrc ファイルから読み取ったコマンド オプションを Bazel が通知するかどうかを指定します。（起動オプションは無条件に通知されます）。

--color (yes|no|auto)

このオプションは、Bazel が色を使用して画面上の出力をハイライト表示するかどうかを指定します。

このオプションを yes に設定すると、色出力が有効になります。 このオプションを auto に設定すると、出力がターミナルに送信され、TERM 環境変数が dumb、emacs、xterm-mono 以外の値に設定されている場合にのみ、Bazel はカラー出力を使用します。このオプションを no に設定すると、出力がターミナルに送信されるかどうかや、TERM 環境変数の設定に関係なく、色出力が無効になります。

--config=name

rc ファイルから追加の構成セクションを選択します。現在の command について、そのようなセクションが存在する場合は command:name からオプションも取得します。複数回指定して、複数の構成セクションからフラグを追加できます。展開は他の定義を参照できます（たとえば、展開を連結できます）。

--curses (yes|no|auto)

このオプションにより、Bazel が画面出力でカーソル コントロールを使用するかどうかが決まります。これにより、データのスクロールが減り、Bazel からの出力ストリームがよりコンパクトで読みやすくなります。これは --color で適切に機能します。

このオプションを yes に設定すると、カーソル コントロールが有効になります。 このオプションを no に設定すると、カーソル コントロールは無効になります。 このオプションを auto に設定すると、--color=auto と同じ条件でカーソル コントロールが有効になります。

--[no]show_timestamps

指定すると、Bazel によって生成された各メッセージにタイムスタンプが追加され、メッセージが表示された時刻が示されます。