CLI reference

Every command the lumioui binary ships.

lumioui init

npx @lumioui/cli init [-y] [-c ./my-app]

lumioui add

npx @lumioui/cli add button card
npx @lumioui/cli add pro/paywall-sheet
npx @lumioui/cli add --all
npx @lumioui/cli add badge --design glass
npx @lumioui/cli add button --overwrite --dry-run

Resolves registryDependencies topologically (Kahn sort), installs nativeDeps with your package manager, writes files[].target. Prefix a name with pro/ for Pro items — requires LUMIO_LICENSE_KEY sent as Bearer.

flag	effect
--all, -a	add every free component
--design <design>	resolve a family name to its design variant — badge --design glass installs badge-glass (values today: lumo, glass); falls back to the base component with a warning when the variant doesn't exist
--overwrite, -o	overwrite files that already exist in components/ui
--dry-run	resolve + print the plan without writing files
--cwd <path>, -c	run against a project other than process.cwd()

Pro install needs your license key in the environment:

export LUMIO_LICENSE_KEY=lumio_…   # create one at /account
npx @lumioui/cli add pro/paywall-sheet

lumioui list

npx @lumioui/cli list
npx @lumioui/cli list --pro
npx @lumioui/cli list --type screen

Groups the catalog by section — screens by flow, blocks by parent component, components by category. --type accepts component, block, or screen.

lumioui doctor

npx @lumioui/cli doctor

Checks RN project, nativewind/reanimated/safe-area/svg, babel preset, lumioui.json, components/ui, license env.

// ask an llm chatgpt ↗ · claude ↗