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.
- 🏆 John us for the ComfyUI Workflow Contest, hosted by OpenArt AI (11.27.2023 - 12.15.2023). Our esteemed judge panel includes Scott E. Detweiler, Olivio Sarikas, MERJIC麦橘, among others. We're also thrilled to have the authors of ComfyUI Manager and AnimateDiff as our special guests!
- If you wish to hide the "Share" button, click "Manager" and choose "Share: None" option.
- You can see whole nodes info on ComfyUI Nodes Info page.
- Versions prior to V0.22.2 will no longer detect missing nodes unless using a local database. Please update ComfyUI-Manager to the latest version.
To install ComfyUI-Manager in addition to an existing installation of ComfyUI, you can follow the following steps:
- cd custom_nodes
- git clone https://github.com/ltdrdata/ComfyUI-Manager.git
- Restart ComfyUI
- install git
- https://git-scm.com/download/win
- standalone version
- select option: use windows default console window
- Download scripts/install-manager-for-portable-version.bat into installed
"ComfyUI_windows_portable"
directory - double click
install-manager-for-portable-version.bat
batch file
To install ComfyUI with ComfyUI-Manager on Linux using a venv environment, you can follow these steps:
- Download scripts/install-comfyui-venv-linux.sh into empty install directory
- ComfyUI will be installed in the subdirectory of the specified directory, and the directory will contain the generated executable script.
chmod +x install-comfyui-venv-linux.sh
./install-comfyui-venv-linux.sh
You can execute ComfyUI by running either ./run_gpu.sh
or ./run_cpu.sh
depending on your system configuration.
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.
- 0.29 Add
Update all
feature - 0.25 support db channel
- You can directly modify the db channel settings in the
config.ini
file. - If you want to maintain a new DB channel, please modify the
channels.list
and submit a PR.
- You can directly modify the db channel settings in the
- 0.23 support multiple selection
- 0.18.1
skip update check
feature added.- A feature that allows quickly opening windows in environments where update checks take a long time.
- 0.17.1 Bug fix for the issue where enable/disable of the web extension was not working. Compatibility patch for StableSwarmUI.
- Requires latest version of ComfyUI (Revision: 1240)
- 0.17 Support preview method setting feature.
- 0.14 Support robust update.
- 0.13 Support additional 'pip' section for install spec.
- 0.12 Better installation support for Windows.
- 0.9 Support keyword search in installer menu.
- V0.7.1 Bug fix for the issue where updates were not being applied on Windows.
- For those who have been using versions 0.6, please perform a manual git pull in the custom_nodes/ComfyUI-Manager directory.
- V0.7 To address the issue of a slow list refresh, separate the fetch update and update check processes.
- V0.6 Support extension installation for missing nodes.
- V0.5 Removed external git program dependencies.
- Click "Manager" button on main menu
- If you click on 'Install Custom Nodes' or 'Install Models', an installer dialog will open.
-
When the 'Use local DB' feature is enabled, the application will utilize the data stored locally on your device, rather than retrieving node/model information over the internet
-
The
Fetch Updates
menu retrieves update data for custom nodes locally. Actual updates are applied by clicking theUpdate
button in theInstall Custom Nodes
menu.
- 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 you set the
Badge:
item in the menu asBadge: Nickname
orBadge: #ID Nickname
, the information badge will be displayed on the node.
Badge: Nickname
displays the nickname of custom nodes, whileBadge: ID Nickname
also includes the internal ID of the node.
- When you press
Save snapshot
or useUpdate All
onManager Menu
, the current installation status snapshot is saved.- Snapshot file dir:
ComfyUI-Manager/snapshots
- You can rename snapshot file.
- Snapshot file dir:
- 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.
- 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 theInstall 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.
-
Currently, the system operates by cloning the git repository and sequentially installing the dependencies listed in requirements.txt using pip, followed by invoking the install.py script. In the future, we plan to discuss and determine the specifications for supporting custom nodes.
-
Please submit a pull request to update either the custom-node-list.json or model-list.json file.
-
The scanner currently provides a detection function for missing nodes, which is capable of detecting nodes described by the following two patterns.
- Or you can provide manually
node_list.json
file.
- Or you can provide manually
NODE_CLASS_MAPPINGS = {
"ExecutionSwitch": ExecutionSwitch,
"ExecutionBlocker": ExecutionBlocker,
...
}
NODE_CLASS_MAPPINGS.update({
"UniFormer-SemSegPreprocessor": Uniformer_SemSegPreprocessor,
"SemSegPreprocessor": Uniformer_SemSegPreprocessor,
})
- When you write a docstring in the header of the .py file for the Node as follows, it will be used for managing the database in the Manager.
- Currently, only the
nickname
is being used, but other parts will also be utilized in the future. - The
nickname
will be the name displayed on the badge of the node. - If there is no
nickname
, it will be truncated to 20 characters from the arbitrarily written title and used.
- Currently, only the
"""
@author: Dr.Lt.Data
@title: Impact Pack
@nickname: Impact Pack
@description: This extension offers various detector nodes and detailer nodes that allow you to configure a workflow that automatically enhances facial details. And provide iterative upscaler.
"""
- Special purpose files (optional)
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 automaticallyinstall.py
- When installing, it is automatically calleduninstall.py
- When uninstalling, it is automatically calleddisable.py
- When disabled, it is automatically called- When installing a custom node setup
.js
file, it is recommended to write this script for disabling.
- When installing a custom node setup
enable.py
- When enabled, it is automatically called- All scripts are executed from the root path of the corresponding custom node.
- When you click on the
Install Missing Custom Nodes
button in the menu, it displays a list of extension nodes that contain nodes not currently present in the workflow.
- If your
git.exe
is installed in a specific location other than system git, please install ComfyUI-Manager and run ComfyUI. Then, specify the path including the file name ingit_exe =
in the ComfyUI-Manager/config.ini file that is generated. - If updating ComfyUI-Manager itself fails, please go to the ComfyUI-Manager directory and execute the command
git update-ref refs/remotes/origin/main a361cc1 && git fetch --all && git pull
. - Alternatively, download the update-fix.py script from update-fix.py and place it in the ComfyUI-Manager directory. Then, run it using your Python command.
For the portable version, use
..\..\..\python_embeded\python.exe update-fix.py
. - For cases where nodes like
PreviewTextNode
fromComfyUI_Custom_Nodes_AlekPet
are only supported as front-end nodes, we currently do not provide missing nodes for them. - Currently,
vid2vid
is not being updated, causing compatibility issues.
- https://github.com/diontimmer/Sample-Diffusion-ComfyUI-Extension
- https://github.com/senshilabs/NINJA-plugin
- https://github.com/MockbaTheBorg/Nodes
- https://github.com/filliptm/ComfyUI_Fill-Nodes
- System displaying information about failed custom nodes import.
- Guide for missing nodes in ComfyUI vanilla nodes.
- Collision checking system for nodes with the same ID across extensions.
- Auto migration for custom nodes with changed structures.
- Version control feature for nodes.
- List of currently used custom nodes.
- Template sharing system.
- 3rd party API system.
- This extension simply provides the convenience of installing custom nodes and does not guarantee their proper functioning.