UNDER CONSTRUCTION

Documentation

coming soon

We're working hard to bring you comprehensive documentation.In the meantime, check out the demo video and GitHub repository below.

See it in
action

Watch how compadcn streamlines your shadcn workflow

See compadcn's interactive TUI, smart linting, and preset management in action

Quick Start

Get compadcn up and running in under 2 minutes

1. Installation

# Install globally
npm install -g compadcn

Install compadcn globally to use it in any project with shadcn-ui components.

2. First Use

# Navigate to your project
cd my-shadcn-project
# Start adding components
compadcn add

Navigate to your project directory and start the interactive component selector.

Requirements

✓

Node.js 18.0.0 or higher

✓

A shadcn project with components.json

✓

npm, pnpm, yarn, or bun

For now, visit
the repository

Complete command reference, examples, and usage guides are available in the GitHub repository

GitHub Repository

Browse the source code, read the README, and find detailed command usage examples

Command Reference

Jump directly to the commands section for quick reference and usage examples

Work in Progress

This documentation site is actively being developed. We're working on comprehensive guides. Follow the repository for updates!