Installation#

Add @sigx/lynx-cli to your project.

Requirements#

• Node.js 22+
• @sigx/cli 0.12 or later, which provides the sigx binary the plugin registers its commands with
• For Android builds, JDK 17–26 and the Android SDK; for iOS, macOS with Xcode 15+ and CocoaPods. See Installation in the Lynx guide.

Install the package#

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

npm install -D @sigx/cli @sigx/lynx-cli

yarn add -D @sigx/cli @sigx/lynx-cli

bun add -D @sigx/cli @sigx/lynx-cli

A Lynx app scaffolded with npm create @sigx@latest my-app -- --kind lynx already has both.

Native setup#

Generate the native projects:

sigx prebuild

Scaffolded apps also have this as the native:prebuild script (npm run native:prebuild). Apps created before @sigx/cli 0.13 named it prebuild, which npm also ran before every npm run build; rename it to native:prebuild.

Check the toolchain#

pnpm dlx sigx doctor

npx sigx doctor

yarn dlx sigx doctor

bunx sigx doctor

Every problem gets a fix: line, and doctor exits non-zero on errors. See Troubleshooting.

Verify#

import * as CLIPlugin from '@sigx/lynx-cli';

console.log(Object.keys(CLIPlugin));