mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-15 20:01:35 +00:00
7304ef2105
* docs(www): namespaced registries * fix * docs(www): add cli command to docs * fix * docs(www): update registry docs * feat(shadcn): add mcp init command * docs: restructure mcp docs * chore: add changesets * fix: formatting * fix(shadcn): dependencies * debug * fix * docs: add more troubleshooting docs * docs: update registry docs * feat(shadcn): add audit checklist tool * chore: add mcp flag * fix: format * docs: replace beta with latest * docs: add changelog * fix
226 lines
5.3 KiB
Plaintext
226 lines
5.3 KiB
Plaintext
---
|
|
title: shadcn
|
|
description: Use the shadcn CLI to add components to your project.
|
|
---
|
|
|
|
## init
|
|
|
|
Use the `init` command to initialize configuration and dependencies for a new project.
|
|
|
|
The `init` command installs dependencies, adds the `cn` util and configures CSS variables for the project.
|
|
|
|
```bash
|
|
npx shadcn@latest init
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn init [options] [components...]
|
|
|
|
initialize your project and install dependencies
|
|
|
|
Arguments:
|
|
components name, url or local path to component
|
|
|
|
Options:
|
|
-t, --template <template> the template to use. (next, next-monorepo)
|
|
-b, --base-color <base-color> the base color to use. (neutral, gray, zinc, stone, slate)
|
|
-y, --yes skip confirmation prompt. (default: true)
|
|
-f, --force force overwrite of existing configuration. (default: false)
|
|
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
|
-s, --silent mute output. (default: false)
|
|
--src-dir use the src directory when creating a new project. (default: false)
|
|
--no-src-dir do not use the src directory when creating a new project.
|
|
--css-variables use css variables for theming. (default: true)
|
|
--no-css-variables do not use css variables for theming.
|
|
--no-base-style do not install the base shadcn style
|
|
-h, --help display help for command
|
|
```
|
|
|
|
---
|
|
|
|
## add
|
|
|
|
Use the `add` command to add components and dependencies to your project.
|
|
|
|
```bash
|
|
npx shadcn@latest add [component]
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn add [options] [components...]
|
|
|
|
add a component to your project
|
|
|
|
Arguments:
|
|
components name, url or local path to component
|
|
|
|
Options:
|
|
-y, --yes skip confirmation prompt. (default: false)
|
|
-o, --overwrite overwrite existing files. (default: false)
|
|
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
|
-a, --all add all available components (default: false)
|
|
-p, --path <path> the path to add the component to.
|
|
-s, --silent mute output. (default: false)
|
|
--src-dir use the src directory when creating a new project. (default: false)
|
|
--no-src-dir do not use the src directory when creating a new project.
|
|
--css-variables use css variables for theming. (default: true)
|
|
--no-css-variables do not use css variables for theming.
|
|
-h, --help display help for command
|
|
```
|
|
|
|
---
|
|
|
|
## view
|
|
|
|
Use the `view` command to view items from the registry before installing them.
|
|
|
|
```bash
|
|
npx shadcn@latest view [item]
|
|
```
|
|
|
|
You can view multiple items at once:
|
|
|
|
```bash
|
|
npx shadcn@latest view button card dialog
|
|
```
|
|
|
|
Or view items from namespaced registries:
|
|
|
|
```bash
|
|
npx shadcn@latest view @acme/auth @v0/dashboard
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn view [options] <items...>
|
|
|
|
view items from the registry
|
|
|
|
Arguments:
|
|
items the item names or URLs to view
|
|
|
|
Options:
|
|
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
|
-h, --help display help for command
|
|
```
|
|
|
|
---
|
|
|
|
## search
|
|
|
|
Use the `search` command to search for items from registries.
|
|
|
|
```bash
|
|
npx shadcn@latest search [registry]
|
|
```
|
|
|
|
You can search with a query:
|
|
|
|
```bash
|
|
npx shadcn@latest search @shadcn -q "button"
|
|
```
|
|
|
|
Or search multiple registries at once:
|
|
|
|
```bash
|
|
npx shadcn@latest search @shadcn @v0 @acme
|
|
```
|
|
|
|
The `list` command is an alias for `search`:
|
|
|
|
```bash
|
|
npx shadcn@latest list @acme
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn search|list [options] <registries...>
|
|
|
|
search items from registries
|
|
|
|
Arguments:
|
|
registries the registry names or urls to search items from. Names
|
|
must be prefixed with @.
|
|
|
|
Options:
|
|
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
|
-q, --query <query> query string
|
|
-l, --limit <number> maximum number of items to display per registry (default: "100")
|
|
-o, --offset <number> number of items to skip (default: "0")
|
|
-h, --help display help for command
|
|
```
|
|
|
|
---
|
|
|
|
## list
|
|
|
|
Use the `list` command to list all items from a registry.
|
|
|
|
```bash
|
|
npx shadcn@latest list @acme
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn list [options] <registries...>
|
|
|
|
list items from registries
|
|
|
|
Arguments:
|
|
registries the registry names or urls to list items from. Names
|
|
must be prefixed with @.
|
|
```
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn list [options] <registries...>
|
|
|
|
list items from registries
|
|
|
|
Arguments:
|
|
registries the registry names or urls to list items from. Names
|
|
must be prefixed with @.
|
|
```
|
|
|
|
---
|
|
|
|
## build
|
|
|
|
Use the `build` command to generate the registry JSON files.
|
|
|
|
```bash
|
|
npx shadcn@latest build
|
|
```
|
|
|
|
This command reads the `registry.json` file and generates the registry JSON files in the `public/r` directory.
|
|
|
|
**Options**
|
|
|
|
```bash
|
|
Usage: shadcn build [options] [registry]
|
|
|
|
build components for a shadcn registry
|
|
|
|
Arguments:
|
|
registry path to registry.json file (default: "./registry.json")
|
|
|
|
Options:
|
|
-o, --output <path> destination directory for json files (default: "./public/r")
|
|
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
|
-h, --help display help for command
|
|
```
|
|
|
|
To customize the output directory, use the `--output` option.
|
|
|
|
```bash
|
|
npx shadcn@latest build --output ./public/registry
|
|
```
|