cute-kitty-ui-cli
v3.0.3
Published
CLI tool for installing Cute-Kitty-UI components
Maintainers
Readme
Cute-Kitty-UI CLI
Add adorable cat components to your React project
Overview
Cute-Kitty-UI CLI is a command-line tool that helps you add cute, customizable cat components to your React project. It follows the shadcn-style approach where components are copied directly into your codebase, giving you full control over the code.
Installation
# Install globally
npm install -g cute-kitty-ui-cli
# Or use directly with npx
npx cute-kitty-ui-cli@latest <command>Commands
Initialize Cute-Kitty-UI in your project
npx cute-kitty-ui-cli@latest initThis command will:
- Detect your project type (Next.js, Vite, CRA)
- Create a components directory for Kitty-UI
- Install required dependencies
- Update your tsconfig.json with path aliases
Add a component
npx cute-kitty-ui-cli@latest add <component-name>Available components:
sitting-catlying-catstanding-catsleeping-catplaying-catholding-sign-catpeeking-catface-only-cat
Options:
-p, --path <path>- Component installation path (default:src/components/cute-kitty-ui)-o, --overwrite- Overwrite existing components
Usage Example
import { SittingCat } from '@/components/cute-kitty-ui/sitting-cat'
export default function MyComponent() {
return (
<SittingCat
emotion="happy"
size="md"
animated
primaryColor="#FF6B9D"
/>
)
}Documentation
For full documentation, visit cute-kitty-ui
Contributing
We welcome contributions! Please see our Contributing Guide for more details.
License
MIT © Cute-Kitty-UI
