Installation#

Installing the CLI#

Add @sigx/cli as a dev dependency and run it through your package runner:

Terminal

pnpm add -D @sigx/cli

npm install -D @sigx/cli

yarn add -D @sigx/cli

bun add -D @sigx/cli

Terminal

pnpm dlx sigx info

npx sigx info

yarn dlx sigx info

bunx sigx info

The package exposes a single binary, sigx. It is ESM-only ("type": "module"), so it requires a Node.js version with native ESM support.

You usually do not install the CLI by hand: projects created with sigx create already depend on @sigx/cli. You can also scaffold without a local install using npx sigx create or:

Terminal

pnpm create @sigx@latest

npm create @sigx@latest

yarn create @sigx@latest

bun create @sigx@latest

No config or Vite wiring required#

There is no Vite or config file wiring needed to use @sigx/cli itself. The core commands (sigx create, sigx info) work as soon as the binary is available.

Everything beyond the two core commands is provided by plugins that the CLI discovers at runtime (see Authoring Plugins). To enable those commands, install the relevant plugin package in your project.

Runtime dependencies#

@sigx/cli pulls in a small set of runtime dependencies:

@sigx/args — the fluent, type-aware command/argument parser. It backs both the core commands and the args declared by plugins (see Authoring Plugins).
@sigx/terminal — the terminal UI used by the interactive create prompts and by the shell runtime that plugin commands host their dashboards in. The prompt kit is lazy-loaded, so it is only imported when you actually run sigx create interactively.

Entry points#

@sigx/cli exposes four entry points:

Import	Provides
`@sigx/cli`	`definePlugin`, `a`, and the plugin types — the public API.
`@sigx/cli/plugin`	The same plugin surface (preferred for plugin authors).
`@sigx/cli/create`	`runCreate` — the `create` command entry point.
`@sigx/cli/shell`	`runShell` and the shell runtime for hosting a TUI dashboard.

Plugin packages behind each command#

Only info and create ship inside @sigx/cli. The rest are contributed by plugins and require the matching package to be installed in your project:

Command	Provided by	Used for
`sigx create`	`@sigx/cli` (core)	Scaffolding new projects
`sigx info`	`@sigx/cli` (core)	Environment & project diagnostics
`sigx dev`	`@sigx/vite` (web) / `@sigx/lynx-cli` (Lynx)	Start the dev server
`sigx build`	`@sigx/vite` (web) / `@sigx/lynx-cli` (Lynx)	Production build
`sigx preview`	`@sigx/ssg`	Serve a built SSG site
`sigx prebuild`	`@sigx/lynx-cli`	Generate native iOS/Android project files
`sigx run:android`	`@sigx/lynx-cli`	Build & launch on Android
`sigx run:ios`	`@sigx/lynx-cli`	Build & launch on iOS
`sigx doctor`	`@sigx/lynx-cli`	Verify the Lynx toolchain

A plugin's commands only register when its detect(cwd) check returns true for your project, so installing a plugin does not pollute your command list in unrelated projects.

Lynx native toolchain#

If you scaffold a Lynx project (or sigx info detects a Lynx config), the platform commands additionally rely on the native toolchain — rspeedy, the Android SDK (ANDROID_HOME / ANDROID_SDK_ROOT), a JDK, ADB, and on macOS Xcode and CocoaPods. Run sigx info to probe what is installed; sigx doctor (from @sigx/lynx-cli) verifies the toolchain in more detail.

Next steps#

Commands — full reference for every command and its flags.
Authoring Plugins — add your own commands to the CLI.