Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mvpblocks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
π MVPBlocks CLI
The official command-line interface for MVPBlocks - Copy, paste, customizeβand launch your idea faster than ever!
MVPBlocks CLI allows you to quickly add beautiful, responsive components to your React/Next.js projects directly from your terminal.
β¨ Features
- π¨ Beautiful Terminal UI - Stunning ASCII art and colorful interface
- π Smart Search - Find components by name, description, or category
- π¦ Auto Dependencies - Automatically installs required packages
- π TypeScript & JavaScript - Support for both TS and JS projects
- ποΈ Organized Structure - Components are organized by type and category
- β‘ Lightning Fast - Quick installation and setup
π οΈ Installation
You don't need to install the CLI globally. Use it directly with npx:
npx mvpblocks --help
π Usage
List all available components
npx mvpblocks list
Add a component to your project
npx mvpblocks add button
npx mvpblocks add hero-1
Search for components
npx mvpblocks search hero
npx mvpblocks search button
View component categories
npx mvpblocks categories
Get detailed component information
npx mvpblocks info button
npx mvpblocks info hero-1
Force language preference
# Force TypeScript
npx mvpblocks add button --ts
# Force JavaScript
npx mvpblocks add button --js
π― Commands
Command | Description | Example |
---|---|---|
list |
List all available components | npx mvpblocks list |
add <component> |
Add a component to your project | npx mvpblocks add button |
search <query> |
Search for components | npx mvpblocks search hero |
categories |
List all available categories | npx mvpblocks categories |
info <component> |
Get detailed component information | npx mvpblocks info button |
help |
Show help message | npx mvpblocks help |
ποΈ Project Structure
After adding components, your project will have this structure:
your-project/
βββ components/
β βββ ui/ # Basic UI components (buttons, inputs, etc.)
β βββ mvpblocks/ # Block components (heroes, features, etc.)
βββ hooks/ # Custom React hooks
βββ lib/
β βββ utils.ts # Utility functions (automatically created)
βββ ...
π§ Options
--ts, --typescript
- Force TypeScript output--js, --javascript
- Force JavaScript output--help, -h
- Show help message
π Requirements
- Node.js 18 or higher
- A React/Next.js project with Tailwind CSS
- Package manager: npm, yarn, pnpm, or bun
π¨ Component Types
- UI Components (
registry:ui
) - Basic building blocks like buttons, inputs, cards - Block Components (
registry:block
) - Complete sections like heroes, features, testimonials - Hooks (
registry:hook
) - Custom React hooks for enhanced functionality - Library (
registry:lib
) - Utility functions and helpers
π Quick Start
Create a new Next.js project (if you don't have one):
npx create-next-app@latest my-project --typescript --tailwind --eslint cd my-project
Add your first component:
npx mvpblocks add button
Use the component in your project:
import { Button } from "@/components/ui/button" export default function App() { return ( <Button>Click me</Button> ) }
π Links
- Website: https://blocks.mvp-subha.me
- GitHub: https://github.com/subhadeeproy3902/mvpblocks
- Documentation: https://blocks.mvp-subha.me/docs
π€ Contributing
We welcome contributions! Please see our Contributing Guide for details.
π License
MIT License - see the LICENSE file for details.
π¨βπ» Author
Subhadeep Roy
- GitHub: @subhadeeproy3902
- Twitter: @mvp_Subha
Made with β€οΈ for the developer community