Comfy CLI 完整使用指南
Comfy CLI 是 ComfyUI 官方提供的命令行工具,它不仅能简化 ComfyUI 的安装过程,还提供了强大的管理功能。本文将详细介绍 Comfy CLI 的所有功能。
基础命令
安装和设置
# 安装 comfy-cli
pip install comfy-cli
# 启用命令行自动补全
comfy --install-completion
# 安装 ComfyUI
comfy install
# 启动 ComfyUI
comfy launch
工作空间管理
comfy-cli 支持多个 ComfyUI 工作空间的管理,让您可以同时维护多个不同的 ComfyUI 环境:
基本工作空间操作
# 检查当前工作空间路径
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"
在不同工作空间中执行命令
1. 指定工作空间:
# 在指定工作空间中启动 ComfyUI
comfy --workspace=/path/to/workspace launch
# 在指定工作空间中安装节点
comfy --workspace=/path/to/workspace node install ComfyUI-Impact-Pack
2. 使用最近的工作空间:
# 启动最近使用的 ComfyUI
comfy --recent launch
# 在最近的工作空间中更新节点
comfy --recent node update all
3. 在当前目录操作:
# 在当前目录的 ComfyUI 中安装节点
comfy --here node install ComfyUI-Impact-Pack
# 在当前目录启动 ComfyUI
comfy --here launch
# 检查当前目录是否有 ComfyUI
comfy --here which
工作空间选项限制
重要提示:
--workspace
、--recent
和--here
选项不能同时使用。
工作空间优先级规则
当您没有明确指定工作空间时,comfy-cli 会按以下优先级自动选择:
- 通过
comfy set-default <path>
指定的默认 ComfyUI 路径 - 最近执行或安装的 ComfyUI
- 当前目录中的 ComfyUI
实际使用示例
场景1:为不同项目创建独立环境
# 为项目A创建工作空间
comfy --workspace=~/projects/projectA install
# 为项目B创建工作空间
comfy --workspace=~/projects/projectB install
# 在项目A中安装特定节点
comfy --workspace=~/projects/projectA node install ComfyUI-AnimateDiff-Evolved
# 在项目B中安装不同的节点
comfy --workspace=~/projects/projectB node install ComfyUI-Impact-Pack
场景2:快速切换工作环境
# 设置常用的工作空间为默认
comfy set-default ~/projects/main-workspace
# 临时在另一个工作空间工作
comfy --workspace=~/projects/test-workspace launch
# 回到默认工作空间
comfy launch
启动选项
ComfyUI 提供了丰富的启动选项来满足不同需求:
基础启动
# 默认启动
comfy launch
# 后台运行
comfy launch --background
# 停止后台运行的实例
comfy stop
网络配置
# 指定监听地址和端口
comfy launch -- --listen 0.0.0.0 --port 8080
# 允许外部访问
comfy launch -- --listen 0.0.0.0
性能优化
# 使用 CPU 模式
comfy launch -- --cpu
# 低显存模式
comfy launch -- --lowvram
# 超低显存模式
comfy launch -- --novram
# 启用模型 CPU 卸载
comfy launch -- --cpu-vae
自定义节点管理
节点信息查看
# 显示所有可用节点信息
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 install ComfyUI-Impact-Pack
# 更新所有节点
comfy node update all
# 更新特定节点
comfy node update ComfyUI-Impact-Pack
节点快照管理
快照功能可以帮您保存和恢复节点配置状态:
# 保存节点快照
comfy node save-snapshot
# 查看快照列表
comfy node show snapshot-list
# 恢复节点快照
comfy node restore-snapshot <snapshot_name>
依赖管理
# 从工作流程文件安装依赖
comfy node install-deps --workflow=workflow.json
# 从工作流程 PNG 文件安装依赖
comfy node install-deps --workflow=workflow.png
# 从依赖 JSON 文件安装
comfy node install-deps --deps=dependencies.json
# 生成工作流程依赖文件
comfy node deps-in-workflow --workflow=workflow.json --output=deps.json
节点故障排除(Bisect)
当遇到节点冲突或问题时,可以使用 bisect 功能快速定位问题节点:
# 开始故障排除会话
comfy node bisect start
# 标记当前状态为正常
comfy node bisect good
# 标记当前状态为有问题
comfy node bisect bad
# 重置故障排除会话
comfy node bisect reset
模型管理
模型下载
# 从 URL 下载模型(支持 CivitAI、Hugging Face 等)
comfy model download --url https://huggingface.co/model/url
# 下载到指定相对路径
comfy model download --url https://civitai.com/api/download/models/123456 --relative-path models/checkpoints
# 设置 CivitAI API Token(用于下载需要登录的模型)
comfy model download --url https://civitai.com/api/download/models/123456 --set-civitai-api-token YOUR_TOKEN
# 组合使用多个选项
comfy model download --url https://huggingface.co/runwayml/stable-diffusion-v1-5/resolve/main/v1-5-pruned.safetensors --relative-path models/checkpoints
模型管理
# 列出默认路径的所有模型
comfy model list
# 列出指定路径的模型
comfy model list --relative-path models/loras
# 删除指定模型
comfy model remove --model-names "model1.safetensors,model2.ckpt"
# 从指定路径删除模型
comfy model remove --relative-path models/checkpoints --model-names "old_model.ckpt"
支持的模型来源
- Hugging Face: 直接使用文件 URL
- CivitAI: 使用模型下载 API URL
- 其他直链: 任何可直接下载的模型文件 URL
ComfyUI-Manager 管理
comfy-cli 还可以管理 ComfyUI-Manager 的设置:
# 禁用 ComfyUI-Manager 的 GUI(菜单和服务器)
comfy manager disable-gui
# 启用 ComfyUI-Manager 的 GUI
comfy manager enable-gui
# 清除预留的启动操作
comfy manager clear
环境信息查看
查看当前 ComfyUI 环境的详细信息:
# 显示环境信息,包括运行状态、工作空间等
comfy env
# 检查追踪设置状态
comfy tracking status
# 禁用使用情况追踪
comfy tracking disable
# 启用使用情况追踪
comfy tracking enable
高级功能
Beta 功能:comfy-lock.yaml
comfy-cli 支持使用 comfy-lock.yaml
文件来管理项目依赖:
basic:
models:
- model: [模型名称]
url: [模型来源 URL,如 https://huggingface.co/...]
paths: [模型路径列表]
- path: [模型路径]
- path: [模型路径]
hashes: [模型哈希值]
- hash: [哈希值]
type: [AutoV1, AutoV2, SHA256, CRC32, Blake3]
type: [模型类型,如 diffuser, lora 等]
# 兼容 ComfyUI-Manager 的 .yaml 快照
custom_nodes:
comfyui: [commit hash]
file_custom_nodes:
- disabled: [bool]
filename: [.py 文件名]
...
git_custom_nodes:
[git-url]:
disabled: [bool]
hash: [commit hash]
...
常见使用场景
开发环境管理
# 创建开发环境
comfy --workspace=~/dev/comfyui-dev install
# 创建测试环境
comfy --workspace=~/test/comfyui-test install
# 在开发环境中安装实验性节点
comfy --workspace=~/dev/comfyui-dev node install experimental-node
# 快速切换到测试环境进行测试
comfy --workspace=~/test/comfyui-test launch
项目依赖管理
# 为项目创建依赖快照
comfy node save-snapshot project-v1.0
# 安装项目工作流程依赖
comfy node install-deps --workflow=project-workflow.json
# 恢复到特定版本的依赖
comfy node restore-snapshot project-v1.0
模型管理自动化
# 批量下载项目所需模型
comfy model download --url https://huggingface.co/model1 --relative-path models/checkpoints
comfy model download --url https://huggingface.co/model2 --relative-path models/loras
# 清理旧模型
comfy model remove --model-names "old_model1.ckpt,old_model2.safetensors"
故障排除
常见问题
-
工作空间路径问题
# 检查当前工作空间 comfy which # 如果路径不正确,重新设置 comfy set-default /correct/path
-
节点冲突问题
# 使用 bisect 功能定位问题 comfy node bisect start # 根据提示标记正常/异常状态
-
权限问题
# 确保有足够权限 ls -la ~/comfy