Package Exports
- snapai
- snapai/bundle/snapai.js
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 (snapai) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
SnapAI - AI Icon Generation CLI
Generate beautiful app icons using AI, perfect for mobile developers using Expo and React Native.
Quick Start
Installation
npm install -g snapai
# or
pnpm install -g snapai
# or
npx snapai
Local Development Setup
Quick Setup
cd /Users/beto/Desktop/apps/iconiq
pnpm install
pnpm run build
# Create alias for easy testing
alias snapai-dev="/Users/beto/Desktop/apps/iconiq/bin/dev.js"
Development with Hot Reload
For active development with automatic recompilation:
# Terminal 1: Start TypeScript compiler in watch mode
pnpm run dev
# Terminal 2: Test your changes (auto-rebuilds on save)
./bin/dev.js --help
./bin/dev.js icon --prompt "test icon"
# Or use the dev wrapper (same as above but shorter)
./dev-cli.js --help
./dev-cli.js icon --prompt "test icon"
One-off Testing
# Build and test immediately
pnpm run build && ./bin/dev.js --help
Setup
Add your OpenAI API key (required):
snapai config --api-key sk-your-openai-api-key-here
Generate Icons
# Generate an iOS app icon
snapai icon --prompt "minimalist calculator app icon"
# Custom output directory
snapai icon --prompt "fitness tracker app" --output ./assets/icons
Commands
snapai config
Manage configuration settings:
snapai config --api-key YOUR_KEY # Set OpenAI API key
snapai config --show # Show current settings
snapai config --telemetry false # Disable usage tracking
snapai icon
Generate app icons:
snapai icon --prompt "your icon description"
snapai icon --prompt "..." --output ./custom/path
snapai icon --help # Show all options
Requirements
- Node.js 18+
- OpenAI API key (get one at platform.openai.com)
Pricing
SnapAI is free to use - you only pay OpenAI for API usage:
- ~$0.04 per 1024x1024 icon (standard quality)
- ~$0.08 per 1024x1024 icon (HD quality)
Privacy
SnapAI collects anonymous usage statistics to improve the tool. No personal data, API keys, or prompt content is collected. You can opt out anytime:
snapai config --telemetry false
Support
- 🐛 Report issues: GitHub Issues
- 📖 Documentation: snapai.dev
- 💬 Community: Discord
Contributing
- 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
License
MIT - see LICENSE file for details.