0.1.16 • Published 9 months ago
@quick-gen/cli v0.1.16
@quick-gen/cli
A quick and flexible code generation toolkit.
🚀 Features
- 📝 Code Generation: Generate various types of code and documentation
- 🔧 Plugin System: Extensible architecture for different generation needs
- 🎯 Easy to Use: Simple and intuitive CLI interface
- 🔄 More features coming soon...
📦 Installation
Global Installation (Recommended)
# Using npm
npm install -g @quick-gen/cli
# Using yarn
yarn global add @quick-gen/cli
# Using pnpm
pnpm add -g @quick-gen/cliLocal Installation
# Using npm
npm install @quick-gen/cli --save-dev
# Using yarn
yarn add -D @quick-gen/cli
# Using pnpm
pnpm add -D @quick-gen/cli🎯 Usage
Generate React Documentation
# Using global installation
quick-gen react -d src/components
# Using local installation
npx quick-gen react -d src/componentsCommon Commands
# Generate docs for components
quick-gen react -d src/components
# Show help
quick-gen --helpCLI Options
| Command | Description |
|---|---|
react -d [dir] | Generate JSDoc for React components |
React Command Options
| Option | Alias | Description | Default |
|---|---|---|---|
--dir | -d | Directory to scan for React components | src |
--help | -h | Show help |
🛠️ Requirements
- Node.js >= 14
- React project with
.jsor.jsxfiles
📦 Related Packages
- @quick-gen/cli - Core CLI tool
- @quick-gen/react - React documentation generator