CLI – suiss/uim

Overview

@esuiss/uim runs with npx and is never installed in your project. It has two commands: init and add.

init

Sets up the styling, the theme and the button component. See Installation for every step.

$ pnpm dlx @esuiss/uim@latest

Option	Description
`-s, --styling <uniwind\|nativewind\|stylesheet>`	Styling to use, detected from the project when omitted
`-y, --yes`	Skip confirmation prompts
`-c, --cwd <dir>`	Run in another project directory
`-h, --help`	Show help
`-v, --version`	Show the version

add

Copies components into your project, together with the components and packages they depend on.

$ pnpm dlx @esuiss/uim@latest add [options]$ $ pnpm dlx @esuiss/uim@latest add <component...> [options]

Option	Description
`-a, --all`	Add every component
`--diff`	Show how local files differ from the registry
`-o, --overwrite`	Replace local files that differ from the registry
`-y, --yes`	Skip confirmation prompts
`-c, --cwd <dir>`	Run in another project directory

Pick from a list

Run add without names to pick from a list. Choose components, patterns, interactions, charts or blocks, type to filter, select with space and press enter. In SwiftUI and Jetpack Compose projects the list only shows what exists for that platform.

$ pnpm dlx @esuiss/uim@latest add$ $ pnpm dlx @esuiss/uim@latest add --platform swift

Outside an interactive terminal, such as in CI, add without names prints the available names instead.

Update a component

Check what changed, then overwrite:

$ pnpm dlx @esuiss/uim@latest add button --diff$ $ pnpm dlx @esuiss/uim@latest add button --overwrite