Relevant source files

The following files were used as context for generating this wiki page: - [crates/tauri-cli/src/main.rs](https://github.com/tauri-apps/tauri/blob/dev/crates/tauri-cli/src/main.rs) - [packages/cli/src/lib.rs](https://github.com/tauri-apps/tauri/blob/dev/packages/cli/src/lib.rs) - [pnpm-lock.yaml](https://github.com/tauri-apps/tauri/blob/dev/pnpm-lock.yaml) - [Cargo.toml](https://github.com/tauri-apps/tauri/blob/dev/Cargo.toml) - [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md)

# CLI コマンド一覧 ## はじめに Tauri の CLI は、デスクトップアプリケーションのビルド・開発・パッケージングを行う中心的なツールです。Rust で実装された `tauri-cli` バイナリは、`cargo-tauri` ラッパーや `cargo tauri` サブコマンドとして呼び出され、Node.js からは `@tauri-apps/cli` パッケージを通じて N-API 経由で利用できます。本ページでは、CLI のエントリポイント、引数処理、N-API ラッパー、そして主要コマンドの実行フローを図解しながら解説します。関連情報は `ARCHITECTURE.md` の *Tauri Tooling* セクションと合わせて参照してください。 ## 目次 1. [CLI バイナリのエントリポイント](#cli-バイナリのエントリポイント) 2. [引数解析とバイナリ名決定ロジック](#引数解析とバイナリ名決定ロジック) 3. [Node.js からの N-API ラッパー](#nodejs-からの-napi-ラッパー) 4. [コマンド実行フロー全体図](#コマンド実行フロー全体図) 5. [エクスポートされた N-API 関数一覧](#エクスポートされた-napi-関数一覧) 6. [主要コマンドの概要表](#主要コマンドの概要表) --- ## CLI バイナリのエントリポイント `crates/tauri-cli/src/main.rs` が実際の実行ファイルです。プラットフォームが macOS、Linux、Windows のいずれかである場合に `main` 関数が有効化され、以下の手順で処理が開始されます。 ```rust // 省略: platform guard fn main() { use std::env::args_os; // 省略: import let mut args = args_os().peekable(); // bin_name の決定ロジック (後述) … tauri_cli::run(args, bin_name) } ``` * `args_os()` でコマンドライン引数を取得し、`peekable()` で先頭要素の確認を可能にしています。 * `tauri_cli::run` は `tauri-cli` クレート内部の実装で、実際のコマンドディスパッチを行います。 Sources: [main.rs:1-45](https://github.com/tauri-apps/tauri/blob/dev/crates/tauri-cli/src/main.rs) ### 引数解析とバイナリ名決定ロジック `main.rs` の中で最初の引数（実行ファイル名）を解析し、以下の 3 つのケースに分岐します。 | ケース | 判定条件 | 生成される `bin_name` | |--------|----------|------------------------| | `cargo-tauri` が直接呼ばれた場合 | 第 1 引数が `cargo-tauri` かつ次が `tauri` | `"cargo tauri"` | | `cargo-tauri` が `cargo tauri` 形式で呼ばれた場合 | 第 1 引数が `cargo-tauri` かつ次が `tauri` でない | `"cargo-tauri"` | | その他 | 任意の実行ファイル名 | そのファイル名（文字列） | このロジックにより、`cargo tauri` と `cargo-tauri` の両方の呼び出し形態を統一的にハンドリングできます。 Sources: [main.rs:12-33](https://github.com/tauri-apps/tauri/blob/dev/crates/tauri-cli/src/main.rs) --- ## Node.js からの N-API ラッパー `packages/cli/src/lib.rs` は `@tauri-apps/cli` NPM パッケージの実装で、Rust の `tauri_cli` を Node.js から呼び出すためのブリッジです。主に 2 つのエクスポート関数が提供されています。 | 関数 | 説明 | 重要ポイント | |------|------|--------------| | `run` | CLI を非同期スレッドで実行し、完了結果を `ThreadsafeFunction` でコールバック | パニック捕捉 (`catch_unwind`) とエラーハンドリングを実装 | | `log_error` | ログレベル `error` で文字列を出力 | `log` クレートを使用 | ### `run` の実装概要 ```rust pub fn run( args: Vec, bin_name: Option, callback: Arc>, ) -> Result<()> { std::thread::spawn(move || { let res = match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| { tauri_cli::try_run(args, bin_name).inspect_err(|e| eprintln!("{e:#}")) })) { Ok(t) => t, Err(_) => { return callback.call( Err(Error::new(Status::GenericFailure, "Tauri CLI unexpected panic")), ThreadsafeFunctionCallMode::Blocking, ); } }; // 成功/失敗に応じてコールバック呼び出し match res { Ok(_) => callback.call(Ok(true), ThreadsafeFunctionCallMode::Blocking), Err(e) => callback.call( Err(Error::new(Status::GenericFailure, format!("{e:#}"))), ThreadsafeFunctionCallMode::Blocking, ), } }); Ok(()) } ``` * `std::thread::spawn` により Node.js のイベントループをブロックせずに CLI を実行。 * `tauri_cli::try_run` は実際のコマンドディスパッチ（`run` と同様）を行い、エラーは標準エラーへ出力。 * 成功時は `callback(true)`、失敗時はエラーメッセージ付きで `callback(false)` を呼び出す。 Sources: [lib.rs:1-55](https://github.com/tauri-apps/tauri/blob/dev/packages/cli/src/lib.rs) --- ## コマンド実行フロー全体図以下のフローダイアグラムは、CLI が **コマンドライン** から **Node.js** 経由で呼び出された場合の全体的な実行フローを示します。 ```mermaid graph TB A[Start] --> B[Read args] B --> C[Determine bin_name] C --> D[Call tauri_cli::run] D --> E[NAPI run spawn thread] E --> F[try_run #40;dispatch command#41;] F --> G[Callback success/failure] ``` * **A**: プロセス起動 (`main` または N-API `run`) * **B**: `std::env::args_os` で引数取得 * **C**: `bin_name` 判定ロジック（`cargo-tauri` / `cargo tauri`） * **D**: `tauri_cli::run` へ引数とバイナリ名を渡す * **E**: `packages/cli` の `run` がスレッドを生成し `try_run` を呼び出す * **F**: `tauri_cli::try_run` が実際のサブコマンド（`dev`, `build`, `init` など）を実行 * **G**: 結果を `ThreadsafeFunction` で Node.js に返す Sources: [main.rs:1-45](https://github.com/tauri-apps/tauri/blob/dev/crates/tauri-cli/src/main.rs), [lib.rs:1-55](https://github.com/tauri-apps/tauri/blob/dev/packages/cli/src/lib.rs) --- ## エクスポートされた N-API 関数一覧 | 関数名 | Rust シグネチャ | Node.js からの呼び出し例 | |--------|----------------|--------------------------| | `run` | `fn run(args: Vec, bin_name: Option, callback: Arc>) -> Result<()>` | `cli.run(['tauri', 'dev'], null, (err, ok) => { … })` | | `log_error` | `fn log_error(error: String)` | `cli.log_error('unexpected error')` | * `run` は非同期で実行され、完了時に `callback` が呼び出されます。 * `log_error` は単純に `log::error!` へ委譲します。 Sources: [lib.rs:1-55](https://github.com/tauri-apps/tauri/blob/dev/packages/cli/src/lib.rs) --- ## 主要コマンドの概要表 `tauri-cli` が提供する代表的なサブコマンドは `ARCHITECTURE.md` の *Tauri Tooling* セクションで言及されています。実装は `tauri_cli` クレート内部にありますが、ここではユーザーが頻繁に使用するコマンドをまとめます。 | コマンド | 説明 | 主な用途 | |----------|------|----------| | `tauri dev` | 開発モードでアプリを起動 | Webview と Rust バックエンドのライブリロード | | `tauri build` | アプリを各プラットフォーム向けにビルド | 実行可能バイナリとインストーラ生成 | | `tauri init` | 新規プロジェクトの雛形作成 | `cargo new` 後のセットアップ自動化 | | `tauri info` | 現在の環境情報を表示 | Rust、Node、OS のバージョン確認 | | `tauri icon` | アイコンの生成・変換 | アプリのプラットフォーム別アイコン作成 | > これらのコマンドはすべて `tauri_cli::run` が内部で `match` し、対応するロジックへディスパッチします（実装は `tauri-cli` クレート内に隠蔽）。 Sources: [ARCHITECTURE.md:45-78](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) --- ## まとめ Tauri の CLI は、Rust で実装された高速かつ安全なコマンドラインツールであり、`cargo-tauri` / `cargo tauri` のエイリアスを通じて呼び出されます。`crates/tauri-cli/src/main.rs` がエントリポイントを提供し、引数解析とバイナリ名の決定を行った後、`tauri_cli::run` に処理を委譲します。Node.js からは `packages/cli/src/lib.rs` の N-API ラッパーが非同期実行とコールバック機構を提供し、開発者は JavaScript/TypeScript からシームレスに CLI を操作できます。主要コマンド（`dev`, `build`, `init` など）はすべてこのフローの中でディスパッチされ、プラットフォーム横断的な開発体験を実現しています。 ---