ComfyUI-Manager README

The project's README from github.com/Comfy-Org/ComfyUI-Manager. As one markdown file: README.md.

ComfyUI Manager

ComfyUI-Manager is an extension designed to enhance the usability of ComfyUI. It offers management functions to install, remove, disable, and enable various custom nodes of ComfyUI. Furthermore, this extension provides a hub feature and convenience functions to access a wide range of information within ComfyUI.

menu

NOTICE

Installation

Installation[method1] (General installation method: ComfyUI-Manager only)

To install ComfyUI-Manager in addition to an existing installation of ComfyUI, you can follow the following steps:

  1. Go to ComfyUI/custom_nodes dir in terminal (cmd)
  2. git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager
  3. Restart ComfyUI

Installation[method2] (Installation for portable ComfyUI version: ComfyUI-Manager only)

  1. install git
  1. Download scripts/install-manager-for-portable-version.bat into installed "ComfyUI_windows_portable" directory
  1. Double-click install-manager-for-portable-version.bat batch file

portable-install

Installation[method3] (Installation through comfy-cli: install ComfyUI and ComfyUI-Manager at once.)

RECOMMENDED: comfy-cli provides various features to manage ComfyUI from the CLI.

Windows:

python -m venv venv
venv\Scripts\activate
pip install comfy-cli
comfy install

Linux/macOS:

python -m venv venv
. venv/bin/activate
pip install comfy-cli
comfy install

Installation[method4] (Installation for Linux+venv: ComfyUI + ComfyUI-Manager)

To install ComfyUI with ComfyUI-Manager on Linux using a venv environment, you can follow these steps:

  1. Download scripts/install-comfyui-venv-linux.sh into empty install directory
  1. chmod +x install-comfyui-venv-linux.sh
  2. ./install-comfyui-venv-linux.sh

Installation Precautions

You can execute ComfyUI by running either ./run_gpu.sh or ./run_cpu.sh depending on your system configuration.

Colab Notebook

This repository provides Colab notebooks that allow you to install and use ComfyUI, including ComfyUI-Manager. To use ComfyUI, click on this link.

How To Use

  1. Click "Manager" button on main menu

    mainmenu

  2. If you click on 'Install Custom Nodes' or 'Install Models', an installer dialog will open.

    menu

    • There are three DB modes: DB: Channel (1day cache), DB: Local, and DB: Channel (remote).

      • Channel (1day cache) utilizes Channel cache information with a validity period of one day to quickly display the list.
        • This information will be updated when there is no cache, when the cache expires, or when external information is retrieved through the Channel (remote).
        • Whenever you start ComfyUI anew, this mode is always set as the default mode.
      • Local uses information stored locally in ComfyUI-Manager.
        • This information will be updated only when you update ComfyUI-Manager.
        • For custom node developers, they should use this mode when registering their nodes in custom-node-list.json and testing them.
      • Channel (remote) retrieves information from the remote channel, always displaying the latest list.
      • In cases where retrieval is not possible due to network errors, it will forcibly use local information.
    • The Fetch Updates menu retrieves update data for custom nodes locally. Actual updates are applied by clicking the Update button in the Install Custom Nodes menu.

  3. Click 'Install' or 'Try Install' button.

    node-install-dialog

    model-install-dialog

    • Installed: This item is already installed.

    • Install: Clicking this button will install the item.

    • Try Install: This is a custom node of which installation information cannot be confirmed. Click the button to try installing it.

    • If a red background Channel indicator appears at the top, it means it is not the default channel. Since the amount of information held is different from the default channel, many custom nodes may not appear in this channel state.

      • Channel settings have a broad impact, affecting not only the node list but also all functions like "Update all."
    • Conflicted Nodes with a yellow background show a list of nodes conflicting with other extensions in the respective extension. This issue needs to be addressed by the developer, and users should be aware that due to these conflicts, some nodes may not function correctly and may need to be installed accordingly.

  4. Share menu share

menu

Paths

Starting from V3.38, Manager uses a protected system path for enhanced security.

ComfyUI Version Manager Path
v0.3.76+ (with System User API) <USER_DIRECTORY>/__manager/
Older versions <USER_DIRECTORY>/default/ComfyUI-Manager/

Note: See Migration Guide for upgrade details.

extra_model_paths.yaml Configuration

The following settings are applied based on the section marked as is_default.

Snapshot-Manager

model-install-dialog

cm-cli: command line tools for power users

How to register your custom node into ComfyUI-Manager

Custom node support guide

Special purpose files (optional)

Component Sharing

Support for installing missing nodes

missing-menu

missing-list

Config

Additional Feature

Environment Variables

The following features can be configured using environment variables:

Example 1:

Redirecting https://github.com/ltdrdata/ComfyUI-Impact-Pack to https://mirror.ghproxy.com/https://github.com/ltdrdata/ComfyUI-Impact-Pack

GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com

Example 2:

Changing https://huggingface.co/path/to/somewhere to https://some-hf-mirror.com/path/to/somewhere

HF_ENDPOINT=https://some-hf-mirror.com 

Scanner

When you run the scan.sh script:

Troubleshooting

Security policy

Dedicated install flags: allow_git_url_install / allow_pip_install

The two arbitrary-install surfaces are governed by dedicated boolean keys in config.ini ([default] section), fully decoupled from security_level:

Key properties:

To opt in, edit config.ini:

[default]
allow_git_url_install = true
allow_pip_install = true

Changes take effect after a restart (no hot reload).

Migration note: there is no automatic migration from security_level. If you previously relied on security_level = weak (or normal-) to use install-via-git-URL / pip install, you must opt in explicitly with the flags above. See CHANGELOG.md for details, including a behavior note for outdated ComfyUI deployments.

Flagged CNR versions: allow_flagged_nodepack_install

Manager checks the version status in the existing CNR install response; no additional Registry request is needed. Active versions continue to install normally, subject to the existing security policy. Registry refusals (including HTTP 404) still prevent installation.

Flagged versions must also satisfy the existing security policy and Registry checks. In addition, they require either all --listen addresses to be loopback, such as 127.0.0.1 or ::1, or the explicit override below. A mixed loopback/non-loopback listener is non-local.

For a trusted private network, administrators can explicitly allow flagged versions on non-loopback listeners:

[default]
allow_flagged_nodepack_install = true

The default is false; only the case-insensitive value true enables it. Restart ComfyUI after editing the setting. This option does not detect private networks and is independent of network_mode. It does not bypass security_level, allow_git_url_install, or allow_pip_install.

When the flagged-version check denies an action, the UI reports that the current security configuration does not allow it and directs users to the terminal. Only the terminal provides the loopback-only --listen examples, the private network override setting, and the instruction to restart ComfyUI after changes.

Enabling an already installed version does not query the Registry or reinstall it. Older deferred switches without a stored status require loopback-only listeners or the override. Otherwise they are rejected without changing the installed pack; request the installation again so Manager can check its current Registry status.

The check applies to server-initiated installation, reinstallation, version switches, updates, and snapshot restores. A policy refusal preserves the existing nodepack. Scheduled version switches save the returned status and check the current listener and setting again at startup, before downloading or running scripts. Server-scheduled snapshot restores inherit the permission computed from the server's current listener and setting. Standalone cm-cli commands remain local administrator operations and do not use the server listener policy. Saved statuses are not refreshed from the Registry.

Disclaimer

Credit

ComfyUI/ComfyUI - A powerful and modular stable diffusion GUI.

And, for all ComfyUI custom node developers

ComfyUI-Manager (Comfy-Org/ComfyUI-Manager)

Searching Database…

这是什么?ComfyUI-Manager 是 ComfyUI 的扩展,可以在 ComfyUI 里安装、卸载、禁用和启用自定义节点,还提供一个中心页面和一些便利功能,方便浏览相关信息。
这是独立应用,还是给其他软件用的插件?它是一个自定义节点/扩展,运行在已安装的 ComfyUI 中,而不是独立程序。
添加之前,我需要先装好什么吗?你需要已有的 ComfyUI 环境、Python 3 和 git(comfy-cli 安装方式明确要求 'python 3, git')。
安装时我需要注意哪些坑?管理器文件必须准确放在 ComfyUI/custom_nodes/comfyui-manager 目录下;如果解压到嵌套或改过名的文件夹(比如 ComfyUI-Manager-main),会导致更新检测失效,还可能造成重复安装。
它能在 Windows、Linux 和 macOS 上运行吗?可以。它为 Windows 提供了专门的安装方式(包括便携版的 .bat 脚本),为 Linux/macOS 提供了 venv Shell 脚本和运行脚本。
它正常工作时需要连接外部网络吗?它支持完全离线模式,只使用缓存数据,从不建立外部连接;同时也支持公共网络和私有网络两种模式。
不打开 ComfyUI 界面,我能管理自定义节点吗?可以,有一个 cm-cli 命令行工具,无需运行 ComfyUI 就能使用 ComfyUI-Manager 的功能。
快照功能是做什么用的?它会保存当前已安装自定义节点的状态,之后可以通过 'Restore' 按钮恢复到完全相同的配置,恢复会在下次启动 ComfyUI 时生效。
我怎样把自己的自定义节点添加到管理器的列表里?在仓库根目录的 custom-node-list.json 中添加一条记录,并提交拉取请求(pull request);提交前请先开启 'Use local DB',确认它能正常加载。
什么是组件共享?它可以把节点组以 JSON/.pack 数据的形式复制,再粘贴或拖放进来,快速重新添加可复用的工作流组件;也可以选择打包成有名称的包。
Creator
Comfy-Org
Size
194.3 MB
Stars
16.5K
Updated
CommitOct 17
Age
3y
Commits · 90 Days