CLI

The lattice CLI scaffolds new rbxts/react games, installs primitive packages with their required peers and providers, and audits an existing project for missing dependencies. It is published to npm as lattice-ui and exposes two equivalent binaries, lattice and lattice-ui.

Use it when you want package selection, peer resolution and health checks handled for you rather than editing package.json by hand.

Running the CLI

The CLI requires Node 20+. Run it on demand with npx — no install needed:

npx lattice-ui <command> [options]

Or install it globally to get the shorter lattice binary:

pnpm add lattice-ui

npm install lattice-ui

yarn add lattice-ui

bun add lattice-ui

npm i -g lattice-ui
lattice <command> [options]

Both binaries run the same program. lattice help prints the usage summary, lattice version the installed version.

Help

Every command has its own help page, and three spellings reach it:

lattice add --help

lattice help add

A malformed run reaches it too — lattice add --bogus --help prints the add page rather than complaining about the unknown option first.

A command’s page lists its usage, options and examples. For add, remove and upgrade it also lists every available component and preset.

Global options

An unknown option is a usage error, but not a bare one: the CLI suggests the closest valid name and points at the relevant help page.

Unknown option for add: --prest
  Did you mean --preset?
  Run `lattice add --help` to see the supported options.

The same suggestion machinery covers command, component and preset names, so lattice add dialogg proposes dialog. Names are validated before a package manager is resolved, so a typo cannot surface an unrelated package-manager error first.

Terminal behavior

Colour honours the NO_COLOR/FORCE_COLOR contract first, then falls back to TTY detection. TERM=dumb always disables it.

Project paths and package names print as OSC 8 hyperlinks, shortened against the working directory and ~. They are off automatically under CI and outside a terminal, since a few terminals print the raw escape sequence.

Output

Each run prints as one connected flow. A vertical gutter threads the header, each titled block and the closing verdict. Rows inside a block get tree branches, and the elapsed time lands on the last line. Counts live in the heading of the block they describe.

Commands also report which package manager they resolved and why.

While a progress spinner is running, the package manager’s own output is buffered and surfaced only if the command fails. Pass --verbose to stream it live instead.

Interactive prompts

Selection prompts are keyboard-driven.

The list scrolls when it is taller than the terminal, keeping the cursor in view. Cancelling restores the cursor and takes the terminal out of raw mode.

Commands

create

Scaffolds a new project into an optional [project-path] (defaults to the current directory) from the rbxts template.

npx lattice-ui create my-game --pm npm --git --no-lint

init

Initializes Lattice inside an existing project. Unlike create, it accepts no positional path and no --git/--no-lint flags, and it supports --dry-run.

npx lattice-ui init --dry-run

init is also the migration path off the 0.6.1 rename. Before merging the template it rewrites any pre-0.6.1 package names to their react- replacements, such as @lattice-ui/dialog to @lattice-ui/react-dialog and @lattice-ui/core to @lattice-ui/react-runtime. Dropping the old name matters — leaving both makes the two copies resolve side by side, which npm rejects on peer resolution.

If the install fails, init and create roll their file changes back rather than leaving a half-written scaffold.

add

Installs one or more component packages with everything they need. Pass component names, comma- or space-separated, and --preset groups. With neither, and without --yes, add prompts interactively. lattice add --help lists every available component and preset.

npx lattice-ui add dialog,toast --preset overlay

For each component the CLI gathers its npm package, its peers and any required providers, then installs the set minus whatever is already present. Optional providers are suggested but not installed.

remove

Removes the selected component packages. Accepts the same selection inputs and flags as add.

npx lattice-ui remove dialog --dry-run

upgrade

Upgrades installed @lattice-ui/* packages, with the same selection inputs and flags as add and remove. Pre-0.6.1 names are skipped rather than upgraded — run init to rewrite them first.

npx lattice-ui upgrade --dry-run

doctor

Audits the project and reports issues without changing anything, then finishes with recommended commands. It checks for:

Errors exit non-zero. Warnings do not.

npx lattice-ui doctor

Presets

Presets are named bundles of components so you can install a related set in one go with --preset.

Package manager resolution

With --pm omitted, the CLI resolves a package manager from the project lockfile or installed managers. doctor surfaces resolution problems: a missing lockfile, multiple lockfiles, or a packageManager field that does not match.

The resolved manager is also pinned into the project as a devEngines.packageManager entry. add, remove and upgrade reapply it before they touch dependencies. A pin naming a different manager warns and repins. Both managers refuse to install when the pin names the other one.

Dry runs

init, add, remove and upgrade all accept --dry-run, which prints the exact package-manager command it would run and reports what it would do.

Related

• Installation
• Migration
• Package stability
• Portals and layers