# Aavya Brand Portal

> Brand portal, design-token docs, and a shadcn-compatible component registry. Use this to consume
> Aavya-branded components, design tokens, and brand guidelines, and to audit apps for brand
> compliance. Everything below is public and machine-readable.

## Registry (components)

- [Registry index (JSON)](https://brand.aavya.com/r/registry.json): all installable items
- [Single item (JSON)](https://brand.aavya.com/r/theme.json): one item with its file contents (replace `theme` with any item name)
- [Registry as markdown](https://brand.aavya.com/api/registry/markdown): agent-friendly inventory with per-item install commands
- [MCP server](https://brand.aavya.com/api/mcp): JSON-RPC tools `list_components`, `search_components`, `get_component`
- Install: add `"registries": { "@aavya": "https://brand.aavya.com/r/{name}.json" }` to `components.json`, then `npx shadcn@latest add @aavya/<name>` (start with `@aavya/theme`). Branded blocks declare `@aavya/*` dependencies, so the namespace is required.

## Design tokens

- [Tokens (JSON)](https://brand.aavya.com/api/export/tokens): source-of-truth light + dark token values, plus the canonical key list
- [Theme (installable)](https://brand.aavya.com/r/theme.json): the `@aavya/theme` item (globals.css)
- [Brand + tokens (markdown)](https://brand.aavya.com/api/export/combined): tokens, color usage + WCAG contrast, tone of voice, and logo specs in one bundle

## Governance & migration

- [Consumer changelog](https://brand.aavya.com/api/registry/changelog): what downstream projects must adopt (tagged "Adopt now" vs "Informational")
- [CI brand audit](https://brand.aavya.com/brand-audit.mjs): standalone, dependency-free script — flags visual brand drift and exits nonzero (`node brand-audit.mjs --changed`)
- [Tie-in doctor](https://brand.aavya.com/aavya-doctor.mjs): report how completely an app is wired into the portal — @aavya namespace, token drift, pending migrations, plugin/MCP (`node aavya-doctor.mjs`)

## Agent skills (Claude Code)

- Plugin marketplace: `aavya-code/claude-plugins` (marketplace `aavya`). Install: `/plugin marketplace add aavya-code/claude-plugins` then `/plugin install aavya-registry@aavya`.
- Skills: `registry-first` (find/install branded components), `brand-scaffold` (compose whole screens), `brand-review` (audit for brand compliance), `brand-voice` (write on-brand copy), `registry-migrate` (reconcile a project with registry changes).

## Docs

- Consuming guide: https://brand.aavya.com/docs (see consuming-the-registry.md in the repo for the full setup, including the `@aavya` namespace and per-project enablement)