Comfy CLI 完整用户指南

Comfy CLI 所有功能的全面指南,涵盖工作区管理、节点管理、模型管理以及其他高级功能。

Comfy CLI 是 ComfyUI 官方命令行工具,可用于在终端中安装、管理节点和模型、运行工作流,以及调用合作伙伴的图像/视频模型。

ℹ️ 关于更新说明: 如需获取最新的 CLI 参考,请查阅官方 READMEdocs.comfy.org

依赖项

  • Python 3.10+

安装

推荐:使用 pip

pip install comfy-cli

使用 pipx(隔离环境)

pipx install comfy-cli

使用 uv(快速 Python 包安装工具)

uv tool install comfy-cli

Shell 自动补全

comfy --install-completion

现在 comfy <TAB> 可展开命令和选项。

快速开始

# 运行交互式设置向导
comfy setup

comfy setup 通过一个交互式向导引导你完成所有操作:本地或云端路由、身份认证以及智能体技能安装。对于非交互式(CI/脚本化)安装,可传入 -y 参数。

或者,显式执行安装:

comfy install

然后启动:

comfy launch

## 工作区管理

Comfy CLI 支持多个 ComfyUI 工作区的管理,允许您同时维护不同的 ComfyUI 环境。

### 基本工作区操作

```bash
# 查看当前工作区路径
comfy which

# 设置默认工作区
comfy set-default /path/to/your/workspace

# 设置默认工作区并附带启动参数
comfy set-default /path/to/your/workspace --launch-extras="--listen 0.0.0.0 --port 8080"

在不同工作区中执行命令

选项使用场景
--workspace=<path>在指定工作区中已安装的 ComfyUI 上运行
--recent在最近使用的 ComfyUI 上运行
--here在当前目录的 ComfyUI 上运行
# 在指定工作区中启动 ComfyUI
comfy --workspace=~/projects/project-a launch

# 在最近的工作区中安装节点
comfy --recent node install ComfyUI-Impact-Pack

# 检查当前目录是否包含 ComfyUI
comfy --here which

注意: --workspace--recent--here 不能同时使用。

工作区优先级规则

当未指定工作区时:

  1. comfy set-default <path> 设置的默认路径
  2. 最近执行或安装的 ComfyUI
  3. 当前目录中的 ComfyUI

启动选项

基本启动

# 默认启动
comfy launch

# 后台运行
comfy launch --background

# 停止后台实例
comfy stop

# 使用额外参数启动
comfy launch -- --cpu --listen 0.0.0.0

网络配置

comfy launch -- --listen 0.0.0.0 --port 8080

性能选项

comfy launch -- --cpu       # 仅 CPU 模式
comfy launch -- --lowvram   # 低显存模式
comfy launch -- --novram     # 极低显存模式

测试 Pull Request

# 安装特定的 ComfyUI PR
comfy install --pr "#1234"
comfy install --pr "https://github.com/comfyanonymous/ComfyUI/pull/1234"

# 测试前端 PR
comfy launch --frontend-pr "#456"
comfy launch --frontend-pr "username:branch-name"

前端 PR 构建会被缓存,方便快速切换。管理缓存:

comfy pr-cache list              # 列出缓存的 PR 构建
comfy pr-cache clean             # 清理所有缓存的构建
comfy pr-cache clean 456         # 清理特定 PR 的缓存

## 自定义节点管理

### 查看节点信息

```bash
comfy node show all                               # 查看所有可用节点
comfy node simple-show installed                  # 查看已安装节点的简单列表
comfy node show enabled                           # 仅查看已启用的节点
comfy node show not-installed                     # 查看未安装的节点
comfy node show disabled                          # 查看已禁用的节点
comfy node show all --channel recent              # 查看来自最近频道的节点
comfy node show snapshot                          # 查看当前快照信息
comfy node show snapshot-list                     # 列出已保存的快照

安装与更新节点

comfy node install ComfyUI-Impact-Pack            # 安装自定义节点
comfy node update all                             # 全部更新节点
comfy node update ComfyUI-Impact-Pack             # 更新特定节点

快速依赖关系解析

Comfy CLI 提供两种使用 uv 实现更快依赖关系解析的方式:

功能--fast-deps--uv-compile
适用范围comfy install、节点安装/重装仅限自定义节点命令
解析器comfy-cli 内置ComfyUI-Manager v4.1+ 统一解析器
冲突处理交互式提示自动处理并归因于节点
# 快速初始安装
comfy install --fast-deps

# 对自定义节点管理使用 uv-compile(需要 ComfyUI-Manager v4.1+)
comfy node install comfyui-impact-pack --uv-compile

# 独立运行(解析所有现有自定义节点的依赖关系)
comfy node uv-sync

# 将 --uv-compile 设为默认值
comfy manager uv-compile-default true

节点快照管理

comfy node save-snapshot                           # 保存当前快照
comfy node restore-snapshot <snapshot_name>        # 恢复已保存的快照

依赖关系管理

comfy node install-deps --workflow=workflow.json   # 从工作流 JSON 安装依赖关系
comfy node install-deps --workflow=workflow.png    # 从工作流 PNG 安装依赖关系
comfy node install-deps --deps=dependencies.json   # 从依赖关系 JSON 文件安装
comfy node deps-in-workflow --workflow=workflow.json --output=deps.json

节点故障排除(二分定位)

精确定位导致问题的自定义节点:

comfy node bisect start                            # 开始二分定位会话
comfy node bisect good                             # 将当前状态标记为正常
comfy node bisect bad                              # 将当前状态标记为异常
comfy node bisect reset                            # 重置会话

## 无需工作流 JSON 即可生成图像

Comfy CLI 可以直接调用合作伙伴的图像和视频模型——无需工作流画面:

```bash
comfy generate --prompt "a cat on a beach" --model flux/schnell
comfy generate --prompt "anime girl" --model stability/stable-diffusion-3.5
comfy generate --prompt "city street" --model ideogram/ideogram-v2

支持的提供商包括:Flux、Ideogram、DALL·E、Recraft、Stability、Gemini、Kling、Luma、Runway、Pika、Vidu、Hailuo、Seedance 等。

路由到云端

在 Comfy Cloud 上运行任何工作流(无需本地 GPU):

comfy launch -- --where cloud
# 或
comfy generate --model recraft/recraft-v3 --where cloud

为 AI 智能体提供结构化输出

每条指令都支持 --json 以输出机器可读的结果——非常适合 CI/CD 和 AI 智能体集成:

comfy generate --prompt "a cat" --model flux/schnell --json

## 模型管理

### 下载模型

```bash
# 从 Hugging Face
comfy model download --url https://huggingface.co/runwayml/stable-diffusion-v1-5/resolve/main/v1-5-pruned.safetensors --relative-path models/checkpoints

# 从 CivitAI
comfy model download --url https://civitai.com/api/download/models/123456 --relative-path models/checkpoints

# 使用 API token
comfy model download --url https://civitai.com/api/download/models/123456 --set-civitai-api-token YOUR_TOKEN

API token 也可以通过环境变量(CIVITAI_API_TOKENHF_API_TOKEN)设置,这在 CI/CD 环境中更安全。

管理模型

comfy model list                                  # 列出默认路径下的模型
comfy model list --relative-path models/loras     # 列出子文件夹中的模型
comfy model remove --model-names "model.safetensors"  # 移除一个模型

## ComfyUI-Manager 管理

```bash
comfy manager disable-gui                         # 禁用管理器 GUI
comfy manager enable-gui                          # 启用管理器 GUI
comfy manager clear                               # 清除预留的启动操作

## 环境信息

```bash
comfy env                                         # 显示详细的环境信息
comfy tracking status                             # 检查跟踪设置
comfy tracking disable                            # 禁用使用跟踪
comfy tracking enable                             # 启用使用跟踪

## 高级功能

### comfy-lock.yaml(测试版)

使用 `comfy-lock.yaml` 文件管理项目依赖关系:

```yaml
basic:

models:
  - model: SD1.5 Base
    url: https://huggingface.co/...
    paths:
      - path: models/checkpoints
    hashes:
      - hash: abc123...
        type: SHA256
    type: checkpoint

custom_nodes:
  git_custom_nodes:
    https://github.com/user/ComfyUI-Node:
      disabled: false
      hash: a1b2c3d...

## 常见使用场景

### 开发环境管理

```bash
# 为稳定开发创建工作区
comfy --workspace=~/dev/comfyui-stable install

# 为实验性功能创建工作区
comfy --workspace=~/dev/comfyui-experimental install

# 安装实验性节点
comfy --workspace=~/dev/comfyui-experimental node install ComfyUI-AnimateDiff-Evolved

项目依赖关系管理

# 为项目创建快照
comfy node save-snapshot my-project-v1

# 还原项目依赖关系
comfy node restore-snapshot my-project-v1

# 安装工作流依赖关系
comfy node install-deps --workflow=project.json

## 故障排除

### 常见问题

1. **工作区路径问题**
   ```bash
   comfy which              # 检查当前工作区
   comfy set-default /path  # 重置为正确路径
  1. 节点冲突

    comfy node bisect start  # 使用二分法定位问题节点
  2. 权限问题

    ls -la ~/comfy           # 检查目录权限

相关链接