gpui-updater

Cross-platform self-update for GPUI desktop apps, hosted on GitHub Releases, static JSON manifests, or Sparkle appcasts, and on macOS optionally driven by Sparkle itself.

GPUI ships no updater of its own, and Zed's auto_update crate is GPL-licensed and wired to Zed's private update server. gpui-updater is an independent, MIT/Apache implementation of the same idea: check a release source, download the platform artifact, verify it, and swap it into place.

Features

Crates

The core and the two adapters are alternatives, not dependencies to combine; gpui-updater-sparkle is additive. Both adapters re-export the entire core API, and only the adapters export Updater. The Rust versions are tested support floors (1.85.0 and 1.98.1), not a claim that older compilers fail.

Installation

[dependencies]
# Core only (blocking engine, no GPUI):
gpui-updater-core = "0.4"

# OR official GPUI (Entity<Updater>):
gpui = "0.2.2"
gpui-updater = "0.4"

# OR gpui-pre (keep existing gpui_updater imports via an alias):
gpui = { package = "gpui-pre", version = "0.3.4" }
gpui-updater = { package = "gpui-updater-pre", version = "0.4" }

# Optional, next to either adapter: hand the macOS flow to Sparkle 2.
gpui-updater-sparkle = "0.4"

Add features = ["delta"] to the core or adapter dependency for delta updates. Without the alias, pre imports use gpui_updater_pre.

Quick start

In a GPUI app, build the entity once, observe it, and drive it from a button:

use gpui_updater::{EngineConfig, GitHubSource, UpdateStatus, Updater, Version};

let updater = cx.new(|cx| {
    Updater::new(
        GitHubSource::new("AprilNEA", "OpenLogi")
            .asset_contains("macos")
            .asset_contains(".dmg")
            .with_checksums("SHA256SUMS"),
        EngineConfig::new(Version::parse(env!("CARGO_PKG_VERSION")).unwrap()),
        cx,
    )
});
cx.observe(&updater, |_, _, cx| cx.notify()).detach();

// In the "Check for updates" button handler:
updater.update(cx, |updater, cx| match updater.status() {
    UpdateStatus::Available(_) => updater.download_and_install(cx),
    UpdateStatus::Downloading { .. } => updater.cancel(cx),
    UpdateStatus::Staged(_) => updater.restart(cx),
    _ => updater.check(cx),
});

Without GPUI, the core runs the same steps as blocking calls:

use gpui_updater_core::{EngineConfig, GitHubSource, UpdateEngine, Version};

let engine = UpdateEngine::new(
    GitHubSource::new("AprilNEA", "OpenLogi").with_checksums("SHA256SUMS"),
    EngineConfig::new(Version::parse(env!("CARGO_PKG_VERSION"))?),
);
if let Some(release) = engine.check()? {
    let artifact = engine.download(&release, |done, total| { /* progress */ })?;
    engine.install(&artifact)?;
}

The gpui_updater documentation covers status values, errors, cancelling, and the Sparkle driver. The gpui_updater_core documentation lists a guide for each topic.

Platform notes

The install guide has the details. The adapters need their GPUI backend's native toolchain, including Xcode and Metal on macOS; the core needs neither GPUI nor a graphics toolchain.

Known issue: on Linux with registry gpui 0.2.2, libc 0.2.190 removed ENOATTR, which breaks xattr 0.2.3 (pulled in by gpui_http_client → zed-async-tar). If a fresh lockfile picks that libc, hold it back with cargo update -p libc --precise 0.2.189. gpui-pre is not affected.

Upgrading

MIGRATING.md lists the breaking changes of each release: from 0.3, from 0.2, from 0.1, and from 0.0.x. The releases page lists what each release adds.

Contributing

CONTRIBUTING.md lists the checks to run, the release order, and where documentation lives.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT license (LICENSE-MIT)

at your option.