tauri 备忘清单

这个 tauri 快速参考备忘单显示了它的常用命令使用清单

入门

快速开始

Bash

sh <(curl https://create.tauri.app/sh)

PowerShell

C:\> irm https://create.tauri.app/ps | iex

Cargo

$ cargo install create-tauri-app --locked
$ cargo create-tauri-app

npm/yarn/pnpm/bunx

$ npm create tauri-app@latest
$ yarn create tauri-app
$ pnpm create tauri-app
$ bunx create-tauri-app

依赖环境

软件描述
rustrust安装
nodejsnodejs安装
Windows Build ToolsMicrosoft C++ 生成工具 (for windows)
Android Studio安卓开发工具

启动 Tauri 开发窗口

$ npm run tauri dev
$ yarn tauri dev
$ pnpm tauri dev
$ bunx tauri dev
$ cargo tauri dev

检测最新版本的 Tauri

$ npm outdated @tauri-apps/cli
$ yarn outdated @tauri-apps/cli
$ pnpm add -D @tauri-apps/cli
$ npm outdated @tauri-apps/cli

更新 npm 包

$ npm install @tauri-apps/cli@latest @tauri-apps/api@latest
$ yarn upgrade @tauri-apps/cli @tauri-apps/api --latest
$ yarn up @tauri-apps/cli @tauri-apps/api
$ pnpm update @tauri-apps/cli @tauri-apps/api --latest
$ bun update @tauri-apps/cli @tauri-apps/api

更新 Cargo 包

打开 src-tauri/Cargo.toml 并更改 tauri 和 tauri-build

[build-dependencies]
tauri-build = "%version%"

[dependencies]
tauri = { version = "%version%" }

其中 %version% 是上面相应的版本号

$ cd src-tauri
$ cargo update

应用程序调试

代码中输出日志方法

println!("Message from Rust: {}", msg);

在 Linux 和 macOS 上通过下面命令重新运行

RUST_BACKTRACE=1 tauri dev

Window 上这样开启

set RUST_BACKTRACE=1 
tauri dev

以编程方式打开 Devtools

use tauri::Manager;
tauri::Builder::default()
  .setup(|app| {
    #[cfg(debug_assertions)] // 仅在调试构建时包含此代码
    {
      let window = app.get_window("main").unwrap();
      window.open_devtools();
      window.close_devtools();
    }
    Ok(())
  });

在生产中使用检查器

$ npm run tauri build -- --debug
$ yarn tauri build --debug
$ pnpm tauri build --debug
$ bunx tauri build --debug
$ cargo tauri build --debug

启用开发工具功能

[dependencies]
tauri = { version = "...", features = ["...", "devtools"] }

在文件 src-tauri/Cargo.toml 中启用 devtools Cargo 功能

安卓开发

环境变量

JAVA_HOME

ANDROID_HOME

NDK_HOME

准备目标

$ npm install @tauri-apps/cli@next @tauri-apps/api@next
$ npm run tauri migrate
$ rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
$ rm -r src-tauri/gen
$ npm run tauri android init
$ npm run tauri icon

修改应用名：%app_path%\src-tauri\gen\android\app\src\main\res\values\strings.xml

编译

$ npm run tauri android dev
$ npm run tauri android build

签名

$ keytool -genkey -alias android.keystore -keyalg RSA -validity 20000 -keystore android.keystore
$ zipalign -p -f -v 4 unsigned.apk release.apk
$ apksigner sign --ks android.keystore release.apk

配置

配置结构

默认配置 tauri.conf.json，还支持 tauri.conf.json5 和 Tauri.toml

----
package包设置
tauriTauri 配置
build构建配置
plugins插件配置

下面配置能与主配置进行合并

  • tauri.linux.conf.json 或 Tauri.linux.conf.toml
  • tauri.windows.conf.json 或 Tauri.windows.conf.toml
  • tauri.macos.conf.json 或 Tauri.macos.conf.toml

示例

{
  "build": { ... },
  "package": { ... },
  "tauri": { ... }
}

Tauri 配置

配置Type描述
patternPatternKind应用程序名称
versionWindowConfig[]应用程序版本
cliCliConfigCLI 配置
bundleBundleConfig打包器配置
allowlistAllowlistConfig允许列表配置
securitySecurityConfig安全配置
updaterUpdaterConfig更新程序配置
systemTraySystemTrayConfig配置应用系统托盘
macOSPrivateApibooleanmacOS 私有API配置

CliConfig

配置Type描述
descriptionstring?将显示在帮助信息中
longDescriptionstring?将显示在帮助信息中
beforeHelpstring?该信息显示在自动生成的帮助信息之前。这通常用于标题信息
afterHelpstring?显示在自动生成的帮助信息之后。通常用于描述如何使用参数，或者需要注意的注意事项
argsarray?命令的参数列表
subcommandsobject?该命令的子命令列表

描述 CLI 配置

Package 配置

配置描述
productName应用程序名称
version应用程序版本

WindowConfig

窗口配置对象

配置Type默认值描述
labelstringnull窗口标识符
urlWindowUrlview窗口的 webview URL
userAgentuserAgent?nullwebview 的用户代理
fileDropEnabledbooleantrue是否在 Web 视图上启用文件放置
centerbooleanfalse窗口是否开始居中
xnumber?null窗口左上角的水平位置
ynumber?null窗口左上角的水平位置
widthnumber800窗口宽度
heightnumber600窗口高度
minWidthnumbernull最小窗口宽度
minHeightnumbernull最小窗口高度

PatternKind

应用模式。可以是以下类型中的任意一种：

棕地模式

{ "use": "brownfield" }

隔离模式。建议出于安全目的

{ 
  "use": "isolation",
  "options": { "dir": string }
}

WindowUrl

要在 Tauri Web 视图窗口中打开的 URL。可以是以下任何一种类型：

  • string (format: uri)：外部 URL。
  • string：应用程序 URL 的路径部分。例如，要加载 tauri://localhost/users/john，只需在此配置中提供 users/john

SystemTrayConfig

配置Type默认值描述
iconPathstring(必填)null系统托盘上使用的默认图标的路径
iconAsTemplatebooleanfalse用于确定图像是否代表 macOS 上的模板图像
menuOnLeftClickbooleantrue确定在 macOS 上托盘图标收到左键点击时菜单是否应该出现
titlestring?nullMacOS 托盘标题

应用程序系统托盘图标的配置