@kahwati/random-icon-generator NPM

🤖 Random Robot Icon Generator

Generate unique, robot-style avatars for your applications. Perfect for user profiles, Chrome Extensions, and anywhere you need distinctive, programmatically-generated icons.

🚀 CLI Guide • 📖 API Reference • 🎨 Examples • 🤝 Contributing

🚀 CLI Guide

Installation

# Install latest version globally
sudo npm install -g @kahwati/random-icon-generator@latest

# Verify installation
random-icon-generator --version

# Update to latest version
sudo npm update -g @kahwati/random-icon-generator

# Uninstall
sudo npm uninstall -g @kahwati/random-icon-generator

Basic Usage

# Generate icons in current directory
random-icon-generator generateIcons

# Generate icons in specific directory
random-icon-generator generateIcons ./my-icons

# Generate icons for Chrome Extension
random-icon-generator generateIcons ./extension/icons

Common Use Cases

Chrome Extension Icons

# Create extension icons directory
mkdir -p my-extension/icons

# Generate full icon set
random-icon-generator generateIcons my-extension/icons

User Avatar Set

# Create avatars directory
mkdir user-avatars

# Generate unique avatar set
random-icon-generator generateIcons user-avatars

Multiple Projects

# Generate icons for different projects
random-icon-generator generateIcons project1/icons
random-icon-generator generateIcons project2/icons

Output Structure

After running the generator, you'll get the following files:

output-directory/
├── icon16.png   # Chrome Web Store
├── icon19.png   # Extension toolbar (standard)
├── icon32.png   # Windows compatibility
├── icon38.png   # Extension toolbar (retina)
├── icon48.png   # Extensions page
├── icon96.png   # High-DPI displays
├── icon128.png  # Store & installation
├── icon256.png  # Store detailed view
└── icon512.png  # Promotional tiles

Troubleshooting

Permission Issues

# If you get permission errors, try:
sudo random-icon-generator generateIcons

# Or fix permissions:
sudo chown -R $USER:$USER ~/.npm

Path Issues

# Ensure directory exists
mkdir -p path/to/icons
random-icon-generator generateIcons path/to/icons

Version Check

# Check installed version
random-icon-generator --version

# Check for updates
npm outdated -g @kahwati/random-icon-generator

📖 API Reference

For programmatic usage, see our API Documentation.

🎨 Examples

Generate Icons for Chrome Extension

# 1. Create a new extension project
mkdir my-chrome-extension
cd my-chrome-extension

# 2. Generate icon set
random-icon-generator generateIcons ./icons

# 3. Use in manifest.json
{
  "name": "My Extension",
  "icons": {
    "16": "icons/icon16.png",
    "48": "icons/icon48.png",
    "128": "icons/icon128.png"
  },
  "action": {
    "default_icon": {
      "19": "icons/icon19.png",
      "38": "icons/icon38.png"
    }
  }
}

Generate User Avatars

# 1. Set up avatars directory
mkdir -p public/avatars

# 2. Generate multiple unique sets
for i in {1..5}; do
  random-icon-generator generateIcons public/avatars/user$i
done

Batch Generation for Different Sizes

# Create directories for each size
mkdir -p icons/{small,medium,large}

# Generate different sets
random-icon-generator generateIcons icons/small   # For small icons (16-48px)
random-icon-generator generateIcons icons/medium  # For medium icons (96-128px)
random-icon-generator generateIcons icons/large   # For large icons (256-512px)

🤝 Contributing

Development Setup

# 1. Clone the repository
git clone https://github.com/Devehab/random-icon-generator.git
cd random-icon-generator

# 2. Install dependencies
npm install

# 3. Run tests
npm test

# 4. Try generating icons
node cli.js generateIcons test-icons

Common Development Tasks

# Run linting
npm run lint

# Run tests with coverage
npm run test:coverage

# Build documentation
npm run docs

# Create a new release
npm version patch  # or minor/major
npm publish