# ComfyUI **The most powerful and modular visual AI engine and application.** [![Website][website-shield]][website-url] [![Dynamic JSON Badge][discord-shield]][discord-url] [![Twitter][twitter-shield]][twitter-url] [![Matrix][matrix-shield]][matrix-url]
[![][github-release-shield]][github-release-link] [![][github-release-date-shield]][github-release-link] [![][github-downloads-shield]][github-downloads-link] [![][github-downloads-latest-shield]][github-downloads-link] [matrix-shield]: https://img.shields.io/badge/Matrix-000000?style=flat&logo=matrix&logoColor=white [matrix-url]: https://app.element.io/#/room/%23comfyui_space%3Amatrix.org [website-shield]: https://img.shields.io/badge/ComfyOrg-4285F4?style=flat [website-url]: https://www.comfy.org/ [discord-shield]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fcomfyorg%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Discord&color=green&suffix=%20total [discord-url]: https://www.comfy.org/discord [twitter-shield]: https://img.shields.io/twitter/follow/ComfyUI [twitter-url]: https://x.com/ComfyUI [github-release-shield]: https://img.shields.io/github/v/release/comfyanonymous/ComfyUI?style=flat&sort=semver [github-release-link]: https://github.com/comfyanonymous/ComfyUI/releases [github-release-date-shield]: https://img.shields.io/github/release-date/comfyanonymous/ComfyUI?style=flat [github-downloads-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/total?style=flat [github-downloads-latest-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/latest/total?style=flat&label=downloads%40latest [github-downloads-link]: https://github.com/comfyanonymous/ComfyUI/releases ![ComfyUI Screenshot](https://github.com/user-attachments/assets/7ccaf2c1-9b72-41ae-9a89-5688c94b7abe)
ComfyUI lets you design and execute advanced stable diffusion pipelines using a graph/nodes/flowchart based interface. Available on Windows, Linux, and macOS. ## Get Started #### [Desktop Application](https://www.comfy.org/download) - The easiest way to get started. - Available on Windows & macOS. #### [Windows Portable Package](#installing) - Get the latest commits and completely portable. - Available on Windows. #### [Manual Install](#manual-install-windows-linux) Supports all operating systems and GPU types (NVIDIA, AMD, Intel, Apple Silicon, Ascend). ## [Examples](https://comfyanonymous.github.io/ComfyUI_examples/) See what ComfyUI can do with the [example workflows](https://comfyanonymous.github.io/ComfyUI_examples/). ## Features - Nodes/graph/flowchart interface to experiment and create complex Stable Diffusion workflows without needing to code anything. - Image Models - SD1.x, SD2.x ([unCLIP](https://comfyanonymous.github.io/ComfyUI_examples/unclip/)) - [SDXL](https://comfyanonymous.github.io/ComfyUI_examples/sdxl/), [SDXL Turbo](https://comfyanonymous.github.io/ComfyUI_examples/sdturbo/) - [Stable Cascade](https://comfyanonymous.github.io/ComfyUI_examples/stable_cascade/) - [SD3 and SD3.5](https://comfyanonymous.github.io/ComfyUI_examples/sd3/) - Pixart Alpha and Sigma - [AuraFlow](https://comfyanonymous.github.io/ComfyUI_examples/aura_flow/) - [HunyuanDiT](https://comfyanonymous.github.io/ComfyUI_examples/hunyuan_dit/) - [Flux](https://comfyanonymous.github.io/ComfyUI_examples/flux/) - [Lumina Image 2.0](https://comfyanonymous.github.io/ComfyUI_examples/lumina2/) - [HiDream](https://comfyanonymous.github.io/ComfyUI_examples/hidream/) - [Cosmos Predict2](https://comfyanonymous.github.io/ComfyUI_examples/cosmos_predict2/) - [Qwen Image](https://comfyanonymous.github.io/ComfyUI_examples/qwen_image/) - Image Editing Models - [Omnigen 2](https://comfyanonymous.github.io/ComfyUI_examples/omnigen/) - [Flux Kontext](https://comfyanonymous.github.io/ComfyUI_examples/flux/#flux-kontext-image-editing-model) - [HiDream E1.1](https://comfyanonymous.github.io/ComfyUI_examples/hidream/#hidream-e11) - Video Models - [Stable Video Diffusion](https://comfyanonymous.github.io/ComfyUI_examples/video/) - [Mochi](https://comfyanonymous.github.io/ComfyUI_examples/mochi/) - [LTX-Video](https://comfyanonymous.github.io/ComfyUI_examples/ltxv/) - [Hunyuan Video](https://comfyanonymous.github.io/ComfyUI_examples/hunyuan_video/) - [Nvidia Cosmos](https://comfyanonymous.github.io/ComfyUI_examples/cosmos/) and [Cosmos Predict2](https://comfyanonymous.github.io/ComfyUI_examples/cosmos_predict2/) - [Wan 2.1](https://comfyanonymous.github.io/ComfyUI_examples/wan/) - [Wan 2.2](https://comfyanonymous.github.io/ComfyUI_examples/wan22/) - Audio Models - [Stable Audio](https://comfyanonymous.github.io/ComfyUI_examples/audio/) - [ACE Step](https://comfyanonymous.github.io/ComfyUI_examples/audio/) - 3D Models - [Hunyuan3D 2.0](https://docs.comfy.org/tutorials/3d/hunyuan3D-2) - Asynchronous Queue system - Many optimizations: Only re-executes the parts of the workflow that changes between executions. - Smart memory management: can automatically run large models on GPUs with as low as 1GB vram with smart offloading. - Works even if you don't have a GPU with: ```--cpu``` (slow) - Can load ckpt and safetensors: All in one checkpoints or standalone diffusion models, VAEs and CLIP models. - Safe loading of ckpt, pt, pth, etc.. files. - Embeddings/Textual inversion - [Loras (regular, locon and loha)](https://comfyanonymous.github.io/ComfyUI_examples/lora/) - [Hypernetworks](https://comfyanonymous.github.io/ComfyUI_examples/hypernetworks/) - Loading full workflows (with seeds) from generated PNG, WebP and FLAC files. - Saving/Loading workflows as Json files. - Nodes interface can be used to create complex workflows like one for [Hires fix](https://comfyanonymous.github.io/ComfyUI_examples/2_pass_txt2img/) or much more advanced ones. - [Area Composition](https://comfyanonymous.github.io/ComfyUI_examples/area_composition/) - [Inpainting](https://comfyanonymous.github.io/ComfyUI_examples/inpaint/) with both regular and inpainting models. - [ControlNet and T2I-Adapter](https://comfyanonymous.github.io/ComfyUI_examples/controlnet/) - [Upscale Models (ESRGAN, ESRGAN variants, SwinIR, Swin2SR, etc...)](https://comfyanonymous.github.io/ComfyUI_examples/upscale_models/) - [GLIGEN](https://comfyanonymous.github.io/ComfyUI_examples/gligen/) - [Model Merging](https://comfyanonymous.github.io/ComfyUI_examples/model_merging/) - [LCM models and Loras](https://comfyanonymous.github.io/ComfyUI_examples/lcm/) - Latent previews with [TAESD](#how-to-show-high-quality-previews) - Works fully offline: core will never download anything unless you want to. - Optional API nodes to use paid models from external providers through the online [Comfy API](https://docs.comfy.org/tutorials/api-nodes/overview). - [Config file](extra_model_paths.yaml.example) to set the search paths for models. Workflow examples can be found on the [Examples page](https://comfyanonymous.github.io/ComfyUI_examples/) ## Release Process ComfyUI follows a weekly release cycle targeting Friday but this regularly changes because of model releases or large changes to the codebase. There are three interconnected repositories: 1. **[ComfyUI Core](https://github.com/comfyanonymous/ComfyUI)** - Releases a new stable version (e.g., v0.7.0) - Serves as the foundation for the desktop release 2. **[ComfyUI Desktop](https://github.com/Comfy-Org/desktop)** - Builds a new release using the latest stable core version 3. **[ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend)** - Weekly frontend updates are merged into the core repository - Features are frozen for the upcoming core release - Development continues for the next release cycle ## Shortcuts | Keybind | Explanation | |------------------------------------|--------------------------------------------------------------------------------------------------------------------| | `Ctrl` + `Enter` | Queue up current graph for generation | | `Ctrl` + `Shift` + `Enter` | Queue up current graph as first for generation | | `Ctrl` + `Alt` + `Enter` | Cancel current generation | | `Ctrl` + `Z`/`Ctrl` + `Y` | Undo/Redo | | `Ctrl` + `S` | Save workflow | | `Ctrl` + `O` | Load workflow | | `Ctrl` + `A` | Select all nodes | | `Alt `+ `C` | Collapse/uncollapse selected nodes | | `Ctrl` + `M` | Mute/unmute selected nodes | | `Ctrl` + `B` | Bypass selected nodes (acts like the node was removed from the graph and the wires reconnected through) | | `Delete`/`Backspace` | Delete selected nodes | | `Ctrl` + `Backspace` | Delete the current graph | | `Space` | Move the canvas around when held and moving the cursor | | `Ctrl`/`Shift` + `Click` | Add clicked node to selection | | `Ctrl` + `C`/`Ctrl` + `V` | Copy and paste selected nodes (without maintaining connections to outputs of unselected nodes) | | `Ctrl` + `C`/`Ctrl` + `Shift` + `V` | Copy and paste selected nodes (maintaining connections from outputs of unselected nodes to inputs of pasted nodes) | | `Shift` + `Drag` | Move multiple selected nodes at the same time | | `Ctrl` + `D` | Load default graph | | `Alt` + `+` | Canvas Zoom in | | `Alt` + `-` | Canvas Zoom out | | `Ctrl` + `Shift` + LMB + Vertical drag | Canvas Zoom in/out | | `P` | Pin/Unpin selected nodes | | `Ctrl` + `G` | Group selected nodes | | `Q` | Toggle visibility of the queue | | `H` | Toggle visibility of history | | `R` | Refresh graph | | `F` | Show/Hide menu | | `.` | Fit view to selection (Whole graph when nothing is selected) | | Double-Click LMB | Open node quick search palette | | `Shift` + Drag | Move multiple wires at once | | `Ctrl` + `Alt` + LMB | Disconnect all wires from clicked slot | `Ctrl` can also be replaced with `Cmd` instead for macOS users # ComfyUI Installation Guide (Full Instructions) ComfyUI is the most powerful and modular visual AI engine and application. It lets you design and execute advanced Stable Diffusion pipelines using a graph/nodes/flowchart-based interface. --- ## Which Installation Method Should I Use? | Platform / Hardware | Easiest Method | Recommended For | Section | |--------------------------------|---------------------------------------------|---------------------------------------------------|---------| | **Windows – NVIDIA GPU** | [Portable Build](#1-windows-portable-build--easiest-method) | Beginners, no Python setup, plug-and-play | 1 | | **Windows – Any GPU / CPU** | [Manual Install](#2-windows-or-linux-manual-install) | Custom nodes, latest updates, flexibility | 2 | | **Linux – NVIDIA GPU** | [Manual Install](#2-windows-or-linux-manual-install) | Performance + customization | 2 | | **Linux – AMD ROCm GPU** | [Manual Install](#2-windows-or-linux-manual-install) | Best AMD performance | 2 / 5 | | **Linux – Intel Arc GPU** | [Manual Install](#2-windows-or-linux-manual-install) | Nightly PyTorch XPU builds | 2 | | **macOS (Apple Silicon)** | [macOS Install](#3-macos-apple-silicon-m1m2) | M1 / M2 / M3 chips | 3 | | **Windows – AMD GPU** | [DirectML](#4-other-hardware-setups) | Not recommended — only if no better option | 4 | | **Special Hardware (NPUs, MLUs)** | [Other Hardware Setups](#4-other-hardware-setups) | Ascend, Cambricon, Iluvatar devices | 4 | | **Any OS – pip install** | [comfy-cli](#6-optional-comfy-cli-install-any-os) | Fast install via CLI | 6 | --- ## 1. Windows Portable Build – Easiest Method **Best for**: NVIDIA GPU users or CPU-only usage. No Python install required — works out of the box. ### Steps 1. **Download** - [Direct Link – Portable NVIDIA Build](https://github.com/comfyanonymous/ComfyUI/releases/latest/download/ComfyUI_windows_portable_nvidia.7z) - Or see [all releases](https://github.com/comfyanonymous/ComfyUI/releases). 2. **Extract** - Use [7-Zip](https://7-zip.org) to extract the `.7z` file. - If extraction fails: - Right-click file → **Properties** → check **Unblock** → Apply. 3. **Add Models** - Place `.ckpt` or `.safetensors` into: ``` ComfyUI/models/checkpoints ``` - Place VAE files into: ``` ComfyUI/models/vae ``` 4. **Run ComfyUI** - Double-click `run_nvidia_gpu.bat` (or CPU script if no GPU). 5. **(Optional) Share Models** - Rename `extra_model_paths.yaml.example` → `extra_model_paths.yaml`. - Edit with your model paths. --- ## 2. Windows or Linux – Manual Install **Best for**: Latest features, custom nodes, all GPU types, CPU fallback. ### Requirements - Python 3.12 (3.13 supported but may break custom nodes) - Git installed ### Steps 1. **Clone Repo** ```bash git clone https://github.com/comfyanonymous/ComfyUI.git cd ComfyUI ``` 2. **Add Models** ``` models/checkpoints → .ckpt / .safetensors models/vae → VAE files ``` 3. **Install PyTorch (GPU-specific)** **NVIDIA:** ```bash pip install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu129 ``` *(Nightly)*: ```bash pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu129 ``` **AMD (Linux ROCm):** ```bash pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm6.4 ``` *(Nightly)*: ```bash pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.4 ``` **Intel Arc (XPU – Nightly):** ```bash pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/xpu ``` **Intel (IPEX – Conda):** ```bash conda install libuv pip install torch==2.3.1.post0+cxx11.abi torchvision==0.18.1.post0+cxx11.abi torchaudio==2.3.1.post0+cxx11.abi intel-extension-for-pytorch==2.3.110.post0+xpu --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/us/ --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/cn/ ``` 4. **Install Dependencies** ```bash pip install -r requirements.txt ``` 5. **Run** ```bash python main.py ``` --- ## 3. macOS – Apple Silicon (M1/M2/M3) ### Steps 1. Install PyTorch nightly with Metal ([Apple’s Guide](https://developer.apple.com/metal/pytorch/)). 2. Clone ComfyUI: ```bash git clone https://github.com/comfyanonymous/ComfyUI.git cd ComfyUI ``` 3. Add models (same as Manual Install). 4. Install dependencies: ```bash pip install -r requirements.txt ``` 5. Run: ```bash python main.py ``` --- ## 4. Other Hardware Setups ### AMD (Windows – DirectML) ```bash pip install torch-directml python main.py --directml ``` ### Ascend NPUs - Install Linux kernel as per [torch-npu guide](https://ascend.github.io/docs/sources/ascend/quick_install.html) - Install Ascend Basekit - Install PyTorch NPU packages ([instructions](https://ascend.github.io/docs/sources/pytorch/install.html#pytorch)) - Install ComfyUI (Manual Install method) ### Cambricon MLUs - Install [CNToolkit](https://www.cambricon.com/docs/sdk_1.15.0/cntoolkit_3.7.2/cntoolkit_install_3.7.2/index.html) - Install [torch_mlu](https://www.cambricon.com/docs/sdk_1.15.0/cambricon_pytorch_1.17.0/user_guide_1.9/index.html) - Run `python main.py` ### Iluvatar Corex - Install [Iluvatar Toolkit](https://support.iluvatar.com/#/DocumentCentre?id=1&nameCenter=2&productId=520117912052801536) - Run `python main.py` --- ## 5. AMD ROCm Tips - Unsupported cards: ```bash HSA_OVERRIDE_GFX_VERSION=10.3.0 python main.py # RDNA2 HSA_OVERRIDE_GFX_VERSION=11.0.0 python main.py # RDNA3 ``` - Speed tweaks: ```bash TORCH_ROCM_AOTRITON_ENABLE_EXPERIMENTAL=1 python main.py --use-pytorch-cross-attention PYTORCH_TUNABLEOP_ENABLED=1 python main.py ``` --- ## 6. comfy-cli Install (Any OS) ```bash pip install comfy-cli comfy install ``` --- ## After Installation - Run: ```bash python main.py ``` - Open browser at the shown local address. - Place additional LoRAs, embeddings, etc. in `models/` subfolders. --- # Notes Only parts of the graph that have an output with all the correct inputs will be executed. Only parts of the graph that change from each execution to the next will be executed, if you submit the same graph twice only the first will be executed. If you change the last part of the graph only the part you changed and the part that depends on it will be executed. Dragging a generated png on the webpage or loading one will give you the full workflow including seeds that were used to create it. You can use () to change emphasis of a word or phrase like: (good code:1.2) or (bad code:0.8). The default emphasis for () is 1.1. To use () characters in your actual prompt escape them like \\( or \\). You can use {day|night}, for wildcard/dynamic prompts. With this syntax "{wild|card|test}" will be randomly replaced by either "wild", "card" or "test" by the frontend every time you queue the prompt. To use {} characters in your actual prompt escape them like: \\{ or \\}. Dynamic prompts also support C-style comments, like `// comment` or `/* comment */`. To use a textual inversion concepts/embeddings in a text prompt put them in the models/embeddings directory and use them in the CLIPTextEncode node like this (you can omit the .pt extension): ```embedding:embedding_filename.pt``` ## How to show high-quality previews? Use ```--preview-method auto``` to enable previews. The default installation includes a fast latent preview method that's low-resolution. To enable higher-quality previews with [TAESD](https://github.com/madebyollin/taesd), download the [taesd_decoder.pth, taesdxl_decoder.pth, taesd3_decoder.pth and taef1_decoder.pth](https://github.com/madebyollin/taesd/) and place them in the `models/vae_approx` folder. Once they're installed, restart ComfyUI and launch it with `--preview-method taesd` to enable high-quality previews. ## How to use TLS/SSL? Generate a self-signed certificate (not appropriate for shared/production use) and key by running the command: `openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"` Use `--tls-keyfile key.pem --tls-certfile cert.pem` to enable TLS/SSL, the app will now be accessible with `https://...` instead of `http://...`. > Note: Windows users can use [alexisrolland/docker-openssl](https://github.com/alexisrolland/docker-openssl) or one of the [3rd party binary distributions](https://wiki.openssl.org/index.php/Binaries) to run the command example above.

If you use a container, note that the volume mount `-v` can be a relative path so `... -v ".\:/openssl-certs" ...` would create the key & cert files in the current directory of your command prompt or powershell terminal. ## Support and dev channel [Discord](https://comfy.org/discord): Try the #help or #feedback channels. [Matrix space: #comfyui_space:matrix.org](https://app.element.io/#/room/%23comfyui_space%3Amatrix.org) (it's like discord but open source). See also: [https://www.comfy.org/](https://www.comfy.org/) ## Frontend Development As of August 15, 2024, we have transitioned to a new frontend, which is now hosted in a separate repository: [ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend). This repository now hosts the compiled JS (from TS/Vue) under the `web/` directory. ### Reporting Issues and Requesting Features For any bugs, issues, or feature requests related to the frontend, please use the [ComfyUI Frontend repository](https://github.com/Comfy-Org/ComfyUI_frontend). This will help us manage and address frontend-specific concerns more efficiently. ### Using the Latest Frontend The new frontend is now the default for ComfyUI. However, please note: 1. The frontend in the main ComfyUI repository is updated fortnightly. 2. Daily releases are available in the separate frontend repository. To use the most up-to-date frontend version: 1. For the latest daily release, launch ComfyUI with this command line argument: ``` --front-end-version Comfy-Org/ComfyUI_frontend@latest ``` 2. For a specific version, replace `latest` with the desired version number: ``` --front-end-version Comfy-Org/ComfyUI_frontend@1.2.2 ``` This approach allows you to easily switch between the stable fortnightly release and the cutting-edge daily updates, or even specific versions for testing purposes. ### Accessing the Legacy Frontend If you need to use the legacy frontend for any reason, you can access it using the following command line argument: ``` --front-end-version Comfy-Org/ComfyUI_legacy_frontend@latest ``` This will use a snapshot of the legacy frontend preserved in the [ComfyUI Legacy Frontend repository](https://github.com/Comfy-Org/ComfyUI_legacy_frontend). # QA ### Which GPU should I buy for this? [See this page for some recommendations](https://github.com/comfyanonymous/ComfyUI/wiki/Which-GPU-should-I-buy-for-ComfyUI)