shadcn-vue/packages/cli/README.md
2023-09-06 13:06:58 +08:00

43 lines
862 B
Markdown

# shadcn-vue
A CLI for adding components to your project.
## Usage
Use the `init` command to initialize 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-vue init
```
## add
Use the `add` command to add components to your project.
The `add` command adds a component to your project and installs all required dependencies.
```bash
npx shadcn-vue add [component]
```
### Example
```bash
npx shadcn-vue add alert-dialog
```
You can also run the command without any arguments to view a list of all available components:
```bash
npx shadcn-vue add
```
## Documentation
Visit http://shadcn-vue.com to view the documentation.
## License
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).