@sigx/lynx-updates · Beta

Installation#

Add @sigx/lynx-updates to your project.

Install the package#

Terminal

pnpm add @sigx/lynx-updates

npm install @sigx/lynx-updates

yarn add @sigx/lynx-updates

bun add @sigx/lynx-updates

Native setup#

Native modules are autolinked by @sigx/lynx-cli — run a prebuild after installing:

Terminal

sigx prebuild

Prebuild also computes a runtime fingerprint from the linked native modules, the Lynx SDK version, and the scaffold revision, and bakes it into the binary. sigx updates:publish stamps the same fingerprint into the manifest so the client only applies bundles compatible with the installed native build (see Runtime-version compatibility).

Configure#

Declare the update behavior once in main.tsx, before defineApp():

TSX

import { defineApp } from '@sigx/lynx';
import { defineUpdates } from '@sigx/lynx-updates';
import App from './App';

defineUpdates({
  provider: { url: 'https://cdn.example.com/myapp/production/manifest.json' },
});

defineApp(<App />).mount(null);

For prebuilt UI (prompt, blocking gate, progress, restart banner), add @sigx/lynx-updates-ui.