Search documentation

Search components and pages

Installation

Yami UI is distributed as a shadcn registry. Install the theme once, then add components with the CLI.

Prerequisites

Your project should already use shadcn/ui with Tailwind CSS v4 and lucide icons. Initialize with npx shadcn@latest init if needed.

Install the theme

Add the yami style item first. It ships CSS variables, brand glow utilities, and font-face rules for Yami Sans and Yami Heading.

npx shadcn@latest add https://yami.ui.unsanity.ai/r/yami.json

Add components

npx shadcn@latest add https://yami.ui.unsanity.ai/r/button.json

Registry namespace

Register the namespace once in components.json, then install by short name:

{
  "registries": {
    "@yami": "https://yami.ui.unsanity.ai/r/{name}.json"
  }
}
npx shadcn@latest add @yami/yami
npx shadcn@latest add @yami/button

Agent skill

Install the Yami UI agent skill so your coding agent knows how to install, theme, and build with the registry. It ships a SKILL.md to ~/.agents/skills/yami-ui/. See the agent skill guide for what it covers.

npx shadcn@latest add https://yami.ui.unsanity.ai/r/skill.json