comfy-cli 是一个命令行工具,可以帮助用户轻松安装和管理 ComfyUI 这一强大的开源机器学习框架。使用 comfy-cli,您可以快速设置 ComfyUI、安装软件包和管理自定义节点,这一切都可以在您的终端上方便地完成。
(推荐,但不是必须)启用虚拟环境(venv/conda)
要安装 comfy-cli,请确保您的系统上安装了 Python 3.9 或更高版本。然后,运行以下命令:
pip install comfy-cli
要在 shell 中安装自动完成提示,请运行:
comfy --install-completion
这使您可以键入comfy [TAP]来自动完成命令和选项
要使用 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, or --here等路径规范,它将隐式安装在<HOME>/comfy中。您可以通过路径指示符指定将应用该命令的 ComfyUI 的路径,如下所示:
comfy --workspace=<path> :从指定工作区中安装的 ComfyUI 运行。comfy --recent :从最近执行或安装的 ComfyUI 运行。comfy --here :从当前目录中的 ComfyUI 运行。--workspace、--recent 和 --here 选项不能同时使用。
如果没有路径指示符,则应用以下优先级:
comfy set-default <path>指定的路径处的默认 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选项指定默认情况下仅在启动期间应用的额外参数。但是,如果在启动时指定了额外功能,则此设置将被忽略。Comfy 提供的命令可让您轻松运行已安装的 ComfyUI。
comfy launch
要使用默认 ComfyUI 选项运行:
comfy launch -- <extra args...>
comfy launch -- --cpu --listen 0.0.0.0
运行后台
comfy launch --background
comfy --workspace=~/comfy launch --background -- --listen 10.0.0.10 --port 8000
--background启动的实例显示在comfy env的“Background ComfyUI”部分中,仅为单个后台实例提供管理功能。comfy env中的“Comfy Server Running”仅显示默认端口 8188,因此它不会显示在不同端口上运行的 ComfyUI。comfy stop停止。comfy 提供了一种便捷的方式来管理自定义节点以扩展 ComfyUI 的功能。以下是一些示例:
comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list]
?[--channel <channel name>]
?[--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 <snapshot name>
安装依赖项:
comfy node install-deps --deps=<deps .json file>
comfy node install-deps --workflow=<workflow .json/.png file>
生成依赖:
comfy node deps-in-workflow --workflow=<workflow .json/.png file> --output=<output deps .json file>
如果您仅在启用自定义节点的情况下遇到错误,并且想要找出导致错误的自定义节点,bisect 工具可以帮助您查明导致问题的自定义节点。
comfy node bisect start :使用可选的 ComfyUI 启动参数启动新的 bisect 会话。它会自动将启动状态标记为坏,并在命令执行时将所有启用的节点作为测试集。comfy node bisect good :将当前活动集标记为良好,表明问题不在测试集中。comfy node bisect bad :将当前活动集标记为坏,表明问题在测试集中。comfy node bisect reset :重置当前的 bisect 会话。模型下载
comfy model download --url <URL> ?[--relative-path <PATH>] ?[--set-civitai-api-token <TOKEN>]
模型删除
comfy model remove ?[--relative-path <PATH>] --model-names <model names>
型号列表
comfy model list ?[--relative-path <PATH>]
禁用 ComfyUI-Manager 的 GUI(禁用管理器菜单和服务器)
comfy manager disable-gui
启用 ComfyUI-Manager 的 GUI
comfy manager enable-gui
清除保留的启动动作:
comfy manager clear
basic:
models:
- model: [name of the model]
url: [url of the source, e.g. https://huggingface.co/...]
paths: [list of paths to the model]
- path: [path to the model]
- path: [path to the model]
hashes: [hashes for the model]
- hash: [hash]
type: [AutoV1, AutoV2, SHA256, CRC32, and Blake3]
type: [type of the model, e.g. diffuser, lora, etc.]
- model:
...
# compatible with ComfyUI-Manager's .yaml snapshot
custom_nodes:
comfyui: [commit hash]
file_custom_nodes:
- disabled: [bool]
filename: [.py filename]
...
git_custom_nodes:
[git-url]:
disabled: [bool]
hash: [commit hash]
...
我们使用 Mixpanel 跟踪分析,以帮助我们了解使用模式并知道在哪里优先考虑我们的工作。当您第一次下载 cli 时,它会要求您同意。如果您在任何时候希望选择退出:
comfy tracking disable
在这里查看用法:Mixpanel Board
我们欢迎对 comfy-cli 做出贡献!如果您有任何想法、建议或错误报告,请在我们的 GitHub 存储库上提出问题。如果您想贡献代码,请分叉存储库并提交拉取请求。
查看开发指南了解更多详细信息。
comfy 是根据 GNU 通用公共许可证 v3.0 发布的。
如果您遇到任何问题或对 comfy-cli 有疑问,请在我们的 GitHub 存储库上提出问题或通过 Discord 联系我们。我们很乐意为您提供帮助!
快乐地使用 ComfyUI 和 comfy-cli 进行扩散! ?