Install and configure boardui

Follow the source instructions for boardui. Read the prerequisites and configuration steps before running an example.

Install into an existing project

Every component in this repository also installs on its own, as source, into any Next.js project.

With an agent

BoardUI has an MCP server, so Claude Code, Cursor and any MCP client can browse the catalog and install for you. Add it once:

1claude mcp add boardui -- npx -y boardui@latest mcp

Cursor and most other clients take the same server in their MCP config:

1{
2  "mcpServers": {
3    "boardui": { "command": "npx", "args": ["-y", "boardui@latest", "mcp"] }
4  }
5}

Then ask in plain words. "Install every free BoardUI component" installs the whole free catalog in one go. "Add a data table and stat cards to the dashboard" installs just those and wires them in. The rules in AGENTS.md keep whatever it builds on BoardUI's tokens and type scale. Setup for VS Code, Codex and the rest is at boardui.com/mcp.

With the CLI

1npx boardui@latest list              # every component, one line each
2npx boardui@latest add data-table    # one component and what it depends on
3npx boardui@latest add --all         # everything in this repository

Check the installation

After setup, continue with the first example. If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

Source and help

The catalog identifies the license as MIT. Read the repository license before redistributing source or assets.

This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.