icon-gen-cli
v1.0.1
Published
A command-line tool to generate custom icons in SVG and PNG formats. Create basic shapes, patterns, or convert emojis into icons with just a few simple prompts.
Downloads
135
Readme
Icon Generator CLI
A command-line tool to generate custom icons in SVG and PNG formats. Create basic shapes, patterns, or convert emojis into icons with just a few simple prompts.
Features
- 📐 Basic Shapes: circle, square, triangle, hexagon, star, donut, heart
- 🎨 Pattern Generation: geometric, dots, stripes, zigzag, mosaic
- 🎯 Multiple output formats (SVG, PNG)
- 🌈 Custom colors and gradients
- 🖼️ Adjustable sizes
- 🎆 Background customization
Installation
# Install globally
npm install -g icon-gen-cli
# Or run directly with npx
npx icon-gen-cli
Usage
# Start the interactive CLI
icon-gen
Follow the interactive prompts to:
- Choose the type of icon (basic shape, pattern, or emoji)
- Select specific shape or pattern
- Set size and colors
- Choose output format
- Specify filename
Example Commands
# Generate a basic shape
icon-gen
> basic shape
> circle
> 200
> #ff0000
> svg
> my-icon.svg
# Generate from emoji
icon-gen
> emoji
> 🚀
> transparent
> png
> rocket.png
# Generate a pattern
icon-gen
> pattern
> geometric
> 300
> #ff0000,#00ff00,#0000ff
> png
> pattern.png
Examples
Basic Shapes
Patterns
Emoji Icons
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
Development
# Clone the repository
git clone https://github.com/yourusername/icon-gen-cli.git
# Install dependencies
cd icon-gen-cli
npm install
# Link for local development
npm link
# Run tests
npm test
License
MIT © [Your Name]
Credits
Made with ❤️ by Chinmay