ComfyUI 桌面版(Desktop) 是一个独立的安装版本,可以像常规软件一样进行安装,支持快捷安装自动配置 Python环境及依赖 ,支持导入已有的 ComfyUI 设置、模型、工作流和文件,可以快速从已有的ComfyUI 便携版迁移到桌面版 ComfyUI 桌面版是一个开源项目,完整代码请访问 这里 ComfyUI 桌面版(Windows)硬件要求:
  • NVIDIA 显卡
本篇教程将引导你完成对应的软件安装,并说明相关安装配置说明。
由于 ComfyUI 桌面版 仍旧处于 Beta 状态,实际的安装过程可能会发生变化

ComfyUI 桌面版(Windows)下载

请点击下面的按钮下载对应的针对 Windows 系统的 ComfyUI 桌面版 安装包

Download for Windows (NVIDIA)

ComfyUI 桌面版安装步骤

双击下载到的安装包文件,首先将会执行一次自动安装,并在桌面生成一个 ComfyUI 桌面版 的快捷方式 ComfyUI logo 双击对应的快捷,进入 ComfyUI 的初始化设置

ComfyUI 桌面版初始化流程

1

开始界面

ComfyUI 安装步骤 - 起始 点击 Get Started 开始初始化步骤
2

Select GPU(GPU选择)

ComfyUI 安装步骤 - GPU 选择 对应三个选项为:
  1. Nvidia 显卡(推荐): 直接支持使用 pytorch 和 CUDA
  2. Manual Configuration 手动配置: 你需要手动安装和配置 python 运行环境,除非你知道应该如何配置,否则请不要选择
  3. Enable CPU Mode 启用 CPU 模式: 仅适用于开发人员和特殊情况,除非你确定你需要使用这个模式,否则请不要选择
如无特殊情况,请按截图所示选择NVIDIA,并点击 Next 进入下一步
3

Install location(安装位置)

ComfyUI 安装步骤 - 安装位置设置在这一步将选择 ComfyUI 以下内容的安装位置:
  • Python 虚拟环境
  • Models 模型文件
  • Custom Nodes 自定义节点
建议:
  • 请选择固态硬盘作为安装位置,这将提高 ComfyUI 访问模型的速度。
  • 请新建一个单独的空白文件夹作为 ComfyUI 的安装目录
  • 请保证对应磁盘至少有 15G 左右的磁盘空间,以保证 ComfyUI Desktop 的安装
ComfyUI 并非所有文件都安装在此目录下,部分文件依然会安装在 C 盘,后期如需卸载,你可以参考本篇指南的卸载部分完成完整的 ComfyUI 桌面版的卸载
完成后点击 Next 进入下一步
4

Migrate from Existing Installation(从已有安装迁移 - 可选)

ComfyUI 安装步骤 - 文件迁移在这一步你可以将你已有的 ComfyUI 安装内容迁移到 ComfyUI 桌面版中,如图所示,选择了原本的 D:\ComfyUI_windows_portable\ComfyUI 安装目录,安装程序会自动识别对应目录下的:
  • User Files 用户文件
  • Models 模型文件: 不会进行复制,只是与桌面版进行关联
  • Custom Nodes 自定义节点: 自定义节点将会重新进行安装
不要担心,这个步骤并不会复制模型文件,你可以按你的需要勾选或者取消勾选对应的选项,点击 Next 进入下一步
5

Desktop Setting(桌面版设置)

ComfyUI 安装步骤 - 桌面版设置这一步是偏好设置
  1. Automatic Updates 自动更新: 是否设置在 ComfyUI 更新可用时自动更新
  2. Usage Metrics 使用情况分析: 如果启用,我们将收集匿名的使用数据 用于帮助我们改进 ComfyUI
  3. Mirror Settings 镜像设置: 由于程序需要联网下载 Python 完成相关环境安装,如果你在安装时候也如图所示出现了红色的❌,提示这可能会导致后续安装过程的失败,则请参考下面步骤进行处理
ComfyUI 安装步骤 - 镜像设置 展开对应的镜像设置,找到具体失败的镜像,在当前截图中错误为 Python Install Mirror 镜像失败。对于不同的镜像错误,你可以参考下面的内容尝试手动查找不同的镜像,并进行替换以下情况主要针对中国境内用户

Python 安装镜像

如果默认镜像无法使用,请尝试使用下面的镜像
https://python-standalone.org/mirror/astral-sh/python-build-standalone
如果你需要查找其它备选 GitHub 的镜像地址,请查找并构建指向 python-build-standalone 仓库releases的镜像地址
https://github.com/astral-sh/python-build-standalone/releases/download
构建类似下面格式的链接
https://xxx/astral-sh/python-build-standalone/releases/download

PyPI 镜像

Torch 镜像

6

完成安装

如果一切无误,安装程序将完成安装并自动进入 ComfyUI 桌面版界面, 则说明已经安装成功 ComfyUI 桌面版界面

进行第一次图片生成

安装成功后,你可以参考访问下面的章节,开始你的 ComfyUI 之路。

进行第一次图片生成

本教程将引导你完成第一次的模型安装以及对应的文本到图片的生成

如何更新 ComfyUI 桌面版

目前 ComfyUI 桌面版更新采用自动检测更新,请确保在设置中已经启用自动更新 ComfyUI 桌面版设置 你也可以在 菜单 —> 帮助 —> 检查更新 中选择手动检查是否有可用的更新 ComfyUI 桌面版检查更新

添加外部模型路径

如果你想要在 ComfyUI/models 之外管理你的模型文件,可能出于以下原因:
  • 你有多个 ComfyUI 实例,你想要让这些实例共享模型文件,从而减少磁盘占用
  • 你有多个不同的类型的 GUI 程序,如:WebUI, 你想要他们共用模型文件
  • 模型文件无法被识别或读取到
我们提供了通过 extra_model_paths.yaml 配置文件来添加额外模型搜索路径的方法。

不同 ComfyUI 版本配置文件位置

对于便携版手动安装的 ComfyUI版本,你可以在 ComfyUI 的根目录下找到 extra_model_paths.yaml.example 的示例文件
ComfyUI/extra_model_paths.yaml.example
复制并重命名为 extra_model_paths.yaml 来使用, 并保持在 ComfyUI 的根目录下, 路径应该是 ComfyUI/extra_model_paths.yaml你也可以在 这里 找到配置示例文件

配置示例

比如,你需要额外让 ComfyUI 识别的模型文件位于下面的文件夹:
📁 YOUR_PATH/
  ├── 📁models/
  |   ├── 📁 loras/
  |   │   └── xxxxx.safetensors
  |   ├── 📁 checkpoints/
  |   │   └── xxxxx.safetensors
  |   ├── 📁 vae/
  |   │   └── xxxxx.safetensors
  |   └── 📁 controlnet/
  |       └── xxxxx.safetensors
那么你可以进行如下的配置来让 ComfyUI 识别到你设备上的模型路径
my_custom_config:
    base_path: YOUR_PATH
    loras: models/loras/
    checkpoints: models/checkpoints/
    vae: models/vae/
    controlnet: models/controlnet/
或者使用
my_custom_config:
    base_path: YOUR_PATH/models/
    loras: loras
    checkpoints: checkpoints
    vae: vae
    controlnet: controlnet
对于桌面版,请在原有配置路径下新增配置,而不覆盖掉安装过程中自动生成的路径配置,请在修改前备份对应的文件,这样在你配置错误时可以及时恢复
或者你也可以参考默认的 extra_model_paths.yaml.example 来配置,保存之后, 需要 重启 ComfyUI 才能生效。 下面是完整的原始的配置配置示例:
#Rename this to extra_model_paths.yaml and ComfyUI will load it


#config for a1111 ui
#all you have to do is change the base_path to where yours is installed
a111:
    base_path: path/to/stable-diffusion-webui/

    checkpoints: models/Stable-diffusion
    configs: models/Stable-diffusion
    vae: models/VAE
    loras: |
         models/Lora
         models/LyCORIS
    upscale_models: |
                  models/ESRGAN
                  models/RealESRGAN
                  models/SwinIR
    embeddings: embeddings
    hypernetworks: models/hypernetworks
    controlnet: models/ControlNet

#config for comfyui
#your base path should be either an existing comfy install or a central folder where you store all of your models, loras, etc.

#comfyui:
#     base_path: path/to/comfyui/
#     # You can use is_default to mark that these folders should be listed first, and used as the default dirs for eg downloads
#     #is_default: true
#     checkpoints: models/checkpoints/
#     clip: models/clip/
#     clip_vision: models/clip_vision/
#     configs: models/configs/
#     controlnet: models/controlnet/
#     diffusion_models: |
#                  models/diffusion_models
#                  models/unet
#     embeddings: models/embeddings/
#     loras: models/loras/
#     upscale_models: models/upscale_models/
#     vae: models/vae/

#other_ui:
#    base_path: path/to/ui
#    checkpoints: models/checkpoints
#    gligen: models/gligen
#    custom_nodes: path/custom_nodes

添加额外自定义节点路径

除了添加外部模型之外,你同样可以添加不在 ComfyUI 默认路径下的自定义节点路径
请注意,这并不会改变自定义节点的默认安装路径,只是在启动 ComfyUI 时会增加额外的路径搜索,你仍旧需要在对应的环境中完成自定义节点的依赖的安装,来保证其运行环境的完整性。
下面是一个简单的配置示例(Mac 系统),请根据你的实际情况进行修改,并新增到对应的配置文件中,保存后需要 重启 ComfyUI 才能生效:
my_custom_nodes:
  custom_nodes: /Users/your_username/Documents/extra_custom_nodes

桌面端 Python 环境相关

桌面端的安装将在你选择的安装目录下创建一个python 的虚拟环境,通常这是一个隐藏的 .venv 文件夹。 如果你需要为 ComfyUI 插件处理相关的依赖则需要在这个环境中进行处理,直接系统系统的命令行会有将对应依赖安装到系统环境的风险,请参考下面的指示完成对应环境的激活。

如何使用 桌面端 的 python 环境?

你可以使用桌面端自带的终端来使用 python 环境。 ComfyUI 桌面版终端
  1. 点击菜单栏的 icon 打开底部面板
  2. 点击 Terminal 打开终端
  3. 如果你想要看对应环境的 python 安装位置,可以使用下面的命令
  python -c "import sys; print(sys.executable)"
除非你了解你当前的操作含义,否则你的操作可能会导致对应环境依赖的问题,请谨慎使用此方式进行操作

如何卸载 ComfyUI 桌面版

对于 ComfyUI 桌面版 你可以在 Windows 的系统设置中使用系统的卸载功能来完成对应软件的卸载操作 ComfyUI 桌面版卸载 如果你想要完全删除 ComfyUI 桌面版 的所有文件,你可以手动删除以下文件夹:
  • C:\Users<你的用户名>\AppData\Local@comfyorgcomfyui-electron-updater
  • C:\Users<你的用户名>\AppData\Local\Programs@comfyorgcomfyui-electron
  • C:\Users<你的用户名>\AppData\Roaming\ComfyUI
以上的操作并不会删除以下你的以下文件夹,如果你需要删除对应文件的话,请手动删除:
  • models 模型文件
  • custom nodes 自定义节点
  • input/output directories. 图片输入/输出目录

故障排除

显示不支持的设备

ComfyUI 安装步骤 - 不支持的设备 由于 ComfyUI 桌面版(Windows)仅支持可以使用 CUDA 的 Nvdia 显卡 所以如果你的设备不支持,可能会出现此界面

如何定位安装错误

如果安装失败,你应该可以看到下面的界面显示 ComfyUI 安装失败 此时建议你采取以下几种方式查找错误原因
  1. 点击 Show Teriminal 查看错误问题输出
  2. 点击 Open Logs 查看安装过程日志
  3. 访问官方论坛查找错误反馈
  4. 点击Reinstall尝试重新安装
建议在提交反馈之前,你可以将对应的错误输出以及 log 文件信息提供给类似 GPT一类的工具 ComfyUI 安装失败-错误日志 ComfyUI 安装失败-GPT 反馈 如上图,询问对应错误的原因,或者完全删除 ComfyUI 后进行安装重试

反馈错误

如果在安装过程中,你发生了任何错误,请通过以下任意方式查看是否有类似错误反馈,或者向我们提交错误 请在提交错误时确保提交了以下日志以及配置文件,方便我们进行问题的定位和查找
  1. 日志文件
文件名描述位置
main.log包含与桌面应用和服务器启动相关的日志,来自桌面的 Electron 进程。
comfyui.log包含与 ComfyUI 正常运行相关的日志,例如核心 ComfyUI 进程的终端输出。
ComfyUI 日志文件输出位置
  1. 配置文件
文件名描述位置
extra_model_paths.yaml包含 ComfyUI 将搜索模型和自定义节点的额外路径。
config.json包含应用配置。此文件通常不应直接编辑。
ComfyUI 配置文件位置