Lightbuild CLI リファレンス

Lightbuild CLI は、Lightbuild の公式コマンドライン ツールです。このページでは、そのコマンドとオプションについて説明します。Lightbuild CLI をインストールするには、Lightbuild CLI をインストールするをご覧ください。プロジェクトのビルドやテストなどの一般的なタスクについては、コマンドラインから Lightbuild プロジェクトをビルドするをご覧ください。

構文

Lightbuild CLI の構文は次のとおりです。

lightbuild [-V] [--project=path] [COMMAND]

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

オプション 説明
-V、--version バージョン情報を出力して終了します。
-p、--project=path プロジェクトの絶対パス。デフォルトは現在のディレクトリです。このディレクトリにはプロジェクトが含まれている必要があります。

使用可能なコマンドを一覧表示するには、lightbuild help を実行します。特定のコマンドのヘルプを表示するには、lightbuild help [command] を実行します。

lightbuild build

プロジェクトでターゲットをビルドします。

lightbuild build [target]
引数 説明
target ビルドするターゲット。デフォルトは、現在のディレクトリの下にあるすべてのターゲットです。

たとえば、app モジュールをビルドするには、次のコマンドを実行します。

lightbuild build app

プロジェクト内のすべてのターゲットをビルドするには、次のコマンドを実行します。

lightbuild build

lightbuild clean

プロジェクトのビルド出力とキャッシュを削除します。

lightbuild clean [target]
引数 説明
target クリーンアップするターゲット。デフォルトは、現在のディレクトリの下にあるすべてのターゲットです。

たとえば、プロジェクト全体のビルド出力とキャッシュを削除するには、次のコマンドを実行します。

lightbuild clean

lightbuild help

使用可能なコマンドを一覧表示するか、特定のコマンドのヘルプを表示します。

lightbuild help [COMMAND]
引数 説明
COMMAND ヘルプを表示するコマンド。デフォルトはすべてのコマンドです。

プロジェクトで使用可能なコマンドを一覧表示するには、次のコマンドを実行します。

lightbuild help

query などの特定のコマンドのヘルプを表示するには、次のコマンドを実行します。

lightbuild help query

lightbuild query

プロジェクトのモジュール全体でパターンに一致するビルド ターゲット、生成された出力ファイル、またはソースセットを一覧表示します。

lightbuild query [target-pattern] [--format=format] [--output=type]
オプションまたは引数 説明
target-pattern ターゲット パス パターン（...、app など）。
--format=format 出力形式（例: json）。デフォルトはテーブルです。
--output=type 出力の形式。一致するターゲットが生成するファイルの場所の場合は files、ソースセットの場合は sourcesets、ソースセットのタイプの場合は sourceset_types。

プロジェクト内のすべてのターゲットを一覧表示するには、次のコマンドを実行します。

lightbuild query ...

app ターゲットが生成するファイルの場所を出力するには、次のコマンドを実行します。

lightbuild query app --output=files

lightbuild resolve

プロジェクトの外部依存関係を解決し、モジュールのオフライン依存関係ロックファイル（resolved.deps）を生成します。

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
オプションまたは引数 説明
target 依存関係を解決するモジュール（例: app）。デフォルトは、現在のディレクトリの下にあるすべてのターゲットです。
--locked-dependencies ローカル依存関係ロックファイル（resolved.deps）が同期されていない場合、エラーが発生して終了します。
--cache=path 依存関係キャッシュを保存するディレクトリ。

たとえば、プロジェクト内のすべてのモジュールの resolved.deps ファイルを生成するには、次のコマンドを実行します。

lightbuild resolve

resolved.deps ファイルの詳細については、解決済みの依存関係をご覧ください。

lightbuild test

プロジェクト内のテストを実行します。開発マシンで実行されるローカルテストと、接続されたデバイスまたは実行中のエミュレータで実行されるインストルメンテーション テストがあります。1 つのモジュールをテストするには、app-core などのターゲットを指定します。1 種類のテストのみを実行するには、ローカルテストの場合は :hostTest、インストルメンテーション テストの場合は :deviceTest をターゲットに追加します。

lightbuild test [target] [--locked-dependencies]
オプションまたは引数 説明
target テストするターゲット。デフォルトは、プロジェクト内のすべてのテストです。
--locked-dependencies ローカルの依存関係ロックファイル（resolved.deps）が同期されていない場合、ビルドは失敗します。

たとえば、プロジェクト内のすべてのテストを実行するには、次のコマンドを実行します。

lightbuild test

app-core モジュールでローカルテストを実行するには、次のコマンドを実行します。

lightbuild test app-core:hostTest

デバイスまたはエミュレータで app-core モジュールのインストルメンテーション テストを実行するには、次のコマンドを実行します。

lightbuild test app-core:deviceTest