This guide walks you through the essential steps to seamlessly integrate ikui into your shadcn project.

Prerequisites

ikui is built on the latest React 19 and Tailwind CSS v4. Ensure your project is set up with these technologies before proceeding. We recommend following the Official shadcn/ui Installation Guide and shadcn/create setup to prepare your environment.

Set up ikui Registry

Add the ikui registry namespace to your components.json and set your component library and style. Learn more about registry config from shadcn registry docs.

{
  ...
  "style": "base-nova",
  ...
  "registries": {
    "@ikui": "https://ik-ui.pages.dev/r/{name}.json"
  }
}

Components

You can integrate ikui using the shadcn CLI for automation or by manual installation for full control. Both methods apply to everything in Docs and the component catalog, including blocks you install with @ikui/….

npx shadcn@latest add @ikui/copy-button

AI-Enhanced Workflow

ikui is designed from the ground up to be AI-friendly, making it easier for language models to understand and modify your UI.

• MCP: Connect ikui through MCP so your IDE can find, install, and compose components for you.
• llms.txt: Access our llms.txt file for a structured map of our documentation and architecture optimized for AI agents.
• Copy Markdown: Every page includes a Copy Markdown feature, allowing you to instantly feed documentation or code into your AI-driven development workflows.