sparkling-app-cli

sparkling-app-cli

Workspace helper CLI for building, running, and managing Sparkling applications on Android and iOS.

Installation

Note: Projects created with create-sparkling-app already include sparkling-app-cli as a dependency. Manual installation is only needed for existing projects or global usage.

# Global installation
npm install -g sparkling-app-cli@latest

# Or add to an existing project
npm install sparkling-app-cli@latest --save-dev

Usage

# Build Lynx bundle (uses app.config.ts)
sparkling build

# Copy dist/ assets into Android/iOS resource folders
sparkling copy-assets

# Auto-link sparkling-method modules to native projects
sparkling autolink

# Build and run on Android emulator/device
sparkling run:android

# Build and run on iOS simulator
sparkling run:ios

Run sparkling --help to see all available commands and options.

Local testing

When developing inside the Sparkling monorepo, see LOCAL_TESTING.md for building this CLI, running sparkling / sparkling-app-cli from the workspace, and trying commands from an app directory.

Requirements

• Node.js >= 18

See Also

• create-sparkling-app - Create new Sparkling projects
• Sparkling Documentation