🚀 KiviUI CLI

A powerful command-line interface for installing React and Next.js components from the KiviUI component library.

📋 Table of Contents

• Features
• Installation
• Usage
• Commands
• Examples
• Project Structure
• Contributing
• Author

✨ Features

• 🎨 Beautiful UI Components: Access to a curated collection of React and Next.js components
• 🚀 Fast Installation: Install components with a single command
• 📦 Batch Operations: Install all components at once
• 🎯 TypeScript Support: Components available in both TypeScript and JavaScript
• 🎨 Modern Design: Components follow modern design principles
• 📱 Responsive: All components are mobile-friendly
• ⚡ Lightweight: Minimal dependencies, fast performance

📦 Installation

Global Installation (Recommended)

npm install -g kiviui-cli

Local Installation

npm install kiviui-cli

Manual Installation

1. Clone the repository:

git clone https://github.com/Vegadjay/kiviui-cli.git
cd kiviui-cli

2. Install dependencies:

npm install

3. Make it executable:

chmod +x index.js

🚀 Usage

Basic Usage

kivi <command> [options]

Quick Start

1. Show CLI information:

kivi info

2. List available components:

kivi list

3. Install a component:

kivi add <component-name>

4. Install all components:

kivi create all

📚 Commands

kivi info

Shows detailed information about the KiviUI CLI.

Output includes:

• KiviUI ASCII art
• Version information
• Author details
• GitHub repository
• Registry URL
• Description

Example:

kivi info

kivi list

Lists all available components in the registry.

Output includes:

• Component names
• Component titles (if available)
• Component types (if available)

Example:

kivi list

kivi add <name>

Installs a specific component from the registry.

Parameters:

• name (required): The name of the component to install

Output includes:

• Installation progress
• Component details (name, title, type, author)
• File locations
• Success confirmation

Example:

kivi add button
kivi add card
kivi add navigation

kivi create all

Installs all available components from the registry.

Features:

• Downloads all components sequentially
• Shows progress for each component
• Provides success/error tracking
• Displays summary at the end

Example:

kivi create all

💡 Examples

Installing a Single Component

# Install a button component
kivi add button

# Install a card component
kivi add card

# Install a navigation component
kivi add navigation

Installing All Components

# Install all available components
kivi create all

Checking Available Components

# List all available components
kivi list

Getting CLI Information

# Show CLI information and author details
kivi info

📁 Project Structure

After installation, components are organized in the kiviui/ folder:

your-project/
├── kiviui/
│   ├── components/
│   │   ├── button/
│   │   │   ├── Button.tsx
│   │   │   ├── Button.jsx
│   │   │   └── index.ts
│   │   ├── card/
│   │   │   ├── Card.tsx
│   │   │   ├── Card.jsx
│   │   │   └── index.ts
│   │   └── ...
│   ├── styles/
│   │   └── globals.css
│   └── utils/
│       └── helpers.ts
├── package.json
└── ...

🎨 Component Types

KiviUI provides various types of components:

• UI Components: Buttons, cards, inputs, modals
• Layout Components: Navigation, sidebar, footer
• Data Display: Tables, lists, charts
• Feedback Components: Alerts, notifications, loaders
• Form Components: Inputs, selects, checkboxes
• Media Components: Images, videos, icons

🔧 Configuration

Registry URL

The CLI connects to the KiviUI registry at:

http://localhost:3000/api/components

Output Directory

Components are installed in the kiviui/ folder in your current working directory.

🛠️ Development

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Setup Development Environment

1. Clone the repository:

git clone https://github.com/Vegadjay/kiviui-cli.git
cd kiviui-cli

2. Install dependencies:

npm install

3. Make the CLI executable:

chmod +x index.js

4. Link for development:

npm link

Running Tests

npm test

Building

npm run build

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contribution Guidelines

• Follow the existing code style
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Jay Vegad

• GitHub: https://github.com/Vegadjay
• Email: [Add your email here]

🙏 Acknowledgments

• Thanks to all contributors who help improve KiviUI
• Inspired by modern component libraries
• Built with love for the React community

📞 Support

If you encounter any issues or have questions:

1. Check the Issues page
2. Create a new issue with detailed information
3. Contact the author via GitHub

🔄 Changelog

Version 1.0.0

• Initial release
• Basic CLI functionality
• Component installation
• Batch operations
• Author information integration

Made with ❤️ by Jay Vegad