Skip to content

Commit ae3a525

Browse files
committed
update README.md
1 parent 44cead1 commit ae3a525

19 files changed

+27
-132
lines changed

README.md

Lines changed: 17 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,10 @@
22

33
**ComfyUI-Manager** is an extension designed to enhance the usability of [ComfyUI](https://github.com/comfyanonymous/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.
44

5-
![menu](misc/menu.jpg)
5+
![menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/dialog.jpg)
66

77
## NOTICE
8-
* V2.48.1: Security policy has been changed. Downloads of models in the list are allowed under the 'normal' security level.
9-
* V2.47: Security policy has been changed. The former 'normal' is now 'normal-', and 'normal' no longer allows high-risk features, even if your ComfyUI is local.
10-
* V2.37 Show a ✅ mark to accounts that have been active on GitHub for more than six months.
11-
* V2.33 Security policy is applied.
12-
* V2.21 [cm-cli](docs/en/cm-cli.md) tool is added.
13-
* V2.18 to V2.18.3 is not functioning due to a severe bug. Users on these versions are advised to promptly update to V2.18.4. Please navigate to the `ComfyUI/custom_nodes/ComfyUI-Manager` directory and execute `git pull` to update.
8+
* V3.3.2: Overhauled. Officially supports [https://comfyregistry.org/](https://comfyregistry.org/).
149
* You can see whole nodes info on [ComfyUI Nodes Info](https://ltdrdata.github.io/) page.
1510

1611
## Installation
@@ -20,7 +15,7 @@
2015
To install ComfyUI-Manager in addition to an existing installation of ComfyUI, you can follow the following steps:
2116

2217
1. goto `ComfyUI/custom_nodes` dir in terminal(cmd)
23-
2. `git clone https://github.com/ltdrdata/ComfyUI-Manager.git`
18+
2. `git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager`
2419
3. Restart ComfyUI
2520

2621

@@ -32,7 +27,7 @@ To install ComfyUI-Manager in addition to an existing installation of ComfyUI, y
3227
2. Download [scripts/install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) into installed `"ComfyUI_windows_portable"` directory
3328
3. double click `install-manager-for-portable-version.bat` batch file
3429

35-
![portable-install](misc/portable-install.png)
30+
![portable-install](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/portable-install.jpg)
3631

3732

3833
### Installation[method3] (Installation through comfy-cli: install ComfyUI and ComfyUI-Manager at once.)
@@ -68,15 +63,13 @@ To install ComfyUI with ComfyUI-Manager on Linux using a venv environment, you c
6863
3. `./install-comfyui-venv-linux.sh`
6964

7065
### Installation Precautions
71-
* **DO**: `ComfyUI-Manager` files must be accurately located in the path `ComfyUI/custom_nodes/ComfyUI-Manager`
66+
* **DO**: `ComfyUI-Manager` files must be accurately located in the path `ComfyUI/custom_nodes/comfyui-manager`
7267
* Installing in a compressed file format is not recommended.
7368
* **DON'T**: Decompress directly into the `ComfyUI/custom_nodes` location, resulting in the Manager contents like `__init__.py` being placed directly in that directory.
7469
* You have to remove all ComfyUI-Manager files from `ComfyUI/custom_nodes`
7570
* **DON'T**: In a form where decompression occurs in a path such as `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager`.
76-
* You have to move `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager` to `ComfyUI/custom_nodes/ComfyUI-Manager`
7771
* **DON'T**: In a form where decompression occurs in a path such as `ComfyUI/custom_nodes/ComfyUI-Manager-main`.
78-
* 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.
79-
* You have to rename `ComfyUI/custom_nodes/ComfyUI-Manager-main` to `ComfyUI/custom_nodes/ComfyUI-Manager`
72+
* 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.
8073

8174

8275
You can execute ComfyUI by running either `./run_gpu.sh` or `./run_cpu.sh` depending on your system configuration.
@@ -87,42 +80,17 @@ This repository provides Colab notebooks that allow you to install and use Comfy
8780
* Support for basic installation of ComfyUI-Manager
8881
* Support for automatically installing dependencies of custom nodes upon restarting Colab notebooks.
8982

90-
## Changes
91-
* **2.38** `Install Custom Nodes` menu is changed to `Custom Nodes Manager`.
92-
* **2.21** [cm-cli](docs/en/cm-cli.md) tool is added.
93-
* **2.4** Copy the connections of the nearest node by double-clicking.
94-
* **2.2.3** Support Components System
95-
* **0.29** Add `Update all` feature
96-
* **0.25** support db channel
97-
* You can directly modify the db channel settings in the `config.ini` file.
98-
* If you want to maintain a new DB channel, please modify the `channels.list` and submit a PR.
99-
* **0.23** support multiple selection
100-
* **0.18.1** `skip update check` feature added.
101-
* A feature that allows quickly opening windows in environments where update checks take a long time.
102-
* **0.17.1** Bug fix for the issue where enable/disable of the web extension was not working. Compatibility patch for StableSwarmUI.
103-
* Requires latest version of ComfyUI (Revision: 1240)
104-
* **0.17** Support preview method setting feature.
105-
* **0.14** Support robust update.
106-
* **0.13** Support additional 'pip' section for install spec.
107-
* **0.12** Better installation support for Windows.
108-
* **0.9** Support keyword search in installer menu.
109-
* **V0.7.1** Bug fix for the issue where updates were not being applied on Windows.
110-
* **For those who have been using versions 0.6, please perform a manual git pull in the custom_nodes/ComfyUI-Manager directory.**
111-
* **V0.7** To address the issue of a slow list refresh, separate the fetch update and update check processes.
112-
* **V0.6** Support extension installation for missing nodes.
113-
* **V0.5** Removed external git program dependencies.
114-
11583

11684
## How To Use
11785

11886
1. Click "Manager" button on main menu
11987

120-
![mainmenu](misc/main.jpg)
88+
![mainmenu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/topbar.jpg)
12189

12290

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

125-
![menu](misc/menu.jpg)
93+
![menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/dialog.jpg)
12694

12795
* There are three DB modes: `DB: Channel (1day cache)`, `DB: Local`, and `DB: Channel (remote)`.
12896
* `Channel (1day cache)` utilizes Channel cache information with a validity period of one day to quickly display the list.
@@ -138,9 +106,9 @@ This repository provides Colab notebooks that allow you to install and use Comfy
138106

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

141-
![node-install-dialog](misc/custom-nodes.jpg)
109+
![node-install-dialog](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/custom-nodes.jpg)
142110

143-
![model-install-dialog](misc/models.png)
111+
![model-install-dialog](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/models.jpg)
144112

145113
* Installed: This item is already installed.
146114
* Install: Clicking this button will install the item.
@@ -150,23 +118,15 @@ This repository provides Colab notebooks that allow you to install and use Comfy
150118
* Channel settings have a broad impact, affecting not only the node list but also all functions like "Update all."
151119
* 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.
152120

153-
4. If you set the `Badge:` item in the menu as `Badge: Nickname`, `Badge: Nickname (hide built-in)`, `Badge: #ID Nickname`, `Badge: #ID Nickname (hide built-in)` the information badge will be displayed on the node.
154-
* When selecting (hide built-in), it hides the 🦊 icon, which signifies built-in nodes.
155-
* Nodes without any indication on the badge are custom nodes that Manager cannot recognize.
156-
* `Badge: Nickname` displays the nickname of custom nodes, while `Badge: #ID Nickname` also includes the internal ID of the node.
157-
158-
![model-install-dialog](misc/nickname.jpg)
159-
160-
161-
5. Share
162-
![menu](misc/main.jpg) ![share](misc/share.jpg)
121+
4. Share
122+
![menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/topbar.jpg) ![share](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/share.jpg)
163123

164124
* 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.
165125
* Currently, it supports sharing via [https://comfyworkflows.com/](https://comfyworkflows.com/),
166126
[https://openart.ai](https://openart.ai/workflows/dev), [https://youml.com](https://youml.com)
167127
as well as through the Matrix channel.
168128

169-
![menu](misc/share-setting.jpg)
129+
![menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/share-setting.jpg)
170130

171131
* 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.
172132
* `None`: hide from Main menu
@@ -182,7 +142,7 @@ This repository provides Colab notebooks that allow you to install and use Comfy
182142
* When you press `Restore`, it will take effect on the next ComfyUI startup.
183143
* The selected snapshot file is saved in `ComfyUI-Manager/startup-scripts/restore-snapshot.json`, and upon restarting ComfyUI, the snapshot is applied and then deleted.
184144

185-
![model-install-dialog](misc/snapshot.jpg)
145+
![model-install-dialog](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/snapshot.jpg)
186146

187147

188148
## cm-cli: command line tools for power user
@@ -199,38 +159,7 @@ This repository provides Colab notebooks that allow you to install and use Comfy
199159

200160
## Custom node support guide
201161

202-
* 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.
203-
204-
* Please submit a pull request to update either the custom-node-list.json or model-list.json file.
205-
206-
* The scanner currently provides a detection function for missing nodes, which is capable of detecting nodes described by the following two patterns.
207-
208-
```
209-
NODE_CLASS_MAPPINGS = {
210-
"ExecutionSwitch": ExecutionSwitch,
211-
"ExecutionBlocker": ExecutionBlocker,
212-
...
213-
}
214-
215-
NODE_CLASS_MAPPINGS.update({
216-
"UniFormer-SemSegPreprocessor": Uniformer_SemSegPreprocessor,
217-
"SemSegPreprocessor": Uniformer_SemSegPreprocessor,
218-
})
219-
```
220-
* Or you can provide manually `node_list.json` file.
221-
222-
* 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.
223-
* Currently, only the `nickname` is being used, but other parts will also be utilized in the future.
224-
* The `nickname` will be the name displayed on the badge of the node.
225-
* If there is no `nickname`, it will be truncated to 20 characters from the arbitrarily written title and used.
226-
```
227-
"""
228-
@author: Dr.Lt.Data
229-
@title: Impact Pack
230-
@nickname: Impact Pack
231-
@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.
232-
"""
233-
```
162+
* https://docs.comfy.org/registry/overview
234163

235164

236165
* **Special purpose files** (optional)
@@ -281,11 +210,11 @@ NODE_CLASS_MAPPINGS.update({
281210
282211
## Support of missing nodes installation
283212
284-
![missing-menu](misc/missing-menu.jpg)
213+
![missing-menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/missing-dialog.jpg)
285214
286215
* 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.
287216
288-
![missing-list](misc/missing-list.jpg)
217+
![missing-list](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/missing-list.jpg)
289218
290219
291220
## Additional Feature
@@ -378,41 +307,6 @@ When you run the `scan.sh` script:
378307
* Update ComfyUI
379308
380309
381-
## TODO: Unconventional form of custom node list
382-
383-
* https://github.com/diontimmer/Sample-Diffusion-ComfyUI-Extension
384-
* https://github.com/senshilabs/NINJA-plugin
385-
* https://github.com/MockbaTheBorg/Nodes
386-
* https://github.com/StartHua/Comfyui_GPT_Story
387-
* https://github.com/NielsGercama/comfyui_customsampling
388-
* https://github.com/wrightdaniel2017/ComfyUI-VideoLipSync
389-
* https://github.com/bxdsjs/ComfyUI-Image-preprocessing
390-
* https://github.com/SMUELDigital/ComfyUI-ONSET
391-
* https://github.com/SimithWang/comfyui-renameImages
392-
* https://github.com/icefairy64/comfyui-model-tilt
393-
* https://github.com/andrewharp/ComfyUI-EasyNodes
394-
* https://github.com/SimithWang/comfyui-renameImages
395-
* https://github.com/Tcheko243/ComfyUI-Photographer-Alpha7-Nodes
396-
* https://github.com/Limbicnation/ComfyUINodeToolbox
397-
* https://github.com/APZmedia/ComfyUI-APZmedia-srtTools
398-
399-
## Roadmap
400-
401-
- [x] System displaying information about failed custom nodes import.
402-
- [x] Guide for missing nodes in ComfyUI vanilla nodes.
403-
- [x] Collision checking system for nodes with the same ID across extensions.
404-
- [x] Template sharing system. (-> Component system based on Group Nodes)
405-
- [x] 3rd party API system.
406-
- [ ] Auto migration for custom nodes with changed structures.
407-
- [ ] Version control feature for nodes.
408-
- [ ] List of currently used custom nodes.
409-
- [x] Download support multiple model download.
410-
- [x] Model download via url.
411-
- [x] List sorting (custom nodes).
412-
- [x] List sorting (model).
413-
- [ ] Provides description of node.
414-
415-
416310
# Disclaimer
417311
418312
* This extension simply provides the convenience of installing custom nodes and does not guarantee their proper functioning.

extras.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"comfyui-animatediff-evolved",
55
"comfyui_controlnet_aux",
66
"comfyui-impact-pack",
7+
"comfyui-impact-subpack",
78
"comfyui-custom-scripts",
89
"comfyui-layerdiffuse",
910
"comfyui-liveportraitkj",

glob/manager_core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
from node_package import InstalledNodePackage
3737

3838

39-
version_code = [3, 3, 1]
39+
version_code = [3, 3, 2]
4040
version_str = f"V{version_code[0]}.{version_code[1]}" + (f'.{version_code[2]}' if len(version_code) > 2 else '')
4141

4242

@@ -1661,7 +1661,7 @@ def git_repo_update_check_with(path, do_fetch=False, do_update=False, no_deps=Fa
16611661

16621662
# Check if the path is a git repository
16631663
if not os.path.exists(os.path.join(path, '.git')):
1664-
raise ValueError(f'Not a git repository: {path}')
1664+
raise ValueError(f'[ComfyUI-Manager] Not a valid git repository: {path}')
16651665

16661666
if platform.system() == "Windows":
16671667
updated, success = __win_check_git_update(path, do_fetch, do_update)

misc/custom-nodes.jpg

-160 KB
Binary file not shown.

misc/main.jpg

-31 KB
Binary file not shown.

misc/menu.jpg

-91 KB
Binary file not shown.

misc/missing-list.jpg

-170 KB
Binary file not shown.

misc/missing-menu.jpg

-129 KB
Binary file not shown.

misc/models.png

-164 KB
Binary file not shown.

misc/nickname.jpg

-182 KB
Binary file not shown.

0 commit comments

Comments
 (0)