{"id":15013106,"url":"https://github.com/tauri-apps/tauri-plugin-updater","last_synced_at":"2025-10-23T17:21:39.398Z","repository":{"id":168019010,"uuid":"643517235","full_name":"tauri-apps/tauri-plugin-updater","owner":"tauri-apps","description":"[READ ONLY] This repository is a mirror, for issue tracking and development head to: https://github.com/tauri-apps/plugins-workspace","archived":false,"fork":false,"pushed_at":"2024-10-08T07:30:39.000Z","size":661,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"v2","last_synced_at":"2024-10-29T15:44:12.305Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tauri-apps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.spdx","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-21T12:21:35.000Z","updated_at":"2024-10-08T07:30:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"d9d8d17d-63df-4ef0-b845-8d34fe467cfe","html_url":"https://github.com/tauri-apps/tauri-plugin-updater","commit_stats":{"total_commits":139,"total_committers":16,"mean_commits":8.6875,"dds":0.8273381294964028,"last_synced_commit":"c9461a77dcf7ad0953ea58a1ecb0e12536308739"},"previous_names":["tauri-apps/tauri-plugin-updater"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tauri-apps","download_url":"https://codeload.github.com/tauri-apps/tauri-plugin-updater/tar.gz/refs/heads/v2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237143852,"owners_count":19262287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T19:43:45.271Z","updated_at":"2025-10-23T17:21:39.386Z","avatar_url":"https://github.com/tauri-apps.png","language":"Rust","funding_links":["https://opencollective.com/tauri"],"categories":[],"sub_categories":[],"readme":"![plugin-updater](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/updater/banner.png)\n\nIn-app updates for Tauri applications.\n\n| Platform | Supported |\n| -------- | --------- |\n| Linux    | ✓         |\n| Windows  | ✓         |\n| macOS    | ✓         |\n| Android  | x         |\n| iOS      | x         |\n\n## Install\n\n_This plugin requires a Rust version of at least **1.77.2**_\n\nThere are three general methods of installation that we can recommend.\n\n1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)\n2. Pull sources directly from Github using git tags / revision hashes (most secure)\n3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)\n\nInstall the Core plugin by adding the following to your `Cargo.toml` file:\n\n`src-tauri/Cargo.toml`\n\n```toml\n# you can add the dependencies on the `[dependencies]` section if you do not target mobile\n[target.\"cfg(not(any(target_os = \\\"android\\\", target_os = \\\"ios\\\")))\".dependencies]\ntauri-plugin-updater = \"2.0.0\"\n# alternatively with Git:\ntauri-plugin-updater = { git = \"https://github.com/tauri-apps/plugins-workspace\", branch = \"v2\" }\n```\n\nYou can install the JavaScript Guest bindings using your preferred JavaScript package manager:\n\n```sh\npnpm add @tauri-apps/plugin-updater\n# or\nnpm add @tauri-apps/plugin-updater\n# or\nyarn add @tauri-apps/plugin-updater\n```\n\n## Usage\n\nFirst you need to register the core plugin with Tauri:\n\n`src-tauri/src/lib.rs`\n\n```rust\nfn main() {\n    tauri::Builder::default()\n        .setup(|app| {\n            #[cfg(desktop)]\n            app.handle().plugin(tauri_plugin_updater::Builder::new().build())?;\n            Ok(())\n        })\n        .run(tauri::generate_context!())\n        .expect(\"error while running tauri application\");\n}\n```\n\nAfterwards all the plugin's APIs are available through the JavaScript guest bindings:\n\n```javascript\nimport { check } from '@tauri-apps/plugin-updater'\nimport { relaunch } from '@tauri-apps/plugin-process'\nconst update = await check()\nif (update) {\n  await update.downloadAndInstall()\n  await relaunch()\n}\n```\n\nNote 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](https://v2.tauri.app/plugin/updater/) for this.\n\n## Contributing\n\nPRs accepted. Please make sure to read the Contributing Guide before making a pull request.\n\n## Partners\n\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"middle\"\u003e\n        \u003ca href=\"https://crabnebula.dev\" target=\"_blank\"\u003e\n          \u003cimg src=\"https://github.com/tauri-apps/plugins-workspace/raw/v2/.github/sponsors/crabnebula.svg\" alt=\"CrabNebula\" width=\"283\"\u003e\n        \u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).\n\n## License\n\nCode: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.\n\nMIT or MIT/Apache 2.0 where applicable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftauri-apps%2Ftauri-plugin-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-updater/lists"}