@doffu/uigen v1.0.0

UI Gen

A modern CLI tool for scaffolding and managing UI components across different component libraries. Generate, customize, and maintain your UI components with ease.

Features ✨

• 🚀 Quick component generation
• 📚 Support for multiple UI libraries
• 🎨 Customizable templates
• 🔄 Auto-install dependencies
• 📦 Built-in component registry
• 🛠 TypeScript support
• 🧪 Test file generation

Installation 🔧

not yet published to npm, you can build it locally and link it to your project.

# Using npm
npm install -g uigen

# Using yarn
yarn global add uigen

# Using pnpm
pnpm add -g uigen

Usage 💻

Basic Commands

# Generate a new component
uigen add button

# Generate with specific options
uigen add -c button -l aceternity -o ./components/ui

# List available components
uigen list

# Show help
uigen help

# Show version
uigen --version

Command Options

Options:
  -c, --component <name>    Component name
  -l, --library <name>      UI library (default: "shadcn")
  -o, --outDir <path>      Output directory

Supported Libraries 📚

• Aceternity UI
• More coming soon...

Project Structure 📁

your-project/
├── components/
│   └── ui/
│       ├── button/
│       │   ├── button.tsx
│       │   └── button.test.tsx
│       └── form/
│           ├── form.tsx
│           └── form.test.tsx
└── lib/
    └── utils/
        └── cn.ts

Configuration (wip) ⚙️

Create a uigen.config.js file in your project root:

module.exports = {
  outDir: './components/ui',
  library: 'shadcn',
  typescript: true,
  test: true,
  prettier: true,
  registry: {
    // Custom component registry
  },
};

Contributing 🤝

Contributions are welcome! Please read our Contributing Guide for details.

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

Roadmap 🗺️

• Add more UI libraries
• Component dependency management
• Interactive component customization
• Component documentation generator
• Component showcase generator
• Visual component editor

License 📄

MIT © DoffuXx

Acknowledgments 🙏

• Inspired by shadcn/ui
• Built with Commander.js
• Uses TypeScript