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= install
:將 ComfyUI 安裝到/ComfyUI
。comfy install
,如果沒有提供--workspace, --recent, or --here
等路徑規範,它將隱式安裝在/comfy
中。您可以透過路徑指示符指定將套用命令的 ComfyUI 路徑,如下所示:
comfy --workspace=
:從指定工作區安裝的 ComfyUI 執行。comfy --recent
:從最近執行或安裝的 ComfyUI 運行。comfy --here
:從目前目錄中的 ComfyUI 運行。--workspace、--recent 和 --here 選項不能同時使用。
如果沒有路徑指示符,則套用下列優先順序:
comfy set-default
指定的路徑處的預設 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
--launch-extras
選項指定預設情況下僅在啟動期間套用的額外參數。但是,如果在啟動時指定了額外功能,則此設定將被忽略。Comfy 提供的指令可讓您輕鬆執行已安裝的 ComfyUI。
comfy launch
使用預設 ComfyUI 選項運行:
comfy launch --
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 ]
?[--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=
comfy node install-deps --workflow=
產生依賴:
comfy node deps-in-workflow --workflow=
如果您僅在啟用自訂節點的情況下遇到錯誤,並且想要找出導致錯誤的自訂節點,bisect 工具可以幫助您找出導致問題的自訂節點。
comfy node bisect start
:使用可選的 ComfyUI 啟動參數啟動新的 bisect 會話。它會自動將啟動狀態標記為壞,並在命令執行時將所有啟用的節點作為測試集。comfy node bisect good
:將目前活動集標記為良好,表示問題不在測試集中。comfy node bisect bad
:將目前活動集標記為壞,表示問題在測試集中。comfy node bisect reset
:重設目前的 bisect 會話。模型下載
comfy model download --url
模型刪除
comfy model remove ?[--relative-path
型號列表
comfy model list ?[--relative-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 進行擴散! ?