mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-24 05:05:44 +00:00
105 lines
2.4 KiB
Plaintext
105 lines
2.4 KiB
Plaintext
---
|
||
title: CLI
|
||
description: Use the CLI to add components to your project.
|
||
---
|
||
|
||
<Callout>
|
||
|
||
**Note:** We just released a new `shadcn` CLI. See the [changelog](/docs/changelog) for more information.
|
||
|
||
</Callout>
|
||
|
||
## init
|
||
|
||
Use the `init` command to initialize configuration and dependencies for a new project.
|
||
|
||
The `init` command installs dependencies, adds the `cn` util, configures `tailwind.config.js`, and CSS variables for the project.
|
||
|
||
```bash
|
||
npx shadcn@latest init
|
||
```
|
||
|
||
You will be asked a few questions to configure `components.json`:
|
||
|
||
```txt showLineNumbers
|
||
Which style would you like to use? › New York
|
||
Which color would you like to use as base color? › Zinc
|
||
Do you want to use CSS variables for colors? › no / yes
|
||
```
|
||
|
||
### Options
|
||
|
||
```txt
|
||
Usage: shadcn init [options] [components...]
|
||
|
||
initialize your project and install dependencies
|
||
|
||
Arguments:
|
||
components the components to add or a url to the component.
|
||
|
||
Options:
|
||
-d, --defaults use default values i.e new-york, zinc and css variables. (default: false)
|
||
-f, --force force overwrite of existing components.json. (default: false)
|
||
-y, --yes skip confirmation prompt. (default: false)
|
||
-c, --cwd <cwd> the working directory. defaults to the current directory.
|
||
-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]
|
||
```
|
||
|
||
You will be presented with a list of components to choose from:
|
||
|
||
```txt
|
||
Which components would you like to add? › Space to select. A to toggle all.
|
||
Enter to submit.
|
||
|
||
◯ accordion
|
||
◯ alert
|
||
◯ alert-dialog
|
||
◯ aspect-ratio
|
||
◯ avatar
|
||
◯ badge
|
||
◯ button
|
||
◯ calendar
|
||
◯ card
|
||
◯ checkbox
|
||
```
|
||
|
||
### Options
|
||
|
||
```txt
|
||
Usage: shadcn add [options] [components...]
|
||
|
||
add a component to your project
|
||
|
||
Arguments:
|
||
components the components to add or a url to the 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.
|
||
-p, --path <path> the path to add the component to.
|
||
-h, --help display help for command
|
||
```
|
||
|
||
## Monorepo
|
||
|
||
In a monorepo, you can specify the path to your workspace with the `-c` or `--cwd` option.
|
||
|
||
```bash
|
||
npx shadcn@latest init -c ./apps/www
|
||
```
|
||
|
||
or
|
||
|
||
```bash
|
||
npx shadcn@latest add alert-dialog -c ./apps/www
|
||
```
|