Plugin installation guide

更新时间:
复制 MD 格式

ComfyUI plugins extend and enhance the features of ComfyUI. They add support for additional models, nodes, interface features, and image editing tools. ComfyUI is a highly modular, node-based interface. Plugins allow you to easily add new features without modifying the core code.

This guide describes two methods to install ComfyUI plugins:

1. Install using git clone (Recommended)

2. Install using ComfyUI Manager

Method 1: Install using git clone (Recommended)

This method is for users who are familiar with the command line. It lets you deploy plugins directly to the server-side ComfyUI instance. This method requires Git (version 2.30 or later is recommended) and a Python environment.

  1. 1. Get the plugin repository address

    Go to the plugin's code hosting platform, such as GitHub or GitLab. Find the project's "Clone or download" button. Select the HTTPS protocol and copy the full URL.

    Example format: https://github.com/nunchaku-tech/ComfyUI-nunchaku

  2. 2. Log on to the ComfyUI instance

    Create a ComfyUI project. For more information, see Quick Start. After the project is created, click Project Development > Instance List. Then, log on to the corresponding instance to open the terminal page.

  3. 3. Deploy the plugin to ComfyUI

    # Change to the plugin installation directory
    cd comfyui/custom_nodes
    
    # Use the git command to clone the repository plugin
    git clone https://github.com/mit-han-lab/ComfyUI-nunchaku.git
  4. 4. Install dependent components

    cd ComfyUI-nunchaku
    pip install -r requirements.txt --no-cache-dir
    Note

    Add the --no-cache-dir parameter to avoid cache conflicts.

  5. 5. Restart the ComfyUI service

    Click Manager > Restart to restart the ComfyUI application. This allows the application to load and detect the new plugin.

    Note

    After the restart, refresh your browser. If the service has not finished restarting, wait a moment and then refresh your browser again.

  6. 6. Update the plugin (Optional)

    To update a plugin that was installed using git clone, follow these steps:

    1. Log on to the ComfyUI instance and navigate to the terminal page.

    2. Use the cd command to navigate to the directory of the plugin that you want to update. For example:

      cd comfyui/ComfyUI-nunchaku
    3. Run the git pull command to pull the latest code, or run git checkout v-xxx to switch to a specific version.

    4. Install dependencies: pip install -r requirements.txt.

      Note

      Some plugins have their own requirements.txt file. Installing these dependencies can cause version conflicts with other installed plugins. If you encounter missing nodes or unexpected behavior, check the ComfyUI console output for errors. You may need to manually resolve the dependency conflicts.

    5. Restart ComfyUI for the plugin to take effect.

Method 2: Install using ComfyUI Manager

ComfyUI Manager is the officially recommended plugin management tool for ComfyUI. It provides a graphical interface to browse, install, and manage versions of custom nodes. Unlike manual installation, the Manager tool automatically handles dependencies and verifies plugin compatibility. This greatly simplifies the installation process.

  1. 1. Start the ComfyUI service

    Make sure your ComfyUI instance is running. Create a ComfyUI project. For more information, see Quick Start.

  2. 2. Open the Manager interface

    On the right-side panel of the ComfyUI interface, click the Manager button. In the Manager menu bar, select Custom Nodes Manager to open the node management interface.

  3. 3. Search for and install the plugin

    In the search box, enter the name of the plugin, or select a plugin from the list. Click the Install button in the corresponding row.

    Manager automatically performs the following operations:

    • Downloads the plugin source code.

    • Verifies the GPG signature (if the plugin supports it).

    • Installs Python dependency packages.

    • Creates a node configuration file.

  4. 4. Wait for the installation to complete and restart ComfyUI

    After the installation is complete, click Manager > Restart to restart the ComfyUI application. This allows the application to load and detect the new plugin.

    Note

    After the restart, refresh your browser. If the service has not finished restarting, wait a moment and then refresh your browser again.