Custom Nodes

​

About Custom Nodes

After installing ComfyUI, you’ll discover that it includes many built-in nodes. These native nodes are called Comfy Core nodes, which are officially maintained by ComfyUI.

Additionally, there are numerous custom nodes created by various authors from the ComfyUI community. These custom nodes bring extensive functionality to ComfyUI, greatly expanding its capabilities and feature boundaries.

In this guide, we’ll cover various operations related to custom nodes, including installation, updates, disabling, uninstalling, and dependency installation.

Anyone can develop their own custom extensions for ComfyUI and share them with others. You can find many community custom nodes here. If you want to develop your own custom nodes, visit the section below to get started:

​

Custom Node Management

In this section we will cover:

• Installing custom nodes
• Installing node dependencies
• Custom node version control
• Uninstalling custom nodes
• Temporarily disabling custom nodes
• Handling custom node dependency conflicts

​

1. Installing Custom Nodes

Currently, ComfyUI supports installing custom nodes through multiple methods, including:

• Install via ComfyUI Manager (Recommended)
• Install via Git
• Manual installation

We recommend installing custom nodes through ComfyUI Manager, which is a highly significant tool in the ComfyUI custom node ecosystem. It makes custom node management (such as searching, installing, updating, disabling, and uninstalling) simple - you just need to search for the node you want to install in ComfyUI Manager and click install.

However, since all custom nodes are currently stored on GitHub, for regions that cannot access GitHub normally, we have written detailed instructions for different custom node installation methods in this guide.

Additionally, since we recommend using ComfyUI Manager for plugin management, we recommend using this tool for plugin management. You can find its source code here. Therefore, in this documentation, we will use installing ComfyUI Manager as a custom node installation example, and supplement how to use it for node management in the relevant introduction sections.

git --version

https://github.com/Comfy-Org/ComfyUI-Manager

cd D:\ComfyUI_windows_portable\ComfyUI\custom_nodes

git clone https://github.com/Comfy-Org/ComfyUI-Manager

​

2. Installing Node Dependencies

Custom nodes all require the installation of related dependencies. For example, for ComfyUI-Manager, you can visit the requirements.txt file to view the dependency package requirements.

In the previous steps, we only cloned the custom node code locally and did not install the corresponding dependencies, so next we need to install the corresponding dependencies.

In the Dependencies chapter, we introduced the relevant content about dependencies in ComfyUI. ComfyUI is a Python-based project, and we built an independent Python runtime environment for running ComfyUI. All related dependencies need to be installed in this independent Python runtime environment.

If you run pip install -r requirements.txt directly in the system-level terminal, the corresponding dependencies may be installed in the system-level Python environment, which will cause the dependencies to still be missing in ComfyUI’s environment, preventing the corresponding custom nodes from running normally.

So next we need to use ComfyUI’s independent Python runtime environment to complete the dependency installation.

Depending on different ComfyUI versions, we will use different methods to install the corresponding dependencies:

python_embeded\python.exe -m pip install -r ComfyUI\custom_nodes\ComfyUI-Manager\requirements.txt

python_embeded\python.exe -m pip install -r ComfyUI\custom_nodes\ComfyUI-Manager\requirements.txt

pip install -r .\custom_nodes\<corresponding_custom_node_name>\requirements.txt

​

Custom Node Version Control

Custom node version control is actually based on Git version control. You can manage node versions through Git, but ComfyUI Manager has already integrated this version management functionality very well. Many thanks to @Dr.Lt.Data for bringing us such a convenient tool.

In this section, we will still explain these two different plugin version management methods for you, but if you use ZIP packages for manual installation, the corresponding git version history information will be lost, making it impossible to perform version management.

cd <your_installation_directory>/ComfyUI/custom_nodes/ComfyUI-Manager

git tag

git checkout <tag_name>

git checkout <commit_hash>

​

Uninstalling Custom Nodes

To be updated

​

Temporarily Disabling Custom Nodes

To be updated

​

Custom Node Dependency Conflicts

To be updated

​

ComfyUI Manager

This tool is currently included by default in the Desktop version, while in the Portable version, you need to refer to the installation instructions in the Install Manager section of this document.

​

Installing the Manager

If you are running the ComfyUI server application, you need to install the manager. If ComfyUI is running, please close it before continuing.

The first step is to install Git, which is a command-line application for software version control. Git will download the ComfyUI manager from github.com. Download and install Git from git-scm.com.

After installing Git, navigate to the ComfyUI server program directory and enter the folder labeled custom_nodes. Open a command window or terminal. Make sure the command line shows the current directory path as custom_nodes. Enter the following command. This will download the manager. Technically, this is called cloning a Git repository.

​

Detecting Missing Nodes

After installing the manager, you can detect missing nodes in the manager.

​

Developing a Custom Node

If you have some development capabilities, please start with the documentation below to learn how to begin developing a custom node.