shun 0.2.0

English · 简体中文 · 繁體中文 · 日本語 · 한국어 · Français · Русский · Español

Shun packages the delivery half of shipping desktop software. The delivery flow is declared in the application's own Cargo.toml ([package.metadata.shun] — the cargo-deb / cargo-wix pattern) and one config document drives both the build CLI and the runtime shell:

• a payload — the app directory packed once, embedded into a single-file installer or carried as a sidecar;
• a flow — choose a mode, choose a target, stream real progress events;
• pluggable targets:
  • install — NSIS-like registration (per-user ARP entry, self-copying uninstaller, start-menu shortcut, deep links) and a portable mode that writes no registry at all;
  • flash — write an image onto a block device with post-write verification.

On Windows, a dual-variant WebView2 strategy covers clean machines: a standard artifact that requires the system runtime, and a fully self-contained artifact that carries a fixed-version WebView2 runtime privately — one copy shared by the installer shell and the installed app across install and portable modes, no admin, no system writes. For machines where even that is not available, the installer shell embeds an egui fallback UI: the same flow, the same manifest, no WebView2 at all — selected automatically when the runtime is missing (the banner says so) or manually via --fallback.

Example

One comprehensive demo covers delivery end to end. The payload is a real Tauri 2 application (demo-app/) with a sample UI, the installer shell (shell/, built on @celestia-island/hikari) embeds it at build time, and the whole thing is declared by a single delivery manifest:

just demo                                               # stage demo app → build → run the installer shell
just demo -- --fallback                                 # force the offline egui shell (no WebView2)
cargo run --example demo_flash                          # enumerate flash-candidate devices
cargo run --example demo_install                        # CLI integration check (generate .shun + local install)
cargo run --example demo_install -- --portable          # portable install (no registry)
cargo run --example demo_install -- --uninstall         # remove the install (all traces)

The delivery manifest lives in the demo application's own Cargo.toml (the cargo-deb / cargo-wix pattern — the shell resolves it at build time, so installer and app describe one product):

[package.metadata.shun]
product = "ShunDemo"
publisher = "celestia-island"
logo = "../docs/logo.webp"
payload = "../examples/demo_payload"
main-exe = "bin/shun-demo.exe"

[package.metadata.shun.install]
local = true
portable = true

The payload root keeps small committed data files; the application binary is a build product staged into bin/ by just demo-payload (never committed). demo_install generates the installer package ShunDemo.shun (zstd tar + SHA-256 manifest) in the working directory, extracts it with streamed progress, and — in local mode — performs the NSIS-like registration described above.

See docs/en/guides/configuration.md (简体中文) for the full reference, including the WebView2 strategy matrix.

Status

0.2 cut. The registration surface now spans Windows (per-user and machine-wide installs, desktop/start-menu shortcuts with AUMID, Explorer context-menu verbs, deep links), Linux (.desktop launchers with desktop actions), and macOS (.app completion + Launch Services), behind a declarative wizard pipeline. The crate is settling against three real consumers in the celestia ecosystem — the WoWSP installer shell, shittim-chest local, and the evernight image flasher (which lands the flash target's block-device write backend). Active development happens on the dev branch; master carries the release history. APIs track the three consumers between minor versions — expect additive changes and upstream proposals from their integration feedback (e.g. a flash-specific FlowPhase variant and a Backend(String) error kind, both raised by the evernight flasher integration).

Structure

Development

just fetch   # stage shared celestia-devtools recipes (once)
just ci      # fmt-check + clippy + test

Workflow: rapid preparation happens on dev; master receives the initial release commit, after which everything lands through PRs.

License

SySL-1.0 — see LICENSE.