ComfyUI-Manager

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.

NOTICE

• V3.38: Security patch - Manager data migrated to protected path. See Migration Guide.
• V3.16: Support for uv has been added. Set use_uv in config.ini.
• V3.10: double-click feature is removed
  • This feature has been moved to https://github.com/ltdrdata/comfyui-connection-helper
• V3.3.2: Overhauled. Officially supports https://registry.comfy.org/.
• You can see whole nodes info on ComfyUI Nodes Info page.

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

• https://git-scm.com/download/win
• standalone version
• select option: use windows default console window

1. Download scripts/install-manager-for-portable-version.bat into installed "ComfyUI_windows_portable" directory

• Don't click. Right-click the link and choose 'Save As...'

1. Double-click install-manager-for-portable-version.bat batch file

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.

• prerequisite: python 3, git

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

• See also: https://github.com/Comfy-Org/comfy-cli

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:

• prerequisite: python-is-python3, python3-venv, git

1. Download scripts/install-comfyui-venv-linux.sh into empty install directory

• Don't click. Right-click the link and choose 'Save As...'
• ComfyUI will be installed in the subdirectory of the specified directory, and the directory will contain the generated executable script.

1. chmod +x install-comfyui-venv-linux.sh
2. ./install-comfyui-venv-linux.sh

Installation Precautions

• DO: ComfyUI-Manager files must be accurately located in the path ComfyUI/custom_nodes/comfyui-manager
  • Installing in a compressed file format is not recommended.
• DON'T: Decompress directly into the ComfyUI/custom_nodes location, resulting in the Manager contents like __init__.py being placed directly in that directory.
  • You have to remove all ComfyUI-Manager files from ComfyUI/custom_nodes
• DON'T: In a form where decompression occurs in a path such as ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager.
• DON'T: In a form where decompression occurs in a path such as ComfyUI/custom_nodes/ComfyUI-Manager-main.
  • In such cases, ComfyUI-Manager may operate, but it won't be recognized within ComfyUI-Manager, and updates cannot be performed. It also poses the risk of duplicate installations. Remove it and install properly via git clone method.

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.

• Support for installing ComfyUI
• Support for basic installation of ComfyUI-Manager
• Support for automatically installing dependencies of custom nodes upon restarting Colab notebooks.

How To Use

1. Click "Manager" button on main menu

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

   • 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.

   • 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

• You can share the workflow by clicking the Share button at the bottom of the main menu or selecting Share Output from the Context Menu of the Image node.

• Currently, it supports sharing via https://comfyworkflows.com/, https://openart.ai, https://youml.com as well as through the Matrix channel.

• Through the Share settings in the Manager menu, you can configure the behavior of the Share button in the Main menu or Share Output button on Context Menu.

  • None: hide from Main menu
  • All: Show a dialog where the user can select a title for sharing.

Paths

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

• <USER_DIRECTORY>
  • If executed without any options, the path defaults to ComfyUI/user.
  • It can be set using --user-directory <USER_DIRECTORY>.

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

• Basic config files: config.ini
• Configurable channel lists: channels.list
• Configurable pip overrides: pip_overrides.json
• Configurable pip blacklist: pip_blacklist.list
• Configurable pip auto fix: pip_auto_fix.list
• Saved snapshot files: snapshots/
• Startup script files: startup-scripts/
• Component files: components/

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.

• custom_nodes: Path for installing custom nodes
  • Importing does not need to adhere to the path set as is_default, but this is the path where custom nodes are installed by the ComfyUI Nodes Manager.
• download_model_base: Path for downloading models

Snapshot-Manager

• When you press Save snapshot or use Update All on Manager Menu, the current installation status snapshot is saved.
  • Snapshot file dir: <USER_DIRECTORY>/default/ComfyUI-Manager/snapshots
  • You can rename snapshot file.
• Press the "Restore" button to revert to the installation status of the respective snapshot.
  • However, for custom nodes not managed by Git, snapshot support is incomplete.
• When you press Restore, it will take effect on the next ComfyUI startup.
  • The selected snapshot file is saved in <USER_DIRECTORY>/default/ComfyUI-Manager/startup-scripts/restore-snapshot.json, and upon restarting ComfyUI, the snapshot is applied and then deleted.

cm-cli: command line tools for power users

• A tool is provided that allows you to use the features of ComfyUI-Manager without running ComfyUI.
• For more details, please refer to the cm-cli documentation.

How to register your custom node into ComfyUI-Manager

• Add an entry to custom-node-list.json located in the root of ComfyUI-Manager and submit a Pull Request.
• NOTE: Before submitting the PR after making changes, please check Use local DB and ensure that the extension list loads without any issues in the Install custom nodes dialog. Occasionally, missing or extra commas can lead to JSON syntax errors.
• The remaining JSON will be updated through scripts in the future, so you don't need to worry about it.

Custom node support guide

• NOTICE:

  • You should no longer assume that the GitHub repository name will match the subdirectory name under custom_nodes. The name of the subdirectory under custom_nodes will now use the normalized name from the name field in pyproject.toml.
  • Avoid relying on directory names for imports whenever possible.

• https://docs.comfy.org/registry/overview

• https://github.com/Comfy-Org/rfcs

Special purpose files (optional)

• pyproject.toml - Spec file for comfyregistry.
• node_list.json - When your custom nodes pattern of NODE_CLASS_MAPPINGS is not conventional, it is used to manually provide a list of nodes for reference. (example)
• requirements.txt - When installing, this pip requirements will be installed automatically
• install.py - When installing, it is automatically called
• All scripts are executed from the root path of the corresponding custom node.

Component Sharing

• Copy & Paste
  • Demo Page
  • When pasting a component from the clipboard, it supports text in the following JSON format. (text/plain)

    {
      "kind": "ComfyUI Components",
      "timestamp": <current timestamp>,
      "components": 
        {
          <component name>: <component nodedata>
        }
    }
    

  • <current timestamp> Ensure that the timestamp is always unique.
    • "components" should have the same structure as the content of the file stored in <USER_DIRECTORY>/default/ComfyUI-Manager/components.
      • <component name>: The name should b