📦 tauri-apps / tauri-plugin-updater

In-app updates for Tauri applications.

Install

This plugin requires a Rust version of at least 1.77.2

There are three general methods of installation that we can recommend.

• Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
• Pull sources directly from Github using git tags / revision hashes (most secure)
• Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

src-tauri/Cargo.toml

# you can add the dependencies on the `[dependencies]` section if you do not target mobile
[target."cfg(not(any(target_os = \"android\", target_os = \"ios\")))".dependencies]
tauri-plugin-updater = "2.0.0"
# alternatively with Git:
tauri-plugin-updater = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add @tauri-apps/plugin-updater
# or
npm add @tauri-apps/plugin-updater
# or
yarn add @tauri-apps/plugin-updater

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .setup(|app| {
            #[cfg(desktop)]
            app.handle().plugin(tauri_plugin_updater::Builder::new().build())?;
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { check } from '@tauri-apps/plugin-updater'
import { relaunch } from '@tauri-apps/plugin-process'
const update = await check()
if (update) {
  await update.downloadAndInstall()
  await relaunch()
}

Note that for these APIs to work you have to properly configure the updater first and generate updater artifacts. Please refer to the guide on our website for this.

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.