-
Notifications
You must be signed in to change notification settings - Fork 3.4k
FAQ
This FAQ covers the most common questions and issues users encounter when using AionUi.
A: AionUi is available for Windows, macOS, and Linux. Download the latest release from our GitHub releases page and follow the installation instructions for your operating system.
A:
- Operating System: Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)
- Memory: Minimum 4GB RAM, recommended 8GB+
- Storage: At least 2GB free space
- Network: Internet connection for AI model access
A: AionUi requires modern operating systems due to its Electron-based architecture. We recommend updating to supported versions for the best experience.
A: No, you can start with just one platform. We recommend beginning with Google Gemini (free) or OpenAI (if you have credits). You can add more platforms later as needed.
A:
- Visit Google AI Studio
- Sign in with your Google account
- Navigate to "Get API Key" and create a new key
- Copy the key and paste it into AionUi's LLM settings
A:
- Verify the key is correctly copied (no extra spaces or characters)
- Check if the key has expired or been revoked
- Ensure you have sufficient credits/quota remaining
- Try regenerating the key from the platform's dashboard
A: Yes! AionUi supports multiple API keys per platform with automatic rotation. This helps with rate limits and reliability.
A: AionUi is a free, open-source, Cowork app with AI Agents - a desktop application where AI agents work alongside you on your computer. AionUi ships with a complete AI agent engine built in, so it works the moment you install it. Key features include:
- Built-in Agent | Zero Setup - Complete AI agent engine bundled with AionUi, no CLI to install
- Multi-Agent Mode - Auto-detects supported CLI agents on your machine (Claude Code, Codex, Qwen Code, Gemini CLI, Cursor Agent, Hermes, Pi, and more) so you can use them as backends
- Automated Task Execution - AI agents can independently execute tasks, run scripts, read/write files, and operate tools automatically
- Workflow Automation - Complete workflow automation capabilities with file system operations and task completion
- Cross-Platform Support - Available on macOS, Windows, and Linux
- Free & Open Source - Complete open source solution with no subscription fees
A: Main differences:
- Built-in Agent: Powered by the embedded aionrs engine and included with AionUi — no external CLI installation needed. AionUi can pair it with configured models, assistants, Skills, MCP tools, image tools, and scheduled tasks.
- Multi-Agent Mode: When a supported CLI agent is installed, AionUi can detect it and offer it as a backend for conversations or assistants. Available models, tools, permissions, MCP integration, and unattended modes still depend on that agent.
A: Selection recommendations:
- Daily use: The Built-in Agent is the most integrated starting point and works without installing an external CLI.
- Already invested in another CLI: If you've already configured Claude Code, Codex, Qwen Code, Cursor, etc., switch the backend per-assistant or per-conversation — your existing CLI authentication keeps working.
- Mix and match: Different assistants can run on different backends. For example, keep code-heavy assistants on Claude Code while letting general assistants run on the Built-in Agent.
A: Model switching is supported in two places:
- In a conversation — click the agent/model chip in the conversation header to switch to any configured model on the fly.
- Per assistant — open Settings → Assistants, edit the assistant, and pick a different backend Agent + model. The change applies the next time you open a conversation with that assistant.
- Per scheduled task — pick a model when creating the task; edit it any time from the task detail page.
A: Check the following configuration:
- Enable image generation in "Tools Settings"
- Select a model that supports image generation
- Refer to Image Generation Configuration Guide
A: Choose a model that currently advertises image-generation support in AionUi. Model names, availability, and pricing change frequently, so check the selected provider’s latest documentation.
A:
- Set up a platform with image models (Gemini or OpenRouter)
- Go to Settings → Tools → Image Generation
- Select an image generation model
- Test with a simple prompt like "Generate a sunset landscape"
A:
- Choose faster models (like Gemini image models)
- Reduce image resolution requirements
- Check your internet connection
- Consider upgrading to premium models for better performance
A: All conversations are saved locally:
-
macOS:
~/Library/Application Support/AionUi/ -
Windows:
%APPDATA%/AionUi/ -
Linux:
~/.config/AionUi/
A:
- Manually copy the configuration file directory
- Export your configuration file
- Store it safely for future restoration
A: Yes, you can reset settings:
- Close AionUi completely
- Delete the configuration folder
- Restart AionUi to create fresh settings
A:
- Check if another instance is already running
- Restart your computer
- Reinstall AionUi if the problem persists
- Check our GitHub issues for known problems
A:
- Verify the key is correctly entered
- Check if the key has expired
- Ensure you have sufficient credits
- Try regenerating the key
A:
- Check if you have write permissions to the AionUi data directory
- Ensure sufficient disk space is available
- Try restarting AionUi
A:
- Close unnecessary applications to free up memory
- Check your internet connection
- Try reducing the number of concurrent conversations
- Restart AionUi
A:
- Automatic: AionUi will notify you of updates
- Manual: Download the latest version from GitHub releases
- Settings: Check for updates in Settings → About
A: No, updates preserve your settings and conversation history. However, we recommend backing up important data before major updates.
A: We release updates regularly with new features, bug fixes, and improvements. Follow our GitHub releases for the latest updates.
A:
- Conversations are stored locally on your device
- API keys are encrypted and stored securely
- We don't collect personal data without your consent
- Review our privacy policy for detailed information
A:
- Manually delete conversation data from the configuration file directory
- Or delete the entire configuration folder to reset all data
- Restart AionUi to apply changes
A:
- GitHub Issues: Report bugs and request features
- GitHub Discussions: Ask questions and share tips
- Documentation: Check our comprehensive guides
- Community: Join our user community for support
A:
- Code: Submit pull requests for bug fixes and features
- Documentation: Help improve our guides and tutorials
- Testing: Report issues and provide feedback
- Community: Help other users in discussions
A: Yes! AionUi is completely free and open source and available on GitHub. As a free, open-source Cowork app with AI Agents, AionUi provides:
- Full source code access
- Community-driven development
- No subscription fees or hidden costs
- Transparent development process
- We welcome contributions from the community
- Getting Started Guide: Complete setup tutorial
- LLM Configuration: Detailed model setup guide
- Multi-Agent Mode Setup: External CLI tool integration
- Image Generation Setup: Image generation configuration
Still have questions? Open an issue or start a discussion on GitHub!
Welcome to the comprehensive AionUi documentation! Find everything you need to configure, use, and master AionUi.
- ⚙️ LLM Configuration
- 🤖 Multi-Agent Mode Setup
- 🎨 Image Generation Setup
- 🧩 Assistant Configuration
- 🔌 MCP Configuration
- 💻 WebUI Configuration
- 🌐 Remote Internet Access
- 🤖 DingTalk Bot Setup
- 💬 Slack Bot Setup
- 🎮 Discord Bot Setup
- ⏰ Scheduled Tasks Guide
- 🛠️ AI Assistants & Skills Ecosystem
- 📄 Preview Panel Guide
- 📁 File Management
- 📊 Excel Smart Processing
- 🔍 Smart Information Gathering
- 📚 Local Knowledge Base Application
- ❓ AI Learning Assistant
- ✍️ Writing & Content Creation
- 🚀 Getting Started
- ⚙️ LLM Configuration
- 🤖 Multi-Agent Mode Setup
- 🧩 Assistant Configuration
- 🎨 Image Generation
- 🔌 MCP Configuration
- 🌐 WebUI Configuration
- ⏰ Scheduled Tasks
- 🛠️ AI Assistants & Skills
- 📄 Preview Panel
- ❓ FAQ