UNPKG

shadcn

Version:

Add components to your apps.

52 lines (31 loc) 1.03 kB
# shadcn A CLI for adding components to your project. ## create Use the `create` command to create a new project. You will be taken to a website to build your custom design system and choose your framework. ```bash npx shadcn create ``` ## init Use the `init` command to initialize dependencies for a new project. The `init` command installs dependencies, adds the `cn` util, configures Tailwind CSS, and CSS variables for the project. ```bash npx shadcn 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 add [component] ``` ### Example ```bash npx shadcn add alert-dialog ``` You can also run the command without any arguments to view a list of all available components: ```bash npx shadcn add ``` ## Documentation Visit https://ui.shadcn.com/docs/cli to view the documentation. ## License Licensed under the [MIT license](https://github.com/shadcn-ui/ui/blob/main/LICENSE.md).