Reading the repo
Assembly instructions
invoke-ai/InvokeAI
Invoke is a leading creative engine for Stable Diffusion models, empowering professionals, artists, and enthusiasts to generate and create visual media using the latest AI-driven technologies. The solution offers an industry leading WebUI, and serves as the foundation for multiple commercial products.
Python#ai-art#artificial-intelligence#generative-art#image-generation
- Difficulty
- Moderate
- Time
- about 15 min
- Stars
- ★ 28,981
- Activity
- Updated this month
- License
- Apache-2.0
- Open issues
- 354
- Got it running
- Be the first
- Looked up
- 2 h ago
Saved setup from 2 h ago
Start here
Will it work on my device?
Yes, it runs on macOS
- You'll build it yourself with Python.
- It also needs MySQL running (Docker handles this).
Checking for
5 steps on macOS
Clone the repository
Needs Git: xcode-select --install. The repo uses git submodules, so the clone fetches them too.
git clone --recurse-submodules https://github.com/invoke-ai/InvokeAI.git cd InvokeAI
Install the required runtimes
Python >=3.12, <3.13
brew install uv
Start backing services
Needs: MySQL (no compose file — install locally or run via Docker)
Install dependencies
uv sync
Run the tests
uv run pytest
From the README: Installation
To get started with Invoke, Download the Launcher.
Troubleshooting, FAQ and Support
Please review our FAQ for solutions to common installation problems and other issues.
For more help, please join our [Discord][discord link].
Features
Full details on features can be found in our documentation.
Web Server & UI
Invoke runs a locally hosted web server & React UI with an industry-leading user experience.
Unified Canvas
The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/out-painting, brush tools, and more. This creative tool unlocks the capability for artists to create with AI as a creative collaborator, and can be used to augment AI-generated imagery, sketches, photography, renders, and more.
Workflows & Nodes
Invoke offers a fully featured workflow management solution, enabling users to combine the power of node-based workflows with the ease of a UI. This allows for customizable generation pipelines to be developed and shared by users looking to create specific workflows to support their production use-cases.
Board & Gallery Management
Invoke features an organized gallery system for easily storing, accessing, and remixing your content in the Invoke workspace. Images can be dragged/dropped onto any Image-base UI element in the application, and rich metadata within the Image allows for easy recall of key prompts or settings used in your workflow.
Model Support
- SD 1.5
- SD 2.0
- SDXL
- SD 3.5 Medium
- SD 3.5 Large
- CogView 4
- Flux.1 Dev
- Flux.1 Schnell
- Flux.1 Kontext
- Flux.1 Krea
- Flux Redux
- Flux Fill
- Flux.2 Dev
- Flux.2 Klein 4B
- Flux.2 Klein 9B
- Z-Image Turbo
- Z-Image Base
- Krea 2 Turbo
- Krea 2 Raw
- Anima
- Qwen Image
- Qwen Image Edit
- Ideogram 4
- ERNIE-Image
- ERNIE-Image-Turbo
- Nano Banana (API Only)
- GPT Image (API Only)
- Wan (API Only)
Other features
- Support for ckpt, diffusers, and some gguf models
- Upscaling Tools
- Embedding Manager & Support
- Model Manager & Support
- Workflow creation & management
- Node-Based Architecture
- Object Segmentation & Selection Models (SAM / SAM2)
Contributing
Anyone who wishes to contribute to this project - whether documentation, features, bug fixes, code cleanup, testing, or code reviews - is very much encouraged to do so.
Get started with contributing by reading our contribution documentation, joining the #dev-chat or the GitHub discussion board.
We hope you enjoy using Invoke as much as we enjoy creating it, and we hope you will elect to become part of our community.
Sponsors
Invoke's open-source development is powered by our sponsors. If Invoke is valuable to you or your business, please consider sponsoring us — it directly funds maintenance, new features, and community support.
<!-- Sponsor logos can be added below, or automated with a GitHub Action such as `JamesIves/github-sponsors-readme-action` to keep them in sync. -->
We very much thank the following sponsors:
Blacksmith
Blacksmith provides InvokeAI with virtual machines for continuous integration and continuous deployment.
Backers ($15/mo)
- apokolypsse
- Romeotechguy
- Pynshe9
- CarstenD74
- zamjoor
- FusionBreak
- and 2 anonymous donors
Power Users ($50/mo)
- mickr777
- Astroburner
- and 2 anonymous donors
Thanks
Invoke is a combined effort of passionate and talented people from across the world. We thank them for their time, hard work and effort.
Copyright 2022-2026 InvokeAI Contributors. See NOTICE.
…
Did you get it running?
No reports for macOS yet.
Still stuck? Get a written guide
Claude reads the 12 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.