CLI

The boarduiCLI copies component source files straight into your project — no runtime package, the code is yours. It resolves each component's internal dependencies (utils, icons, other components) transitively and installs any missing npm packages with your package manager.

npx boardui@latest add button select date-picker

init

Sets up BoardUI in an existing Next.js project: installs the runtime dependencies (react-aria-components, tailwind-merge, @remixicon/react, Tailwind v4), writes styles/theme.css, styles/typography.css, styles/globals.css, and utils/cx.ts, then prints the import line to add to your root layout.

npx boardui@latest init
OptionDescription
-y, --yesSkip confirmation prompts
-o, --overwriteOverwrite existing files
-d, --dir <dir>Target directory (defaults to the project source root)

add

Adds one or more components. Files keep the same structure as this site (components/base/…, components/application/…), imports use the @/ alias, and existing files are skipped unless you pass --overwrite. Run it without arguments for an interactive picker.

npx boardui@latest add # interactive pickernpx boardui@latest add table paginationnpx boardui@latest add --all
OptionDescription
-a, --allAdd every component in the registry
-p, --path <path>Custom directory to write files into
-d, --dir <dir>Target directory (defaults to the project source root)
-o, --overwriteOverwrite existing files
-y, --yesSkip prompts — keep existing files, install dependencies

list

Prints every available component grouped by type — base components, application blocks, and foundations.

npx boardui@latest list

Updating components

Installed components are copies — yours to edit, never touched silently. To pull the latest version of a component from the registry, re-run add with --overwrite.

npx boardui@latest add button --overwrite

shadcn compatibility

The registry uses the shadcn item schema, so every component also installs with the shadcn CLI if you prefer it:

npx shadcn@latest add https://www.boardui.com/r/button.json