Skip to main content
skill CX Codex

shadcn-vue-skilld — Claude Code skill for shadcn-vue setup

shadcn-vue-skilld — a skill for Claude Code, Codex, Cursor and other agents covering shadcn-vue 2.8.2 CLI in Vue and Nuxt projects. Carries exact flags for every command and the full components.json schema.

MIT 174 installs ★ 186 updated 2026-10-10

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add skilld-dev/vue-ecosystem-skills --skill shadcn-vue-skilld -a claude-code
Open on GitHub

What shadcn-vue-skilld does

The skill gives the agent a complete command map — init, add, apply, view, search, docs, info, diff, migrate, build, mcp init — with all flags and config keys for version 2.8.2.

Several common mistakes are covered explicitly. In 2.8.x, preset names have no prefix: vega not reka-vega. The toast and toaster components are deprecated; sonner replaces them. The current Lucide package is @lucide/vue, not lucide-vue-next — run migrate icons to switch. The skill also documents item name resolution order, the SHADCN_VUE_URL and REGISTRY_URL environment variables for local registry testing, and the programmatic API available from seven import paths.

Components land in components/ui/** and belong to your project. Running apply <preset> rewrites UI components, fonts, and CSS variables — commit your work first, because the CLI itself has no undo.

What it helps with

  • add shadcn-vue components to a Vue or Nuxt project with correct CLI flags
  • apply a named preset (vega, nova, lyra, others) to an existing project
  • switch from deprecated lucide-vue-next to @lucide/vue via migrate icons
  • configure a third-party component registry in components.json
  • spin up the shadcn-vue MCP server and wire it to a client

Example prompts for the agent

  • Set up shadcn-vue in this project with the nova preset and Inter font
  • Add dialog, card and button — show a --dry-run first, then install
  • Migrate icons from lucide-vue-next to @lucide/vue using migrate icons

How to install shadcn-vue-skilld

1Skills CLI (Vercel)

npx skills add skilld-dev/vue-ecosystem-skills --skill shadcn-vue-skilld -a claude-code

2Manually: put the files in place

~/.claude/skills/shadcn-vue-skilld/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/shadcn-vue-skilld/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about shadcn-vue-skilld

How do I install shadcn-vue-skilld in Claude Code?

Run npx skills add skilld-dev/vue-ecosystem-skills --skill shadcn-vue-skilld -a claude-code. The skill will be available at ~/.claude/skills/shadcn-vue-skilld/SKILL.md.

What does shadcn-vue-skilld do?

It gives the agent exact CLI flags for shadcn-vue 2.8.2, the components.json schema, preset and component naming rules, and the programmatic API — so the agent uses current names rather than deprecated ones.

Does shadcn-vue-skilld work with GitHub Copilot?

Yes. Install with gh skill install skilld-dev/vue-ecosystem-skills shadcn-vue-skilld. The skill is stored at .github/skills/shadcn-vue-skilld/SKILL.md.

Source text

SKILL.md · MIT
---
name: shadcn-vue-skilld
description: Use when adding, configuring, or debugging shadcn-vue in a Vue or Nuxt project. Covers shadcn-vue CLI commands (init, add, apply, view, search, docs, info, diff, migrate, build, mcp), components.json, styles, presets, fonts, icon libraries, registries, the MCP server, and the programmatic API. Gives exact flags and config keys for shadcn-vue 2.8.2.
license: MIT
---

# shadcn-vue

Version: `[email protected]` (prepared source `package.json:4`; npm `latest` dist-tag, checked 2026-09-22).
Stack: Vue 3.5+, `reka-ui` ^2.10.1, Tailwind CSS ^4.3.2 (`package.json:68,88,91`). One base: `reka`.
Run the CLI with `pnpm dlx shadcn-vue@latest <command>` (or `npx`, `npm exec`, `bunx`).

## What it does

The CLI copies component source files into your project and installs their npm dependencies.
You own the copied code. Edit `components/ui/**` freely; re-running `add` with `-o, --overwrite` replaces your edits.

## Core workflow

```bash
# New or existing project: write components.json, install deps, set up CSS
pnpm dlx shadcn-vue@latest init

# Add components (also: URL, local file, @namespace/item, owner/repo/item)
pnpm dlx shadcn-vue@latest add button card dialog

# Preview without writing, then install
pnpm dlx shadcn-vue@latest add sidebar --dry-run
pnpm dlx shadcn-vue@latest add sidebar

# Usage docs and examples for a component
pnpm dlx shadcn-vue@latest docs button
```

## Rules that prevent bugs

- Item names resolve in this order: URL, local file, `@namespace/item`, `owner/repo/item[#ref]`, then plain name in the default registry (`dist/registry-hxzbzXMt.js:1870-1891`, https://www.shadcn-vue.com/docs/cli#add).
- Preset names have no prefix in 2.8.x: `vega`, `nova`, `maia`, `lyra`, `mira`, `luma`, `sera` (`dist/registry-hxzbzXMt.js:3141-3244`). Older docs and the 2.6.x baseline used `reka-vega` style names; those fail now. See [changes](./references/changes-2.7-2.8.md).
- `toast` and `toaster` are deprecated; use `sonner` (`dist/transform-menu-CLNZ5vUh.js:446-454`).
- `lucide-vue-next` is the legacy icon package; current lucide package is `@lucide/vue` (`dist/transform-menu-CLNZ5vUh.js:457`, `dist/icons/index.d.ts:3-10`). Run `migrate icons` to switch libraries.
- Registry style ids stay prefixed: the `vega` style fetches from `reka-vega` (`dist/registry-hxzbzXMt.js:492-496`). Fallback style id is `new-york-v4`.
- `apply <preset>` rewrites UI components, fonts, and CSS variables. Commit first; the CLI warns the same (`dist/index.js:2252-2254`).
- Registry env: `SHADCN_VUE_URL` and `REGISTRY_URL` override the default `https://shadcn-vue.com/r` (`dist/transform-menu-CLNZ5vUh.js:2-3`). Use for local registry testing.
- Builtin namespace is `@shadcn` (`dist/transform-menu-CLNZ5vUh.js:445`). Third-party namespaces must be configured in `components.json` under `registries`.

## Command map

| Command | Purpose | Key options |
| --- | --- | --- |
| `init` (alias `create`) | Set up project, write `components.json` | `-p <preset>`, `-t <template>`, `--style`, `--icon-library`, `--font`, `-b <base-color>`, `-d`, `--silent` |
| `add` | Install items | `-o`, `-a`, `-p <path>`, `--dry-run`, `--diff`, `--view` |
| `apply` | Apply a preset to an existing project | `-y` |
| `view` | Inspect items before install | `-c <cwd>` |
| `search` (alias `list`) | Fuzzy search registries (`@name` args) | `-q`, `-l`, `-o` |
| `docs` | Component docs and examples | `--json`, `-b <base>` |
| `info` | Project setup report | `--json` |
| `diff` | Compare installed item against registry | `-y` |
| `migrate` | `icons` or `rtl` migration | `-l`, `[path]` |
| `build` | Build `registry.json` into registry JSON | `-o <path>` |
| `mcp init` | Write MCP client config | `--client claude\|cursor\|vscode` |

Full flags: [cli reference](./references/cli.md).

## Configuration

`components.json` at project root drives everything. Key fields: `style`, `typescript`, `tailwind.css`, `tailwind.baseColor`, `aliases`, `iconLibrary`, `rtl`, `pointer`, `menuColor`, `menuAccent`, `registries`.
Full schema and examples: [components-json reference](./references/components-json.md).

## Styles and presets

Seven named presets (`vega` to `sera`), eight valid styles in encoded preset codes (adds `rhea`), five icon libraries, 24 fonts. Details and tables: [styles reference](./references/styles-and-presets.md).

## Programmatic API

Import from `shadcn-vue`, `shadcn-vue/registry`, `shadcn-vue/schema`, `shadcn-vue/utils`, `shadcn-vue/icons`, `shadcn-vue/preset`, `shadcn-vue/mcp`, `shadcn-vue/tailwind.css` (`package.json:27-59`).
Exports and error classes: [registries reference](./references/registries.md#programmatic-api).

## References

- [CLI reference](./references/cli.md)
- [components.json](./references/components-json.md)
- [Styles and presets](./references/styles-and-presets.md)
- [Registries and programmatic API](./references/registries.md)
- [MCP server](./references/mcp.md)
- [Changes in 2.7 and 2.8](./references/changes-2.7-2.8.md)

© skilld-dev · MIT · skilld-dev/vue-ecosystem-skills

Similar skills

All skills for Agent setup: memory, context, orchestration →

From the same set32

The whole set →
tanstack-vue-query-skilld tanstack-vue-query-skilld guides AI assistants on @tanstack/vue-query v5 conventions. It prevents reactivity bugs with query keys and SSR setup in Vue projects. CX Codex +1 223installs vueuse-core-skilld vueuse-core-skilld — a skill with the full @vueuse/core 15.0.0 API: new composables, v14 migration rules, deprecated functions and environment requirements. CX Codex +1 219installs vee-validate-skilld vee-validate-skilld — a skill for writing, reviewing, and debugging Vue 3 forms with vee-validate 4.15.x. Covers Composition API, validation schema patterns, typed-schema integration, version-specific changes since 4.9, and common pitfalls. CX Codex +1 188installs primevue-skilld primevue-skilld is a Claude Code skill that guides PrimeVue v5 setup, current component APIs, and theming in Vue 3 projects. CX Codex +1 187installs vue-test-utils-skilld The vue-test-utils-skilld skill guides Vue 3 tests with @vue/test-utils 2.5.1, including mounting, wrapper queries, async work, and v1 migration. CX Codex +1 168installs vueuse-components-skilld vueuse-components-skilld is a Claude Code skill that guides Vue 3 template work with @vueuse/components, including debugging and translating composables into component or directive usage. CX Codex +1 168installs motion-v-skilld motion-v-skilld — a skill for motion-v (Motion for Vue) animations: motion component, gestures, variants, v-motion directive, Nuxt module. CX Codex +1 146installs reka-ui-skilld reka-ui-skilld is a Claude Code skill for building accessible interfaces with Reka UI 2.10.5 in Vue 3. It helps agents write clean component compositions and use props accurately. CX Codex +1 146installs

Project sponsors

Companies that keep this analytics open