Getting Started

LLMs & Agents

Give AI coding agents up-to-date Cult UI docs with llms.txt, markdown pages, the shadcn MCP server, and copy-paste agent rules.

Updated

Cult UI publishes its docs in formats that AI coding agents can read directly. Point your agent at one of the sources below so it installs real components instead of guessing at APIs.

Machine-readable docs

ResourceURLUse it for
llms.txt/llms.txtIndex of every docs page and component, with install instructions
llms-full.txt/llms-full.txtEvery docs page, including component source, in one file
Markdown pagesAppend .md to any docs URL, e.g. /docs/components/halo-button.mdOne component's docs, demo, and source
Registry/r/registry.json and /r/{name}.jsonInstalling components with the shadcn CLI

Every docs page also has a Copy page button that copies its markdown, plus shortcuts to open the page in ChatGPT, Claude, or v0.

Install components from an agent

Any agent with terminal access can add components by name. The @cult-ui namespace is built into the shadcn CLI, so no config is needed:

pnpm dlx shadcn@latest add @cult-ui/halo-button

To let agents browse and search the registry with natural language, set up the MCP Server.

Agent rules

Paste this into AGENTS.md, CLAUDE.md, or a .cursor/rules file so your agent knows how to use Cult UI:

AGENTS.md
## Cult UI - Cult UI components are shadcn/ui registry items. Install them with `npx shadcn@latest add @cult-ui/<name>`; never recreate them by hand. - Find component names and docs in https://www.cult-ui.com/llms.txt. Read a component's docs at https://www.cult-ui.com/docs/components/<name>.md before using it. - Installed source lives in `components/ui/`. Edit it there; it is owned code, not a dependency. - Components use Tailwind CSS v4 and shadcn theme tokens (`bg-background`, `text-foreground`, `ring-ring`). Style with tokens, not hardcoded colors. - Animated components use `motion`. Respect `prefers-reduced-motion`.