CLI

A boardui O CLI copia os arquivos de origem de componentes diretamente para o seu projeto — nenhum pacote em tempo de execução, o código é seu. Ele resolve as dependências internas de cada componente (utils, ícones, outros componentes) transitivamente e instala quaisquer pacotes npm em falta com o seu gerenciador de pacotes.

npx boardui@latest add button select date-picker

init

Configura o BoardUI em um projeto Next.js existente: instala as dependências de tempo de execução (react-aria-components, tailwind-merge, @remixicon/react, Tailwind v4), escreve styles/theme.css, styles/typography.css, styles/globals.css, e utils/cx.ts, e depois mostra as linhas a adicionar ao layout raiz: a importação da folha de estilos e a fonte Inter.

Quando o projeto já compila o Tailwind v4, como o create-next-app 16.4 e versões posteriores fazem com @tailwindcss/turbopack, o init não mexe no PostCSS. Caso contrário, ele instala @tailwindcss/postcss e mostra a linha do postcss.config.mjs. Passe --postcss para configurar o PostCSS de qualquer forma.

npx boardui@latest init

Opção	Descrição
-y, --yes	Skip confirmation prompts
-o, --overwrite	Overwrite existing files
-d, --dir <dir>	Target directory (defaults to the project source root)
--pro	Also install dependencies used by BoardUI Pro components
--postcss	Set up @tailwindcss/postcss even when Tailwind already compiles another way

adicionar

Adiciona um ou mais componentes. Por padrão, os arquivos mantêm a mesma estrutura que este site (components/base/…, components/application/…), as importações utilizam @/ alias, e os arquivos existentes são ignorados a menos que você passe --overwrite. Execute-o sem argumentos para um selecionador interativo.

npx boardui@latest add            # interactive pickernpx boardui@latest add table paginationnpx boardui@latest add --all

Opção	Descrição
-a, --all	Add 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, --overwrite	Overwrite existing files
-y, --yes	Skip prompts — keep existing files, install dependencies

CI, scripts e agentes de codificação

init e add perguntam antes de instalar pacotes ou mexer em arquivos que já existem. Sem um terminal para responder, como em CI, em um script ou em um agente de codificação, eles param com código de saída 1 em vez de adivinhar. Passe --yes para aceitar os padrões: instalar as dependências e manter os arquivos existentes. Adicione --overwrite para substituir os arquivos existentes e informe os nomes dos componentes ou passe --all em vez de usar o seletor.

npx boardui@latest init --yesnpx boardui@latest add button select --yes

Caminhos personalizados e monorrepos

Adicionar um opcional boardui.json ao lado do pacote de destino package.json para configurar onde os arquivos vão e quais os nomes falsos que eles usam. Ambos init e adicionar lê- lo, incluindo para componentes Pro. Sem ele, a raiz existente e src/ layouts comportam-se como antes.

Configurar par paths e aliases entradas para componentes, utils, hooks, estilos ou lib. Execute o CLI dentro do pacote de destino para que as dependências do npm também instalem lá. Os mapeamentos configurados não podem ser combinados com --path ou --dir; essas bandeiras permanecem disponíveis para projetos não configurados. A alteração da configuração não migra arquivos instalados anteriormente.

Configure um pacote de UI compartilhado e aplicativos de consumo

lista

Imprime todos os componentes disponíveis agrupados por tipo — componentes de base, blocos de aplicativo e fundações.

npx boardui@latest list

habilidade

Instala o Skill do BoardUI para agentes (SKILL.md mais catálogo, temas e referências de padrões) assim AI assistentes como Claude Code e Codex carregar BoardUI saber cada sessão. .claude/skills/boardui; re-run com --force Para atualizar.

npx boardui@latest skill

Opção	Descrição
-g, --global	Install to ~/.claude/skills/boardui instead of the project
-c, --client <client>	Install to ~/.agents/skills/boardui (codex, gemini)
-p, --path <dir>	Custom directory to install the skill into
-f, --force	Overwrite an existing install (how you update)

Atualizando componentes

Componentes instalados são cópias — suas para editar, nunca tocadas silenciosamente. Para retirar a versão mais recente de um componente do registro, execute novamente adicionar com --overwrite.

npx boardui@latest add button --overwrite

Telemetria anônima

Após um sucesso init, o CLI envia um evento anônimo contendo sua versão, seu gerenciador de pacotes, e se --pro foi usado. Depois de um sucesso adicionar, envia os nomes dos componentes que solicitou explicitamente, mas não as suas dependências automaticamente resolvidas. habilidade instalar, envia onde a habilidade foi colocada (projeto, diretório global, ou agentes), nunca o caminho em si. Um ID aleatório no diretório de configuração do usuário do seu sistema operacional nos permite distinguir execuções repetidas. BoardUI não envia caminhos de projeto, código fonte, nomes de dependência, endereços de e-mail, outros argumentos de comando, ou telemetria para lista.

Desativar a telemetria através da configuração BOARDUI_TELEMETRY_DISABLED=1 ou DO_NOT_TRACK=1.

Os eventos são retidos como contadores de vida e baldes diários anônimos usados para relatórios diários, semanais e mensais de tendência.

compatibilidade shadcn

O registro usa o esquema de itens shadcn, então cada componente também instala com o shadcn CLI se você preferir:

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