# 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:

```bash
claude mcp add boardui -- npx -y boardui@latest mcp
```

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

```json
{
  "mcpServers": {
    "boardui": { "command": "npx", "args": ["-y", "boardui@latest", "mcp"] }
  }
}
```

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](https://www.boardui.com/mcp).

### With the CLI

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

## Check the installation

After setup, continue with the [first example](/docs/up-to-code-boardui/quick-start-guide). If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/boardui)
- [Original README](https://github.com/Up-to-code/boardui/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/boardui/issues)
- [Open the project website](https://www.boardui.com)

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.