Installation

Recommended for new projects: use /create to build your preset visually and generate the right setup command for your framework.

PersianLabs/ui is distributed as a shadcn-compatible registry, so there's no package to install and no version to chase. Choose the setup that matches your starting point.

• Use /create — build your preset visually and generate a setup command.
• Use the CLI — scaffold a supported template directly from the terminal.
• Existing project — add components to an app you already have.

Use /create

Build your preset visually, preview your choices — theme, radius, and the Persian/English font pairing — and get a framework-specific setup command.

Open /create, pick your design system, and copy the generated command. Every choice is encoded into the short preset code (e.g. c0), so the link and the command always reproduce the same setup.

Available for Next.js (flat and Turborepo) and Vite (flat and monorepo). The scaffolded projects ship RTL, the Persian-first font stack (Vazirmatn by default, Estedad optional), Farsi digit handling, and the full theming tokens — the first render already looks right.

Use the CLI

Scaffold a new project directly from the terminal:

npx persianlabsui@latest init -t [template]

Supported templates: next, vite, next-monorepo, and vite-monorepo.

Combine with a preset code from /create to apply your design system in the same step:

npx persianlabsui@latest init -t next -p <preset-code> -n my-app

See the CLI docs for every command and option.

Existing Project

If your project already has shadcn configured, skip straight to adding components. Initialize shadcn once — nothing about this step is specific to this registry:

Then add any component by its registry namespace — the CLI copies the source straight into your project and wires dependencies automatically. You can use either the shadcn CLI or the PersianLabs CLI:

npx persianlabsui@latest add tabs

The direct-URL form also works:

To install everything the registry offers in one command, use the bundle endpoint:

Already have a project without scaffolding but want the fonts and theme? The CLI can apply a preset (theme + fonts) to an existing project:

npx persianlabsui@latest apply <preset-code>

Requirements

First render

After adding a component, import it and drop it into your page:

import { Button } from "@/components/ui/button"
 
export function App() {
  return <Button>ذخیره</Button>
}

Next steps

• Theming — copy the CSS color tokens into your globals.css.
• RTL — confirm dir="rtl" and the logical-property conventions.
• Fonts — pick a Persian font stack that pairs with the components.
• CLI — the full command reference for init, apply, add, and preset.