CLI & registry

Templates in one command

Templates install by URL. Pick the path that matches where you start.

The registry

paneui is published as one static JSON file per item at https://paneui.dev/r/<name>.json. Register the namespace so every command below accepts short names like @paneui/button.

{
  "registries": {
    "@paneui": "https://paneui.dev/r/{name}.json"
  }
}

The function(){throw Error("Attempted to call CLI_NAME() from the server but CLI_NAME is on the client. It's not possible to invoke a client function from the server, it can only be rendered as a Component or passed to props of a Client Component.")} CLI

Runs the shadcn CLI for you and records what it installs, so one command updates every item and the theme. Both CLIs write the same files; use either.

Registers the namespace above in components.json, running shadcn init first if there is none, and installs the theme.

update replaces files whole, so commit first and preview with --dry-run. It also finds items you added with the shadcn CLI. Templates are skipped unless you pass --templates, because reinstalling one replaces its routes.

add

Copies one or more items into your project, along with their registryDependencies (other @paneui items) and npm dependencies.

Add --dry-run to preview the files without writing them, or --diff <path> to see what would change in a file you already have. Use --overwrite to replace existing files and --path to choose where they go.

view

Prints an item's metadata and source before you install it.

search

Lists the items in the registry, optionally filtered with -q. list is an alias.

Install by URL

Any command also takes an item's URL in place of its name. Keep the namespace registered anyway, because items depend on other @paneui items such as the theme.

Updating

Installed files are yours, so nothing updates on its own. To pull a newer version of an item, compare first with --diff, then re-add it with --overwrite and re-apply any local edits. Check the Changelog for what moved.

To update everything at once, run update from the paneui CLI.

Upgrading after a theme change

When a release changes the theme, update it first, then the components that use it. Commit before you start so you can review every change.

1. Reinstall the theme. --overwrite is required: the theme also ships packages/ui/src/lib/utils.ts, and without it a non-interactive run stops at that question before the stylesheet is touched.

2. Reinstall your accent and radius presets, if you use them, so they apply on top of the new theme.
3. Run the upgrade check. It lists tokens the release removed, broken rules from older installs and code that uses a changed API, with a fix for each. --fix cleans the stylesheet, then checks again and lists only what is left; it never edits your source.

node scripts/paneui-upgrade-check.mjs
node scripts/paneui-upgrade-check.mjs --fix

4. Re-add the components you use with --overwrite, a few at a time, and re-apply local edits from the diff.

Switch the icon style

The icon set comes in three styles with the same exports, and all of them install to the same file. Replace it to switch the icons in every component.

To go back to the default rounded set, run this.

When you later add an item that uses icons, the CLI asks before overwriting packages/ui/src/icons/index.tsx. Answer no to keep your style. A non-interactive run stops at that question. If you add with --overwrite, the rounded set comes back, so run your style's command again. Compare the styles on Icons.

Item types

• registry:ui is a component, installed to your ui alias.
• registry:block is a block or template, which can ship several files including a page.tsx.
• registry:theme is the theme or an accent preset, which writes CSS variables rather than files (see Theming).
• registry:lib and registry:component are shared files such as @paneui/utils and @paneui/icons.

This is a trimmed item file as the CLI receives it.

{
  "name": "button",
  "type": "registry:ui",
  "title": "Button",
  "description": "Triggers an action or submits a form.",
  "dependencies": ["@base-ui/react", "class-variance-authority"],
  "registryDependencies": ["@paneui/theme"],
  "files": [{ "path": "packages/ui/src/components/button.tsx", "type": "registry:ui", "content": "…" }]
}