Lattice UI Docs Docs

CLI Overview

Use the Lattice UI CLI to create projects and manage component dependencies.

On this page

Audience: app developers integrating Lattice UI in project repositories.

The lattice CLI is the recommended way to scaffold and maintain Lattice dependencies. It supports both interactive flows and explicit non-interactive runs, and the current docs track the unreleased init workflow on main.

What the CLI Covers

  • create: scaffold a new rbxts-based project
  • init: bootstrap Lattice inside an existing project with safe template merging
  • add: install components by name and/or preset
  • remove: remove selected component packages
  • upgrade: update installed @lattice-ui/* packages
  • doctor: validate lockfiles, peers, providers, and registry alignment

Execution Modes

Global CLI

npm i -g ${latticeSnapshot.cli.packageName}
lattice --help

Monorepo Local Script

Monorepo local script

Run CLI commands through your package manager wrapper when using local dependencies.

pnpm lattice --help

The published package currently exposes these binaries:

  • lattice
  • lattice-ui

Learn the Workflow