Comfy-Org/comfy-cli

comfy‑cli – ComfyUI 的命令行管理器

是什么

• 一个基于 Python 的 CLI，可自动化管理 ComfyUI（一个开源生成式媒体引擎，支持图像/视频扩散模型）的整个生命周期。它能安装 ComfyUI、拉取自定义节点、下载模型、启动服务器、运行工作流，甚至将任务提交到托管的 Comfy Cloud 服务。

核心功能

功能	作用
一键安装与启动	comfy install（或 comfy setup）下载 ComfyUI 及官方管理器，仅用一条命令即可快速运行。
云端执行	comfy run … --where cloud 将任意 API 格式工作流发送至 Comfy Cloud，返回 prompt_id，之后可轮询或下载结果。
直接生成	comfy generate 可调用合作伙伴图像/视频模型（Flux、DALL·E、Stability 等），无需编写 JSON 工作流。
自定义节点管理	通过 comfy node … 安装、更新、快照、二分查找或批量更新节点，支持标准 ComfyUI‑Manager 流程和注册表直连流程。
快速依赖解析	使用 --fast-deps 或 --uv-compile 启用 uv 解析器，为所有节点编译单一锁文件，极大加速安装过程。
模型获取	通过单条命令从 CivitAI、Hugging Face 或任意 URL 下载模型。
跨平台支持	支持 Windows、macOS 和 Linux；可在 Docker 或虚拟环境内运行。
AI 代理友好输出	--json 标志将所有响应包裹在结构化数据包中，便于 LLM 代理（Claude、Cursor 等）驱动工具。
Shell 补全	comfy --install-completion 为 Bash/Zsh/Fish 添加 Tab 补全功能。
后台服务器管理	comfy launch --background 启动分离的 ComfyUI 实例，可通过 comfy env 或 comfy stop 列出或停止。
PR 测试与缓存	comfy launch --frontend-pr … 或 comfy install --pr … 可从 GitHub Pull Request 启动 UI 或后端，并自动清理缓存。

典型工作流

1. 安装 – pip install comfy-cli && comfy setup（交互式向导）或 CI 用 comfy install -y。
2. 添加节点/模型 – comfy node install comfyui-impact-pack 或 comfy node registry-install …；comfy model download <url>。
3. 本地运行 – comfy launch（可选 --background）。
4. 运行工作流 – comfy run --workflow my.json（本地）或添加 --where cloud 以卸载至托管服务。
5. 监控/获取结果 – comfy jobs wait <id>，comfy download <id> -o ./out。
6. 更新 – comfy update all（核心 + 节点）或 comfy update comfy --version latest。

为何重要

• 降低使用门槛：手动设置 ComfyUI 需要克隆仓库、安装 Python 环境、处理 GPU 特定的 PyTorch 轮子、手动拉取自定义节点。comfy‑cli 将这些步骤全部打包。
• 轻松实现云优先流水线：无 GPU 用户也可通过单个标志将任务路由至 Comfy Cloud，运行重型扩散模型。
• 促进自动化：JSON 结构化输出与确定性退出码，使 CI 流水线或 LLM 驱动的代理能可靠地脚本化安装、更新和任务提交。
• 统一依赖管理：通过利用 uv 和管理器的统一解析器，可早期检测多个自定义节点间的版本冲突，节省时间。

安装

# 推荐：在虚拟环境或 conda 环境中
pip install comfy-cli   # Python ≥3.10
# 可选：启用 Tab 补全
comfy --install-completion

获取帮助

• comfy --help – 查看顶层命令列表。
• comfy <子命令> --help – 查看每个操作的详细选项。
• comfy which – 显示 CLI 将作用的项目空间。
• comfy env – 显示当前环境、后台服务器和云状态。

许可证与社区

• 采用 MIT 许可证分发。
• 由 Comfy‑Org 团队积极维护；CI 指示灯显示测试覆盖率和 PyPI 发布情况。

---

以上所有信息均直接来自项目 README，未添加任何外部假设。