Skip Navigation

Installation

Full installation guide for the project

Shadcn-Extension

A CLI (inspired by and meant to work with shadcn-ui) for adding components to your project, making it easier to integrate and manage UI components within your codebase.

Usage

Initializing a New Project

Use the init command to initialize dependencies for a new project. This command sets up everything you need, including installing necessary dependencies, adding the cn utility, configuring tailwind.config.js, and setting up CSS variables as well as enabling shadcn-ui in your project.

  1. Initialize Dependencies

    Run the following command to initialize the project:

    pnpm dlx shadcn@latest init
    
  2. Initialize Shadcn-Extension CLI

    Next, set up your project with the shadcn-extension CLI:

    pnpm dlx @shadext/cli init
    

Adding Components

Use the add command to add components to your project. This command installs the required dependencies and integrates the specified component into your project.

  1. Add a Specific Component

    To add a specific component, specify the component name:

    pnpm dlx @shadext/cli add [component]
    

    Example:

    Adding a tree-view component:

    pnpm dlx @shadext/cli add tree-view
    
  2. View Available Components

    If you want to see a list of all available components, run the add command without any arguments:

    pnpm dlx @shadext/cli add
    

    This will display a list of components that you can add to your project.

Full Documentation

For detailed documentation, including installation guides, component usage, and more, visit the shadcn-Extension Documentation.