Comfyui
使用 ComfyUI 生成图像、视频和音频 — 安装、启动、管理节点/模型、通过参数注入运行工作流。使用官方的 comfy-cli 进行生命周期管理,并使用直接的 REST/WebSocket API 进行执行。
技能元数据
| 来源 | 捆绑(默认安装) |
| 路径 | skills/creative/comfyui |
| 版本 | 5.1.0 |
| 作者 | ['kshitijk4poor', 'alt-glitch', 'purzbeats'] |
| 许可证 | MIT |
| 平台 | macos, linux, windows |
| 标签 | comfyui, image-generation, stable-diffusion, flux, sd3, wan-video, hunyuan-video, creative, generative-ai, video-generation |
| 相关技能 | stable-diffusion-image-generation, image_gen |
参考:完整 SKILL.md
以下是 Hermes 在触发此技能时加载的完整技能定义。这是技能激活时代理看到的指令。
ComfyUI
通过 ComfyUI 生成图像、视频、音频和 3D 内容,使用官方 comfy-cli 进行设置/生命周期管理,并使用直接的 REST/WebSocket API 进行工作流执行。
此技能包含的内容
参考文档 (references/):
official-cli.md— 每个comfy ...命令及其标志rest-api.md— REST + WebSocket 端点(本地 + 云),负载模式workflow-format.md— API 格式 JSON,常见节点类型,参数映射template-integrity.md— 将comfyui-workflow-templates从编辑器格式转换为 API 格式:Reroute 旁路,带点号的动态输入键(values.a,resize_type.width),云特性(302 重定向,免费层 1 个并发作业,1080p VRAM 上限),兼容 Discord 的 ffmpeg 拼接。由 @purzbeats 编写。当你从官方模板开始时,请加载此文档。
脚本 (scripts/):
| 脚本 | 用途 |
|---|---|
_common.py | 共享 HTTP、云路由、节点目录(不要直接运行) |
hardware_check.py | 探测 GPU/VRAM/磁盘 → 推荐本地 vs Comfy Cloud |
comfyui_setup.sh | 硬件检查 + comfy-cli + ComfyUI 安装 + 启动 + 验证 |
extract_schema.py | 读取工作流 → 列出可控制参数 + 模型依赖项 |
check_deps.py | 针对运行中的服务器检查工作流 → 列出缺失的节点/模型 |
auto_fix_deps.py | 运行 check_deps 然后执行 comfy node install / comfy model download |
run_workflow.py | 注入参数,提交,监控,下载输出(HTTP 或 WS) |
run_batch.py | 通过扫描多次提交工作流,并行度取决于你的层级 |
ws_monitor.py | 用于执行作业的实时 WebSocket 查看器(实时进度) |
health_check.py | 验证清单运行器 — comfy-cli + 服务器 + 模型 + 冒烟测试 |
fetch_logs.py | 拉取给定 prompt_id 的回溯/状态消息 |
示例工作流 (workflows/): SD 1.5, SDXL, Flux Dev, SDXL img2img, SDXL inpaint, ESRGAN upscale, AnimateDiff video, Wan T2V。参见 workflows/README.md。
何时使用
- 用户要求使用 Stable Diffusion、SDXL、Flux、SD3 等生成图像
- 用户想要运行特定的 ComfyUI 工作流文件
- 用户想要链式生成步骤(txt2img → upscale → 面部修复)
- 用户需要 ControlNet、inpainting、img2img 或其他高级管道
- 用户要求管理 ComfyUI 队列、检查模型或安装自定义节点
- 用户希望通过 AnimateDiff、Hunyuan、Wan、AudioCraft 等生成视频/音频/3D 内容
架构:两层结构
┌─────────────────────────────────────────────────────┐
│ Layer 1: comfy-cli (official lifecycle tool) │
│ Setup, server lifecycle, custom nodes, models │
│ → comfy install / launch / stop / node / model │
└─────────────────────────┬───────────────────────────┘
│
┌─────────────────────────▼───────────────────────────┐
│ Layer 2: REST/WebSocket API + skill scripts │
│ Workflow execution, param injection, monitoring │
│ POST /api/prompt, GET /api/view, WS /ws │
│ → run_workflow.py, run_batch.py, ws_monitor.py │
└─────────────────────────────────────────────────────┘
为什么分为两层? 官方 CLI 非常适合安装和服务器管理,但对工作流执行的支持很少。REST/WS API 填补了这一空白 — 脚本处理 CLI 不做的参数注入、执行监控和输出下载。
快速开始
检测环境
# What's available?
command -v comfy >/dev/null 2>&1 && echo "comfy-cli: installed"
curl -s http://127.0.0.1:8188/system_stats 2>/dev/null && echo "server: running"
# Can this machine run ComfyUI locally? (GPU/VRAM/disk check)
python3 scripts/hardware_check.py
如果未安装任何内容,请参阅下面的 设置与入门 — 但始终先运行硬件检查。
一行健康检查
python3 scripts/health_check.py
# → JSON: comfy_cli on PATH? server reachable? at least one checkpoint? smoke-test passes?
核心工作流
步骤 1:获取 API 格式的工作流 JSON
工作流必须采用 API 格式(每个节点都有 class_type)。它们来自:
- ComfyUI Web UI → Workflow → Export (API)(新版 UI)或 传统的 "Save (API Format)" 按钮(旧版 UI)
- 此技能的
workflows/目录( ready-to-run 示例) - 社区下载(civitai, Reddit, Discord)— 通常是编辑器格式, 必须加载到 ComfyUI 中然后重新导出
编辑器格式(顶层 nodes 和 links 数组)不可直接执行。脚本会检测到此情况并提示你重新导出。
步骤 2:查看可控制的内容
python3 scripts/extract_schema.py workflow_api.json --summary-only
# → {"parameter_count": 12, "has_negative_prompt": true, "has_seed": true, ...}
python3 scripts/extract_schema.py workflow_api.json
# → full schema with parameters, model deps, embedding refs
步骤 3:带参数运行
# Local (defaults to http://127.0.0.1:8188)
python3 scripts/run_workflow.py \
--workflow workflow_api.json \
--args '{"prompt": "a beautiful sunset over mountains", "seed": -1, "steps": 30}' \
--output-dir ./outputs
# Cloud (export API key once; uses correct /api routing automatically)
export COMFY_CLOUD_API_KEY="comfyui-..."
python3 scripts/run_workflow.py \
--workflow workflow_api.json \
--args '{"prompt": "..."}' \
--host https://cloud.comfy.org \
--output-dir ./outputs
# Real-time progress via WebSocket (requires `pip install websocket-client`)
python3 scripts/run_workflow.py \
--workflow flux_dev.json \
--args '{"prompt": "..."}' \
--ws
# img2img / inpaint: pass --input-image to upload + reference automatically
python3 scripts/run_workflow.py \
--workflow sdxl_img2img.json \
--input-image image=./photo.png \
--args '{"prompt": "make it watercolor", "denoise": 0.6}'
# Batch / sweep: 8 random seeds, parallel up to cloud tier limit
python3 scripts/run_batch.py \
--workflow sdxl.json \
--args '{"prompt": "abstract"}' \
--count 8 --randomize-seed --parallel 3 \
--output-dir ./outputs/batch
seed 设为 -1(或使用 --randomize-seed 省略它)会在每次运行时生成一个新的随机种子。
步骤 4:展示结果
脚本向 stdout 发出 JSON,描述每个输出文件:
{
"status": "success",
"prompt_id": "abc-123",
"outputs": [
{"file": "./outputs/sdxl_00001_.png", "node_id": "9",
"type": "image", "filename": "sdxl_00001_.png"}
]
}
决策树
| 用户说 | 工具 | 命令 |
|---|---|---|
| 生命周期(使用 comfy-cli) | ||
| "install ComfyUI" | comfy-cli | bash scripts/comfyui_setup.sh |
| "start ComfyUI" | comfy-cli | comfy launch --background |
| "stop ComfyUI" | comfy-cli | comfy stop |
| "install X node" | comfy-cli | comfy node install <name> |
| "download X model" | comfy-cli | comfy model download --url <url> --relative-path models/checkpoints |
| "list installed models" | comfy-cli | comfy model list |
| "list installed nodes" | comfy-cli | comfy node show installed |
| 执行(使用脚本) | ||
| "is everything ready?" | script | health_check.py(可选附带 --workflow X --smoke-test) |
| "what can I change in this workflow?" | script | extract_schema.py W.json |
| "check if W's deps are met" | script | check_deps.py W.json |
| "fix missing deps" | script | auto_fix_deps.py W.json |
| "generate an image" | script | run_workflow.py --workflow W --args '{...}' |
| "use this image" (img2img) | script | run_workflow.py --input-image image=./x.png ... |
| "8 variations with random seeds" | script | run_batch.py --count 8 --randomize-seed ... |
| "show me live progress" | script | ws_monitor.py --prompt-id <id> |
| "fetch the error from job X" | script | fetch_logs.py <prompt_id> |
| 直接 REST | ||
| "what's in the queue?" | REST | curl http://HOST:8188/queue(本地)或 --host https://cloud.comfy.org |
| "cancel that" | REST | curl -X POST http://HOST:8188/interrupt |
| "free GPU memory" | REST | curl -X POST http://HOST:8188/free |
设置与入门
当用户要求设置 ComfyUI 时,首先要做的是询问他们想要 Comfy Cloud(托管、零安装、API 密钥)还是本地(在他们的机器上安装 ComfyUI)。在得到回答之前,不要开始运行安装命令或硬件检查。
官方文档: https://docs.comfy.org/installation CLI 文档: https://docs.comfy.org/comfy-cli/getting-started Cloud 文档: https://docs.comfy.org/get_started/cloud Cloud API: https://docs.comfy.org/development/cloud/overview
步骤 0:询问本地 vs Cloud(始终优先)
建议话术:
"您希望在本地机器上运行 ComfyUI,还是使用 Comfy Cloud?
- Comfy Cloud — 托管在 RTX 6000 Pro GPU 上,预装所有常用模型, 零设置。需要 API 密钥(需要付费订阅才能实际运行工作流;免费层仅限只读)。如果您没有性能足够的 GPU,这是最佳选择。
- 本地 — 免费,但您的机器必须满足硬件要求:
- 具有 ≥6 GB 显存的 NVIDIA GPU(SDXL 需 ≥8 GB,Flux/视频需 ≥12 GB),或
- 支持 ROCm 的 AMD GPU(Linux),或
- Apple Silicon Mac(M1+)具有 ≥16 GB 统一内存(推荐 ≥32 GB)。
- Intel Mac 和没有 GPU 的机器将无法工作 — 请改用 Cloud。
您希望选择哪种方式?"
路由:
- Cloud → 跳至 路径 A。
- 本地 → 首先运行硬件检查,然后根据结果从路径 B–E 中选择一个。
- 不确定 → 运行硬件检查并让结果决定。
步骤 1:验证硬件(仅当用户选择本地时)
python3 scripts/hardware_check.py --json
# Optional: also probe `torch` for actual CUDA/MPS:
python3 scripts/hardware_check.py --json --check-pytorch
| 结果 | 含义 | 操作 |
|---|---|---|
ok | ≥8 GB 显存(独立显卡)或 ≥32 GB 统一内存(Apple Silicon) | 本地安装 — 使用报告中的 comfy_cli_flag |
marginal | SD1.5 可行;SDXL 紧张;Flux/视频不太可能 | 轻量工作流可本地运行,否则选择 路径 A(Cloud) |
cloud | 无可用 GPU,<6 GB 显存,<16 GB Apple 统一内存,Intel Mac,Rosetta Python | 除非用户明确强制本地安装,否则切换到 Cloud |
该脚本还会显示 wsl: true(带有 NVIDIA 透传的 WSL2)和
rosetta: true(Apple Silicon 上的 x86_64 Python — 必须重新安装为 ARM64)。
如果结果是 cloud 但用户想要本地安装,请不要静默继续。
原样显示 notes 数组,并询问他们是否希望 (a) 切换到 Cloud 或 (b) 强制本地安装(在现代模型上会出现内存溢出或速度慢到无法使用)。
选择安装路径
首先使用硬件检查。下表是当用户已经告知你其硬件情况时的后备方案:
| 情况 | 推荐路径 |
|---|---|
硬件检查结果为 verdict: cloud | 路径 A:Comfy Cloud |
| 无 GPU / 希望在不承诺的情况下尝试 | 路径 A:Comfy Cloud |
| Windows + NVIDIA + 非技术用户 | 路径 B:ComfyUI Desktop |
| Windows + NVIDIA + 技术用户 | 路径 C:Portable 或 路径 D:comfy-cli |
| Linux + 任何 GPU | 路径 D:comfy-cli(最简单) |
| macOS + Apple Silicon | 路径 B:Desktop 或 路径 D:comfy-cli |
| 无头模式 / 服务器 / CI / 代理 | 路径 D:comfy-cli |
对于完全自动化的路径(硬件检查 → 安装 → 启动 → 验证):
bash scripts/comfyui_setup.sh
# Or with overrides:
bash scripts/comfyui_setup.sh --m-series --port=8190 --workspace=/data/comfy
它在内部运行 hardware_check.py,当判定结果为 cloud 时拒绝在本地安装(除非使用 --force-cloud-override),选择正确的 comfy-cli 标志,并优先使用 pipx/uvx 而非全局 pip,以避免污染系统 Python。
路径 A:Comfy Cloud(无本地安装)
适用于没有合适 GPU 或希望零设置的用户。托管于 RTX 6000 Pro 上。
文档: https://docs.comfy.org/get_started/cloud
- 在 https://comfy.org/cloud 注册
- 在 https://platform.comfy.org/login 生成 API 密钥
- 设置密钥:
export COMFY_CLOUD_API_KEY="comfyui-xxxxxxxxxxxx" - 运行工作流:
python3 scripts/run_workflow.py \
--workflow workflows/flux_dev_txt2img.json \
--args '{"prompt": "..."}' \
--host https://cloud.comfy.org \
--output-dir ./outputs
定价: https://www.comfy.org/cloud/pricing
并发任务数: 免费/标准版 1 个,创作者版 3 个,专业版 5 个。免费套餐无法通过 API 运行工作流 — 仅可浏览模型。使用 /api/prompt、/api/upload/*、/api/view 等接口需要付费订阅。
路径 B:ComfyUI Desktop(Windows / macOS)
面向非技术用户的一键安装程序。目前处于 Beta 阶段。
文档: https://docs.comfy.org/installation/desktop
- Windows (NVIDIA): https://download.comfy.org/windows/nsis/x64
- macOS (Apple Silicon): https://comfy.org
Desktop 版本不支持 Linux — 请使用路径 D。
路径 C:ComfyUI Portable(仅限 Windows)
文档: https://docs.comfy.org/installation/comfyui_portable_windows
从 https://github.com/comfyanonymous/ComfyUI/releases 下载,解压,运行 run_nvidia_gpu.bat。通过 update/update_comfyui_stable.bat 进行更新。
路径 D:comfy-cli(全平台 — 推荐用于 Agent)
官方 CLI 是无头/自动化设置的最佳路径。
文档: https://docs.comfy.org/comfy-cli/getting-started
安装 comfy-cli
# Recommended:
pipx install comfy-cli
# Or use uvx without installing:
uvx --from comfy-cli comfy --help
# Or (if pipx/uvx unavailable):
pip install --user comfy-cli
以非交互方式禁用分析:
comfy --skip-prompt tracking disable
安装 ComfyUI
comfy --skip-prompt install --nvidia # NVIDIA (CUDA)
comfy --skip-prompt install --amd # AMD (ROCm, Linux)
comfy --skip-prompt install --m-series # Apple Silicon (MPS)
comfy --skip-prompt install --cpu # CPU only (slow)
comfy --skip-prompt install --nvidia --fast-deps # uv-based dep resolution
默认位置:~/comfy/ComfyUI(Linux),~/Documents/comfy/ComfyUI(macOS/Win)。使用 comfy --workspace /custom/path install 覆盖默认位置。
启动 / 验证
comfy launch --background # background daemon on :8188
comfy launch -- --listen 0.0.0.0 --port 8190 # LAN-accessible custom port
curl -s http://127.0.0.1:8188/system_stats # health check
路径 E:手动安装(高级 / 不支持的硬件)
适用于 Ascend NPU、Cambricon MLU、Intel Arc 或其他不受支持的硬件。
文档: https://docs.comfy.org/installation/manual_install
git clone https://github.com/comfyanonymous/ComfyUI.git
cd ComfyUI
pip install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu130
pip install -r requirements.txt
python main.py
安装后:下载模型
# SDXL (general purpose, ~6.5 GB)
comfy model download \
--url "https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors" \
--relative-path models/checkpoints
# SD 1.5 (lighter, ~4 GB, good for 6 GB cards)
comfy model download \
--url "https://huggingface.co/stable-diffusion-v1-5/stable-diffusion-v1-5/resolve/main/v1-5-pruned-emaonly.safetensors" \
--relative-path models/checkpoints
# Flux Dev fp8 (smaller variant, ~12 GB)
comfy model download \
--url "https://huggingface.co/Comfy-Org/flux1-dev/resolve/main/flux1-dev-fp8.safetensors" \
--relative-path models/checkpoints
# CivitAI (set token first):
comfy model download \
--url "https://civitai.com/api/download/models/128713" \
--relative-path models/checkpoints \
--set-civitai-api-token "YOUR_TOKEN"
列出已安装的模型:comfy model list。
安装后:安装自定义节点
comfy node install comfyui-impact-pack # popular utility pack
comfy node install comfyui-animatediff-evolved # video generation
comfy node install comfyui-controlnet-aux # ControlNet preprocessors
comfy node install comfyui-essentials # common helpers
comfy node update all
comfy node install-deps --workflow=workflow.json # install everything a workflow needs
安装后:验证
python3 scripts/health_check.py
# → comfy_cli on PATH? server reachable? checkpoints? smoke test?
python3 scripts/check_deps.py my_workflow.json
# → are this workflow's nodes/models/embeddings installed?
python3 scripts/run_workflow.py \
--workflow workflows/sd15_txt2img.json \
--args '{"prompt": "test", "steps": 4}' \
--output-dir ./test-outputs
图片上传(img2img / 图像修复)
最简单的方法是在 run_workflow.py 中使用 --input-image:
python3 scripts/run_workflow.py \
--workflow workflows/sdxl_img2img.json \
--input-image image=./photo.png \
--args '{"prompt": "make it cyberpunk", "denoise": 0.6}'
该标志会上传 photo.png,然后将其服务器端文件名注入到名为 image 的模式参数中。对于图像修复(inpainting),需同时传递两者:
python3 scripts/run_workflow.py \
--workflow workflows/sdxl_inpaint.json \
--input-image image=./photo.png \
--input-image mask_image=./mask.png \
--args '{"prompt": "fill with flowers"}'
通过 REST 手动上传:
curl -X POST "http://127.0.0.1:8188/upload/image" \
-F "image=@photo.png" -F "type=input" -F "overwrite=true"
# Returns: {"name": "photo.png", "subfolder": "", "type": "input"}
# Cloud equivalent:
curl -X POST "https://cloud.comfy.org/api/upload/image" \
-H "X-API-Key: $COMFY_CLOUD_API_KEY" \
-F "image=@photo.png" -F "type=input" -F "overwrite=true"
Cloud 特定说明
- 基础 URL:
https://cloud.comfy.org - 认证:
X-API-Key请求头(或 WebSocket 使用?token=KEY) - API 密钥: 设置一次
$COMFY_CLOUD_API_KEY,脚本会自动获取 - 输出下载:
/api/view返回指向签名 URL 的 302 重定向;脚本会跟随重定向,并在从存储后端获取前剥离X-API-Key(防止将 API 密钥泄露给 S3/CloudFront)。 - 与本地 ComfyUI 的端点差异:
/api/object_info、/api/queue、/api/userdata— 免费套餐返回 403;仅限付费用户。- Cloud 上的
/history重命名为/history_v2(脚本会自动路由)。 - Cloud 上的
/models/<folder>重命名为/experiment/models/<folder>(脚本会自动路由)。 - WebSocket 中的
clientId目前被忽略 — 用户的所有连接接收相同的广播。请在客户端按prompt_id过滤。 - 上传时接受
subfolder但会被忽略 — Cloud 使用扁平命名空间。
- 并发任务数: 免费/标准版:1 个,创作者版:3 个,专业版:5 个。多余任务自动排队。使用
run_batch.py --parallel N以饱和您的套餐额度。
队列与系统管理
# Local
curl -s http://127.0.0.1:8188/queue | python3 -m json.tool
curl -X POST http://127.0.0.1:8188/queue -d '{"clear": true}' # cancel pending
curl -X POST http://127.0.0.1:8188/interrupt # cancel running
curl -X POST http://127.0.0.1:8188/free \
-H "Content-Type: application/json" \
-d '{"unload_models": true, "free_memory": true}'
# Cloud — same paths under /api/, plus:
python3 scripts/fetch_logs.py --tail-queue --host https://cloud.comfy.org
常见陷阱
-
需要 API 格式 — 每个脚本和
/api/prompt端点都期望 API 格式的工作流 JSON。脚本会检测编辑器格式(顶层的nodes和links数组),并提示您通过“Workflow → Export (API)”(新版 UI)或“Save (API Format)”(旧版 UI)重新导出。 -
服务器必须正在运行 — 所有执行都需要活跃的服务器。
comfy launch --background可启动一个服务器。通过curl http://127.0.0.1:8188/system_stats进行验证。 -
模型名称必须精确 — 区分大小写,包含文件扩展名。
check_deps.py进行模糊匹配(带/不带扩展名和文件夹前缀),但工作流本身必须使用规范名称。使用comfy model list查看已安装的内容。 -
缺少自定义节点 — “class_type not found” 意味着未安装所需的节点。
check_deps.py报告会指出需要安装哪个包;auto_fix_deps.py会为您运行安装。 -
工作目录 —
comfy-cli会自动检测 ComfyUI 工作区。 如果命令因“未找到工作区”而失败,请使用comfy --workspace /path/to/ComfyUI <command>或comfy set-default /path/to/ComfyUI。 -
云免费层 API 限制 —
/api/prompt、/api/view、/api/upload/*、/api/object_info在免费账户上均返回 403。health_check.py和check_deps.py会优雅地处理此情况并显示清晰的消息。 -
视频/音频工作流的超时 — 当输出节点为
VHS_VideoCombine、SaveVideo等时会自动检测;默认超时从 300 秒增加到 900 秒。可以使用--timeout 1800显式覆盖。 -
输出文件名中的路径遍历 — 服务器提供的文件名会通过
safe_path_join处理,以拒绝任何逃逸出--output-dir的路径。 请保持此保护开启 — 带有自定义保存节点的工作流可能会生成任意路径。 -
工作流 JSON 是任意代码 — 自定义节点运行 Python,因此提交未知工作流的信任级别与执行
eval相同。 在运行来自不可信来源的工作流之前,请先进行检查。 -
自动随机化种子 — 在
--args中传递seed: -1(或使用--randomize-seed并省略种子),以便每次运行获得一个新的种子。 实际种子会记录到 stderr。 -
tracking提示 — 首次运行comfy时可能会提示是否启用分析功能。 使用comfy --skip-prompt tracking disable以非交互方式跳过。comfyui_setup.sh会为你执行此操作。
验证清单
使用 python3 scripts/health_check.py 一次性运行整个列表。手动检查:
-
hardware_check.py的结果为ok,或者用户明确选择了 Comfy Cloud -
comfy --version正常工作(或uvx --from comfy-cli comfy --help) -
curl http://HOST:PORT/system_stats返回 JSON -
comfy model list显示至少一个检查点(本地)或/api/experiment/models/checkpoints返回模型(云端) - 工作流 JSON 采用 API 格式
-
check_deps.py报告is_ready: true(或在云免费层上仅报告node_check_skipped) - 使用小型工作流进行测试运行并完成;输出文件位于
--output-dir中