Skip to main content
The add command resolves the dependency tree for requested components, writes source files into your project, and installs npm dependencies with your detected package manager (bun, pnpm, yarn, or npm).

​
Usage

​
Quick Examples

​
Options

​
--cwd, -c <path>

Runs the command as if started inside <path>. Specifically designed for monorepos: detects tsconfig.json and components.json inside the specified workspace (e.g., packages/ui or apps/web), installing dependencies into that workspace’s package.json.

​
--path <path>

Overrides the target directory where component files are written without modifying root configuration context. (Default: components/sora-ui/)

​
--registry <name|url>

Product registry key (default: ui) or an external HTTPS registry endpoint.
[!NOTE] External registries must use https://. Insecure http:// is allowed exclusively for localhost and 127.0.0.1 during local registry testing.

​
--yes, -y

Skips the installation confirmation prompt.
[!IMPORTANT] When executing the CLI inside CI/CD pipelines, Docker builds, or automated agent scripts (where there is no interactive TTY), add without --yes will exit cleanly without modifying files. Pair --yes with --force in automated environments.

​
--force

Overwrites existing local files without asking for confirmation.

​
--dry-run

Simulates the entire execution pipeline. Prints which files would be written and which npm dependencies would be installed, without making any modifications to disk.

​
--view

Outputs resolved component source files directly to stdout instead of writing them to disk.

​
--silent, -s

Suppresses detailed per-file output, printing only the summary completion line.