#Sparkling CLI

Sparkling CLI (sparkling-app-cli) is the built-in command-line tool that powers the development workflow. It handles building Lynx bundles, autolinking native method modules, running apps on Android/iOS, and diagnosing your environment.

#Installation

The CLI is included automatically when you scaffold a project with create-sparkling-app. You can also install it manually:

npm install sparkling-app-cli

Once installed, run commands via npx sparkling or through the npm scripts defined in your project's package.json.

#Commands

#sparkling build

Build Lynx bundles using your project's app.config.ts.

npx sparkling build

By default, asset copying is skipped for faster iteration during development. Use --copy when you need the bundles inside the native projects (e.g. for a release build).

#sparkling copy-assets

Copy compiled bundles into Android and iOS resource directories.

npx sparkling copy-assets

#sparkling autolink

Discover and link Sparkling method modules for Android and iOS. The CLI scans for module.config.json files in the workspace and node_modules, then updates Gradle/Podfile config and generates registry files.

npx sparkling autolink

What it does:

• Android — Updates settings.gradle(.kts) and app/build.gradle(.kts) with module includes/dependencies, and generates SparklingAutolink.kt.
• iOS — Updates the Podfile with pod entries and generates SparklingAutolink.swift.

#sparkling run:android

Build, autolink, and launch the Android debug build in one step.

npx sparkling run:android

This command will:

1. Autolink method modules for Android
2. Build the Lynx bundle
3. Run gradlew assembleDebug
4. Install the APK on a connected device/emulator
5. Launch the main activity

#sparkling run:ios

Build, autolink, and launch the iOS simulator build in one step.

npx sparkling run:ios

This command will:

1. Pick a simulator (prefers a booted device; falls back to common names like iPhone 17 Pro)
2. Autolink method modules for iOS
3. Run pod install (unless --skip-pod-install)
4. Build the Lynx bundle
5. Build, install, and launch the app on the simulator

You can also set the SPARKLING_IOS_SIMULATOR environment variable to specify a default simulator.

#sparkling doctor

Verify that your development environment is properly set up.

npx sparkling doctor

The doctor command checks:

If any check fails, the output includes a hint on how to fix it.

#Global Options

All commands support the following flag:

You can also set the SPARKLING_VERBOSE environment variable for the same effect.

#Typical Workflow

# 1. Create a project
npm create sparkling-app@latest my-app
cd my-app

# 2. Check your environment
npx sparkling doctor

# 3. Run on Android
npx sparkling run:android

# 4. Run on iOS
npx sparkling run:ios

# 5. Build bundles for release
npx sparkling build --copy