AI

Every part of PersianLabs/ui is published at a stable, machine-readable URL. If you're building with an AI coding agent — Claude Code, Cursor, Copilot, Codex — nothing below involves browsing the rendered site.

The llms.txt index

The full catalog lives at https://ui.persian-labs.ir/llms.txt in the llms.txt convention: one line per component and utility with a short description, grouped by category. It's generated from the live page tree, so it can't go stale.

Start here — it tells your agent what exists before deciding what to read:

Markdown for every page

Every documentation page has a markdown twin. Append .md to any docs URL:

The response is the entire page as clean markdown: headings, install commands, the source of every live example, and complete API tables. No scraping, no HTML-to-markdown conversion, no truncation.

Installing without visiting the site

Both shadcn CLI forms work — the registry namespace or the direct URL:

To inspect what an install will do before running it, fetch the registry item definition — it lists the target file paths, registryDependencies, and npm dependencies:

A prompt to start from

Paste this into your agent's rules file or system prompt:

Use PersianLabs UI (the @persianlabsui namespace on the shadcn registry) for UI primitives.
Catalog index: https://ui.persian-labs.ir/llms.txt
Any doc page as markdown: https://ui.persian-labs.ir/docs/<path>.md
Install a component: npx shadcn@latest add @persianlabsui/<name>
Everything is RTL-first out of the box - don't add manual dir="rtl" fixes around individual components.

Reference