Package Exports
- @syntaxility/axiomai
- @syntaxility/axiomai/dist/index.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 (@syntaxility/axiomai) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Axiom AI
AI-Powered Icon Generator CLI for Mobile App Developers
Overview
Axiom AI is a powerful Command Line Interface (CLI) tool designed to streamline the creation of professional, high-quality mobile app icons.
Powered by OpenAI image generation models, Axiom AI enables developers to generate custom icons in multiple styles and resolutions using simple natural-language descriptions, directly from the terminal.
The tool is optimized for speed, consistency, and developer experience, making it suitable for both rapid prototyping and production-ready workflows.
Features
- Freemium & Premium Plans: Flexible usage tiers to suit your needs:
- Freemium: Try the tool instantly with 1 free generation (no API key required).
- Premium: Bring your own OpenAI API key for unlimited icon generation.
- Multiple Art Styles: Choose from a wide range of curated styles including:
- Minimalism, Glassy, Woven, Geometric
- Neon, Gradient, Flat, Material
- iOS Classic, Android Material
- Pixel Art, Game Design, Clay, Holographic
- Flexible Sizing: Generate icons in standard and custom resolutions:
- Square: 256x256, 512x512, 1024x1024
- Portrait: 1024x1536
- Landscape: 1536x1024
- Transparency Support: Option to generate icons with transparent backgrounds (model dependent).
- Auto-Saving: Automatically saves generated assets to a local
./generated-iconsdirectory with timestamps. - Secure Config: Safely stores your OpenAI API key locally so you only need to enter it once.
- Beautiful CLI: enhancing user experience with rich interactive prompts, spinners, and gradient text.
Getting Started
Prerequisites
- Node.js (v18.0.0 or higher)
- OpenAI API Key: (Optional) Required for Premium plan unlimited access. Get one from OpenAI Platform.
Installation
Clone the repository
git clone https://github.com/SyntaxilitY/Axiom-AI-Cli.git cd Axiomai
Install dependencies Using pnpm (recommended) or npm:
pnpm install # or npm install
Build the project
npm run build
Usage
To run the generator locally:
npm startOr use the direct CLI command if linked:
npm install -g axiomaiaxiomaiThe Workflow
- Select Plan: On startup, choose between Freemium or Premium tires.
- Freemium allows you to generate 1 icon for free.
- Premium requires your own API key but offers unlimited usage.
- API Key Setup: If you choose Premium and it's your first time, you will be prompted to enter your OpenAI API Key. This is saved securely for future use.
- Describe Your Icon: Enter a text prompt describing what you want (e.g., "A futuristic robot holding a lightning bolt").
- Select Style: Choose from the list of artistic styles.
- Select Size: Pick the resolution that fits your needs.
- Transparency: Toggle transparent background preference.
- Generate: Watch the magic happen! The generated image will be saved to
./generated-icons.
Project Structure
src/cli.ts: Main entry point for the CLI application, handling the interactive flow and plan selection.src/commands/: Contains command definitions and logic.src/services/: Handles external API integrations (OpenAI) and configuration.src/utils/: Helper utilities for prompts, styling, and file management.src/detector.ts: System fingerprinting for usage tracking.src/trackFreemiumUsage.ts: Manages local usage limits for the Freemium tier.
Prompts
1. Axiom AI Icon
Create a modern, high-quality app icon for a CLI tool named “Axiom AI”.
The icon should be inspired by a terminal welcome banner.
Design style:
- Futuristic and professional
- Dark background similar to a terminal screen
- Bold typography inspired by ANSI Shadow / ASCII art text
- The text “Axiom AI” should feel carved, layered, or shadowed like terminal banner fonts
- Apply a smooth gradient flowing left to right using electric blue, purple, and soft red tones
- Subtle glow and neon highlights, but not flashy
- Clean, minimal, developer-centric aesthetic
Visual elements:
- Terminal or command-line atmosphere
- Soft light reflections on the text
- Balanced spacing with strong contrast
- No clutter, no additional symbols unless abstract and minimal
Composition:
- Centered layout
- Full-bleed icon
- Optimized for clarity at small sizes
- Professional, premium, AI-driven branding
Output:
- Crisp edges
- Flat or slightly 3D depth
- Suitable for macOS, Windows, and mobile app iconsContributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Built with ❤️ using TypeScript and OpenAI