Vuetify CLI

The Vuetify CLI scaffolds Vuetify and v0 projects, seeds working examples from the official docs registry (vuetify add), and helps you track a local component library over time.

Packages

Installation

Install the CLI globally to access all commands:

pnpm add -g @vuetify/cli

npm install -g @vuetify/cli

yarn global add @vuetify/cli

bun add -g @vuetify/cli

Or run commands without installing using dlx/npx:

pnpm dlx @vuetify/cli <command>

npx @vuetify/cli <command>

yarn dlx @vuetify/cli <command>

bunx @vuetify/cli <command>

Quick Start

Create a new v0 project with the interactive wizard:

vuetify init

Or use the standalone scaffolding package without installing the CLI:

pnpm create vuetify0

npm create vuetify0

yarn create vuetify0

bun create vuetify0

Commands

init

Initialize a new project (wrapper around create-vuetify0):

pnpm dlx @vuetify/cli init my-app

npx @vuetify/cli init my-app

yarn dlx @vuetify/cli init my-app

bunx @vuetify/cli init my-app

add

v0 is headless: installing @vuetify/v0 and importing a primitive does not yield a rendered UI. vuetify add seeds a working, styled example from the official docs registry into your project so you own a real file you can edit, theme, and ship.

The registry is published at 0.vuetifyjs.com/registry↗︎ — the same curated examples that appear on component and composable docs pages.

Seed a feature

# Interactive picker when you omit the name
pnpm dlx @vuetify/cli add

# Component example (writes under src/components/…)
pnpm dlx @vuetify/cli add dialog

# Plugin (install-first — wires createThemePlugin into the app)
pnpm dlx @vuetify/cli add use-theme

# Pick a specific example when a feature ships more than one
pnpm dlx @vuetify/cli add create-data-table --example features

# Non-interactive (CI / scripts)
pnpm dlx @vuetify/cli add dialog --yes

npx @vuetify/cli add
npx @vuetify/cli add dialog
npx @vuetify/cli add use-theme
npx @vuetify/cli add create-data-table --example features
npx @vuetify/cli add dialog --yes

yarn dlx @vuetify/cli add
yarn dlx @vuetify/cli add dialog
yarn dlx @vuetify/cli add use-theme
yarn dlx @vuetify/cli add create-data-table --example features
yarn dlx @vuetify/cli add dialog --yes

bunx @vuetify/cli add
bunx @vuetify/cli add dialog
bunx @vuetify/cli add use-theme
bunx @vuetify/cli add create-data-table --example features
bunx @vuetify/cli add dialog --yes

What it does:

1. Resolves the name against the registry index (fuzzy match when needed).

2. Installs missing npm dependencies declared by the example (with confirm, or immediately with --yes).

3. Writes example files into your project and maps semantic colors if UnoCSS/Tailwind is present.

4. Records the install in vuetify.json (path, files, and upstream origin for later diff/refresh).

Plugins

Plugin pages (for example useTheme) are install-first: the CLI wires createThemePlugin (or the matching factory) into src/plugins/ and your app entry. A usage example is optional — confirm interactively, or pass --example to force one. With --yes, only the plugin module is installed.

vuetify add use-theme
vuetify add use-locale --yes

Integrations

add still installs project tooling integrations:

vuetify add eslint

Configure the MCP server with vuetify mcp install (not add mcp — that path is deprecated).

list and status

Track what add (and generate) put on disk:

# Inventory from vuetify.json
vuetify list
vuetify list --json

# Healthy vs missing files
vuetify status

generate

Scaffold a local component with no registry origin — useful when you are building your own library and only need a tracked file:

vuetify generate MyCard
vuetify generate my-button --dir src/components/ui

--dir is one-shot for that file. It does not change the project components alias used by later add / refresh calls.

diff and refresh

When a feature came from the registry, compare or re-pull it:

# Show which files match, changed, or only exist locally / upstream
vuetify diff dialog

# Re-fetch from the recorded origin (overwrites local files)
vuetify refresh dialog
vuetify refresh use-theme

Git remains the source of truth for your edits. Diff/refresh only compare against the registry seed you originally installed.

registry build

Publish your inventory as a static registry in the same shape as the official seed, so other projects can point vuetify add --registry at it:

vuetify registry build
# → ./registry/index.json, tokens.json, {type}/{name}.json

Host the parent of the output directory so URLs resolve as {origin}/registry/index.json (the CLI always fetches under /registry/).

# After hosting at https://design.example.com/registry/…
vuetify add dialog --registry https://design.example.com

Multi-registry

vuetify.json can map short aliases to origins:

{
  "version": 1,
  "aliases": { "components": "src/components" },
  "registries": {
    "@vuetify": "https://0.vuetifyjs.com",
    "@acme": "https://design.example.com"
  },
  "components": {}
}

vuetify add @acme/button
vuetify add dialog --registry @acme

update

Update all Vuetify packages to their latest versions:

# Update to latest stable
pnpm dlx @vuetify/cli update

# Update to nightly builds
pnpm dlx @vuetify/cli update --nightly

npx @vuetify/cli update
npx @vuetify/cli update --nightly

yarn dlx @vuetify/cli update
yarn dlx @vuetify/cli update --nightly

bunx @vuetify/cli update
bunx @vuetify/cli update --nightly

The update command auto-detects and updates:

• vuetify

• @vuetify/* packages

• vuetify-nuxt-module

• @nuxtjs/vuetify

• vite-plugin-vuetify

• eslint-plugin-vuetify

• eslint-config-vuetify

docs

Open version-specific Vuetify documentation:

pnpm dlx @vuetify/cli docs

npx @vuetify/cli docs

yarn dlx @vuetify/cli docs

bunx @vuetify/cli docs

release-notes

Print the release notes for a Vuetify package without leaving the terminal:

# Latest v0 release
pnpm dlx @vuetify/cli release-notes v0

# A specific version
pnpm dlx @vuetify/cli release-notes v0 --version 1.0.0

npx @vuetify/cli release-notes v0
npx @vuetify/cli release-notes v0 --version 1.0.0

yarn dlx @vuetify/cli release-notes v0
yarn dlx @vuetify/cli release-notes v0 --version 1.0.0

bunx @vuetify/cli release-notes v0
bunx @vuetify/cli release-notes v0 --version 1.0.0

The command prints the release name, tag, publish date, and full notes, along with links to the documentation and the GitHub release.

analyze

Scan your codebase for Vuetify usage patterns:

# Console output
pnpm dlx @vuetify/cli analyze

# JSON output for tooling
pnpm dlx @vuetify/cli analyze --reporter json

npx @vuetify/cli analyze
npx @vuetify/cli analyze --reporter json

yarn dlx @vuetify/cli analyze
yarn dlx @vuetify/cli analyze --reporter json

bunx @vuetify/cli analyze
bunx @vuetify/cli analyze --reporter json

The analyzer scans your project and detects all imports from @vuetify/v0:

• Components — Dialog, Tabs, Avatar, etc.

• Composables — useBreakpoints, useTheme, createFilter, etc.

• Plugins — createThemePlugin, createBreakpointsPlugin, etc.

• Utilities and constants

Custom Documentation URL

After analyzing your project, the CLI generates a personalized documentation URL:

https://0.vuetifyjs.com/?features=Dialog,Avatar,useBreakpoints,...

This URL filters the v0 documentation to show only the features you’re actually using, giving you a focused, clutter-free reference tailored to your project. Share this URL with your team to onboard developers faster.

JSON Output

Use --reporter json to integrate with CI/CD pipelines or custom tooling:

vuetify analyze --reporter json --output report.json

upgrade

Self-upgrade the CLI to the latest version:

pnpm dlx @vuetify/cli upgrade

npx @vuetify/cli upgrade

yarn dlx @vuetify/cli upgrade

bunx @vuetify/cli upgrade

Scaffolding Options

The interactive wizard guides you through project configuration:

Platforms

CSS Frameworks

Router Options (Vue only)

Features

Non-Interactive Mode

For CI/CD pipelines and automation, pass arguments directly:

pnpm create vuetify0 my-app \
  --platform=vue \
  --css=unocss \
  --router=router \
  --features=eslint,pinia \
  --install

npm create vuetify0 my-app -- \
  --platform=vue \
  --css=unocss \
  --router=router \
  --features=eslint,pinia \
  --install

yarn create vuetify0 my-app \
  --platform=vue \
  --css=unocss \
  --router=router \
  --features=eslint,pinia \
  --install

bun create vuetify0 my-app \
  --platform=vue \
  --css=unocss \
  --router=router \
  --features=eslint,pinia \
  --install

All Arguments