Comfy-Cli：ComfyUI的命令行工具

comfy-cli是一个命令行工具，帮助用户轻松安装和管理ComfyUI，这是一个强大的开源机器学习框架。使用comfy-cli，您可以快速设置ComfyUI，安装软件包，并管理自定义节点，所有操作都可以在终端中方便地完成。

演示

功能

🚀 通过单个命令轻松安装ComfyUI
📦 无缝管理ComfyUI扩展和依赖项
🔧 管理自定义节点以扩展ComfyUI的功能
🗄️ 下载检查点并保存模型哈希值
💻 跨平台兼容性（Windows、macOS、Linux）
📖 全面的文档和示例

安装

（推荐但非必需）启用虚拟环境（venv/conda）
要安装comfy-cli，请确保您的系统已安装Python 3.9或更高版本。然后运行以下命令：

pip install comfy-cli

Shell自动完成

要在shell中安装自动完成提示，请运行：

comfy --install-completion

这使您可以输入comfy [TAP]来自动完成命令和选项

使用方法

安装ComfyUI

要使用comfy安装ComfyUI，只需运行：

comfy install

此命令将下载并设置最新版本的ComfyUI和ComfyUI-Manager。如果您在已设置的ComfyUI存储库中运行，该命令将仅更新comfy.yaml文件以反映本地设置。

comfy install --skip-manager：安装ComfyUI但不包含ComfyUI-Manager。
comfy --workspace=<path> install：将ComfyUI安装到<path>/ComfyUI。
对于comfy install，如果没有提供类似--workspace、--recent或--here的路径指定，它将隐式安装在<HOME>/comfy中。

指定执行路径

您可以通过以下路径指示器指定应用命令的ComfyUI路径：
- comfy --workspace=<path>：从指定工作空间安装的ComfyUI运行。
- comfy --recent：从最近执行或安装的ComfyUI运行。
- comfy --here：从当前目录中的ComfyUI运行。
--workspace、--recent和--here选项不能同时使用。
如果没有路径指示器，将应用以下优先级：
- 从comfy set-default <path>指定路径的默认ComfyUI运行。
- 从最近执行或安装的ComfyUI运行。
- 从当前目录中的ComfyUI运行。
示例1：运行最近执行的ComfyUI：
- comfy --recent launch
示例2：在当前目录的ComfyUI上安装包：
- comfy --here node install ComfyUI-Impact-Pack
示例3：根据优先级更新自动选择的ComfyUI路径和自定义节点：
- comfy node update all
您可以使用comfy which命令检查目标工作空间的路径。
- 例如comfy --recent which、comfy --here which、comfy which等

默认设置

默认设置是指当没有为命令设置特定工作空间的ComfyUI时，将默认执行的选项。

comfy set-default <workspace path> ?[--launch-extras="<extra args>"]

--launch-extras选项指定仅在默认启动期间应用的额外参数。但是，如果在启动时指定了额外参数，则此设置将被忽略。

启动ComfyUI

Comfy提供了允许您轻松运行已安装ComfyUI的命令。

comfy launch

要使用默认ComfyUI选项运行：

comfy launch -- <extra args...>

comfy launch -- --cpu --listen 0.0.0.0
- 当您手动配置额外选项时，set-default设置的额外参数将被覆盖。
在后台运行

comfy launch --background

comfy --workspace=~/comfy launch --background -- --listen 10.0.0.10 --port 8000
使用 --background 启动的实例会显示在 comfy env 的"后台 ComfyUI"部分，仅提供单个后台实例的管理功能。
由于 comfy env 中的"Comfy 服务器运行中"只显示默认端口 8188，因此不会显示在不同端口上运行的 ComfyUI。
可以使用 comfy stop 停止后台运行的 ComfyUI。

管理自定义节点

comfy 提供了一种方便的方式来管理用于扩展 ComfyUI 功能的自定义节点。以下是一些示例：

显示自定义节点信息：

comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list]
                             ?[--channel <频道名称>]
                             ?[--mode [remote|local|cache]]

comfy node show all --channel recent

comfy node simple-show installed

comfy node update all

comfy node install ComfyUI-Impact-Pack
管理快照：

comfy node save-snapshot

comfy node restore-snapshot <快照名称>
安装依赖：

comfy node install-deps --deps=<依赖 .json 文件>

comfy node install-deps --workflow=<工作流 .json/.png 文件>
生成依赖：

comfy node deps-in-workflow --workflow=<工作流 .json/.png 文件> --output=<输出依赖 .json 文件>

二分法查找自定义节点

如果您遇到只在启用自定义节点时出现的 bug，并想找出哪个自定义节点导致了该 bug，二分法工具可以帮助您定位导致问题的自定义节点。

comfy node bisect start：开始新的二分法会话，可选择 ComfyUI 启动参数。它会自动将起始状态标记为坏，并将执行命令时所有启用的节点作为测试集。
comfy node bisect good：将当前活动集标记为好，表示问题在测试集内。
comfy node bisect bad：将当前活动集标记为坏，表示问题在测试集内。
comfy node bisect reset：重置当前二分法会话。

管理模型

模型下载

comfy model download --url <URL> ?[--relative-path <路径>] ?[--set-civitai-api-token <令牌>]
- URL：CivitAI、huggingface 文件 url 等
模型删除

comfy model remove ?[--relative-path <路径>] --model-names <模型名称>
模型列表

comfy model list ?[--relative-path <路径>]

管理 ComfyUI-Manager

禁用 ComfyUI-Manager 的 GUI（禁用 Manager 菜单和服务器）

comfy manager disable-gui
启用 ComfyUI-Manager 的 GUI

comfy manager enable-gui
清除保留的启动操作：

comfy manager clear

Beta 功能：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 等]

  - model:
  ...

# 兼容 ComfyUI-Manager 的 .yaml 快照
custom_nodes:
  comfyui: [提交哈希]
  file_custom_nodes:
  - disabled: [布尔值]
    filename: [.py 文件名]
    ...
  git_custom_nodes:
    [git-url]:
      disabled: [布尔值]
      hash: [提交哈希]
    ...