percolate-ui
v1.0.0
Published
CLI for Percolate UI - A comprehensive design system
Maintainers
Readme
Percolate UI CLI
A comprehensive CLI tool for creating beautiful React applications with the Percolate UI design system.
Features
- 🎨 Complete Design System - Pre-built components with consistent styling
- 🚀 Quick Setup - Get started in seconds with
npx percolate-ui create - 🎛️ Live Customization - Real-time design controls (Complete template)
- 📱 Responsive - Mobile-first responsive components
- 🌙 Dark Mode - Built-in dark mode support
- ♿ Accessible - WCAG 2.1 AA compliant components
- 🔧 TypeScript - Full TypeScript support
Quick Start
Create a new project
```bash npx percolate-ui create my-app cd my-app npm run dev ```
Initialize in existing project
```bash npx percolate-ui init ```
Add components
```bash npx percolate-ui add button npx percolate-ui add card npx percolate-ui add dialog ```
Templates
Starter Template
- Essential components (Button, Card, Input)
- Basic theming setup
- Perfect for getting started quickly
Complete Template
- Full component library (35+ components)
- Live design controls
- Advanced theming system
- Production-ready features
Commands
create <project-name>
Create a new Percolate UI project
```bash npx percolate-ui create my-app --template complete ```
Options:
-t, --template <template>- Choose template (starter, complete)--skip-install- Skip installing dependencies
init
Initialize Percolate UI in an existing project
```bash npx percolate-ui init --template starter ```
add <component>
Add a component to your project
```bash npx percolate-ui add button ```
Available components:
- button, card, input, dialog, accordion, alert
- avatar, badge, checkbox, dropdown-menu, hover-card
- label, popover, progress, radio-group, scroll-area
- select, separator, sheet, slider, switch, tabs
- textarea, tooltip
Interactive Mode
Run without arguments for interactive mode:
```bash npx percolate-ui ```
Requirements
- Node.js 16+
- npm, yarn, or pnpm
License
MIT
