mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-26 22:26:05 +00:00
48fe0d709f
* feat(shadcn): add file support * fix: format * fix: types * feat(shadcn): update init and add description * docs: update docs for cli * chore: add changeset
103 lines
3.2 KiB
Plaintext
103 lines
3.2 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.
|
|
-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
|
|
```
|
|
|
|
## 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
|
|
```
|