Installation#

Scaffold a Lynx app with the SignalX CLI, or add Lynx rendering to an existing SignalX project.

Prerequisites#

  • Node.js 20.19+ (or 22.12+)
  • For iOS: Xcode + an iOS simulator
  • For Android: Android Studio + an emulator

New project#

Terminal 
npm create @sigx@latest my-app -- --template lynx
cd my-app
pnpm install

Existing project#

Terminal 
pnpm add @sigx/lynx @sigx/lynx-plugin
pnpm add -D @sigx/lynx-cli

The CLI plugin registers the dev, build, prebuild, doctor and run:ios / run:android commands; the build plugin splits your source into the background + main-thread bundles Lynx requires.

Verify the toolchain#

Terminal 
sigx doctor

doctor checks your native toolchains and reports anything missing.

Next steps#

Continue with your first app.