# Design Rover

Give coding agents context about your existing components, tokens and UI conventions.

[Canonical documentation](https://nisargkavi.github.io/design-rover/)
[Documentation index](https://nisargkavi.github.io/design-rover/llms.txt)
[Markdown source](https://github.com/nisargkavi/design-rover/blob/main/docs/index.md)

**Help your coding agent reuse the UI you already have.**

Design Rover reads your React/TypeScript source and records component APIs, scoped design tokens and UI conventions. You review inferred rules, then give agents relevant context through the CLI, generated instructions or MCP.

It runs locally in your project. Start with the [quick start](https://nisargkavi.github.io/design-rover/guides/quickstart/), then choose the workflow you need:

| I want to… | Read |
| --- | --- |
| Set up an existing project | [Quick start](https://nisargkavi.github.io/design-rover/guides/quickstart/) |
| Help an agent find and reuse a component | [Context for agents](https://nisargkavi.github.io/design-rover/guides/context/) |
| Keep the component map updated while editing | [Live updates with watch](https://nisargkavi.github.io/design-rover/guides/watch/) |
| Connect an MCP client | [MCP setup](https://nisargkavi.github.io/design-rover/guides/mcp/) |
| Decide which rules the team should follow | [Review and approvals](https://nisargkavi.github.io/design-rover/guides/review/) |
| Catch design knowledge drift in CI | [Checks and CI](https://nisargkavi.github.io/design-rover/guides/ci/) |

## Start in your project

Requires Bun and Node 20.19.0 or newer. No global install is needed.

```sh
bunx design-rover init
bunx design-rover diff
```

Review the evidence, approve or reject individual proposals, then [generate agent guidance](https://nisargkavi.github.io/design-rover/guides/quickstart/#give-your-agent-context) or request context for your next UI task.

## Observations and decisions

Component APIs and tokens begin as **observed inventory**. Inferred rules remain **pending** until you explicitly approve them. Watch mode can refresh observed inventory; reviewed contracts and human decisions still need review when their evidence changes.

The source of truth is `.design-rover/`. Generated instructions are projections of that knowledge. See the [knowledge model](https://nisargkavi.github.io/design-rover/reference/model/) for the states and files involved.

## What to expect

Design Rover analyzes supported source patterns. It exposes incomplete resolution and context omissions so you can inspect the implementation and make a decision. A clean check does not establish visual quality, accessibility or complete design-system conformance. Read [support and limits](https://nisargkavi.github.io/design-rover/reference/limits/) before using it as a gate.

[GitHub repository](https://github.com/nisargkavi/design-rover) · [npm package](https://www.npmjs.com/package/design-rover) · [Contribute](https://nisargkavi.github.io/design-rover/guides/contributing/)
