CLI Reference
Use the ruma-ui CLI to add components, initialize configurations, and manage dependencies.
init
Initializes ruma-ui in your project. Creates components.json, configures import aliases, creates lib/utils.ts, and installs dependencies.
npx ruma-ui init [options]
Options
-y, --yesSkip confirmation prompts and use default configuration values.-t, --template <template>Specify framework template (e.g.next) when scaffolding a new project.-n, --name <name>Specify the name of the new project to create.-c, --cwd <path>Specify the working directory (defaults to current directory).
add
Adds components to your project. Downloads component source files from the registry, remaps import aliases, and installs package dependencies.
npx ruma-ui add [components...] [options]
Examples
npx ruma-ui add button
npx ruma-ui add button card tabs switch alert
Options
-o, --overwriteOverwrite existing component files without prompting.-c, --cwd <path>Specify the working directory target.