From 1a47873de5a02c59e41295f3bba3ad18052758cf Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:50:03 +0000 Subject: [PATCH 1/7] Update manager/overview.mdx --- manager/overview.mdx | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 manager/overview.mdx diff --git a/manager/overview.mdx b/manager/overview.mdx new file mode 100644 index 00000000..4f944d50 --- /dev/null +++ b/manager/overview.mdx @@ -0,0 +1,37 @@ +--- +title: ComfyUI-Manager overview +description: An extension to manage custom nodes, models, and more in ComfyUI +--- + +**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. + +## Key features + +- **Custom node management**: Install, update, remove, and disable custom nodes +- **Model management**: Download and manage models from various sources +- **Snapshot management**: Save and restore installation states +- **Workflow sharing**: Share workflows to platforms like ComfyWorkflows, OpenArt, and YouML +- **Missing node detection**: Automatically detect and install missing nodes from workflows +- **Component sharing**: Share and import workflow components + +## Recent updates + + +**V3.38 Security patch**: Manager data migrated to protected path. See [Migration guide](/manager/configuration#paths) for details. + + +- **V3.16**: Support for `uv` package manager added. Set `use_uv` in `config.ini`. +- **V3.3.2**: Officially supports the [Comfy Registry](https://registry.comfy.org/). + +## Quick links + +- [Installation guide](/manager/installation) +- [How to use](/manager/usage) +- [Configuration](/manager/configuration) +- [CLI tools](/manager/cli) +- [Troubleshooting](/manager/troubleshooting) + +## Resources + +- [ComfyUI Nodes Info](https://ltdrdata.github.io/) - Browse all available nodes +- [Comfy Registry](https://registry.comfy.org/) - Official node registry From f2e56c23cfbc74140afcd870996f3fb6f2721576 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:50:19 +0000 Subject: [PATCH 2/7] Update manager/installation.mdx --- manager/installation.mdx | 91 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 manager/installation.mdx diff --git a/manager/installation.mdx b/manager/installation.mdx new file mode 100644 index 00000000..afa965b1 --- /dev/null +++ b/manager/installation.mdx @@ -0,0 +1,91 @@ +--- +title: Installation +description: How to install ComfyUI-Manager +--- + +## Prerequisites + +- Python 3 +- Git + +## Installation methods + +### Method 1: General installation (recommended) + +To install ComfyUI-Manager in addition to an existing installation of ComfyUI: + +1. Navigate to `ComfyUI/custom_nodes` directory in terminal +2. Clone the repository: + ```bash + git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager + ``` +3. Restart ComfyUI + +### Method 2: Portable ComfyUI version (Windows) + +1. Install [Git for Windows](https://git-scm.com/download/win) + - Use standalone version + - Select option: "use windows default console window" +2. Download [install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) into your `ComfyUI_windows_portable` directory + - Right-click the link and choose "Save As..." +3. Double-click `install-manager-for-portable-version.bat` + +### Method 3: Using comfy-cli (recommended) + +comfy-cli provides various features to manage ComfyUI from the CLI and installs both ComfyUI and ComfyUI-Manager at once. + + + + ```bash + python -m venv venv + venv\Scripts\activate + pip install comfy-cli + comfy install + ``` + + + ```bash + python -m venv venv + . venv/bin/activate + pip install comfy-cli + comfy install + ``` + + + +See also: [comfy-cli documentation](/comfy-cli/getting-started) + +### Method 4: Linux with venv + +Prerequisites: `python-is-python3`, `python3-venv`, `git` + +1. Download [install-comfyui-venv-linux.sh](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-comfyui-venv-linux.sh) into an empty install directory + - Right-click the link and choose "Save As..." +2. Make executable and run: + ```bash + 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. + +## Installation precautions + + +ComfyUI-Manager files must be accurately located in the path `ComfyUI/custom_nodes/comfyui-manager` + + +**Do not:** +- Decompress directly into `ComfyUI/custom_nodes` location, resulting in Manager contents like `__init__.py` being placed directly in that directory +- Install in a path like `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager` +- Install in a path like `ComfyUI/custom_nodes/ComfyUI-Manager-main` + +If installed incorrectly, ComfyUI-Manager may operate but won't be recognized for updates and poses the risk of duplicate installations. Remove it and install properly via `git clone` method. + +## Google Colab + +Use the [Colab notebook](https://colab.research.google.com/github/ltdrdata/ComfyUI-Manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb) to run ComfyUI with ComfyUI-Manager: + +- Supports installing ComfyUI +- Supports basic installation of ComfyUI-Manager +- Automatically installs dependencies of custom nodes upon restarting Colab notebooks From 9eca45202c447d9d6434ae07373dfce953a82b10 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:50:45 +0000 Subject: [PATCH 3/7] Update manager/usage.mdx --- manager/usage.mdx | 148 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 manager/usage.mdx diff --git a/manager/usage.mdx b/manager/usage.mdx new file mode 100644 index 00000000..ee395729 --- /dev/null +++ b/manager/usage.mdx @@ -0,0 +1,148 @@ +--- +title: How to use +description: Guide to using ComfyUI-Manager features +--- + +## Accessing the manager + +1. Click the **Manager** button on the main menu (top bar) + +## Installing custom nodes + +1. Click **Install Custom Nodes** from the Manager menu +2. Browse or search for the node you want to install +3. Click **Install** or **Try Install** + +### Installation status indicators + +- **Installed**: This item is already installed +- **Install**: Click to install the item +- **Try Install**: Installation information cannot be confirmed; click to attempt installation + +### Database modes + +There are three DB modes available: + +| Mode | Description | +|------|-------------| +| **DB: Channel (1day cache)** | Uses cached channel information with a one-day validity period. This is the **default** mode. | +| **DB: Local** | Uses information stored locally in ComfyUI-Manager. Updated only when you update ComfyUI-Manager. | +| **DB: Channel (remote)** | Retrieves information from the remote channel, always displaying the latest list. | + + +For custom node developers testing their nodes in `custom-node-list.json`, use the **Local** mode. + + +### Channel indicator + +If a red background **Channel** indicator appears at the top, it means you're not using the default channel. Many custom nodes may not appear in this state. + +### Conflicted nodes + +Nodes with a yellow background indicate conflicts with other extensions. Due to these conflicts, some nodes may not function correctly. + +## Installing models + +1. Click **Install Models** from the Manager menu +2. Browse or search for the model you want +3. Click **Install** + +## Updating custom nodes + +1. Click **Fetch Updates** to retrieve update data for custom nodes locally +2. Click **Update** button in the **Install Custom Nodes** menu to apply updates + +## Installing missing nodes + +When you load a workflow with missing nodes: + +1. Click **Install Missing Custom Nodes** from the Manager menu +2. A list of extension nodes containing the missing nodes will appear +3. Install the required extensions + +## Sharing workflows + +You can share workflows by: +- Clicking the **Share** button at the bottom of the main menu +- Selecting **Share Output** from the Context Menu of an Image node + +### Supported platforms + +- [ComfyWorkflows](https://comfyworkflows.com/) +- [OpenArt](https://openart.ai/workflows/dev) +- [YouML](https://youml.com) +- Matrix channel + +### Share settings + +Configure sharing behavior in Manager menu > Share settings: +- **None**: Hide from main menu +- **All**: Show a dialog where you can select a title for sharing + +## Snapshot manager + +Snapshots save your current installation status, allowing you to restore to a previous state. + +### Saving snapshots + +Snapshots are automatically saved when you: +- Press **Save snapshot** +- Use **Update All** on Manager Menu + +Snapshot files are stored in: `/default/ComfyUI-Manager/snapshots` + +### Restoring snapshots + +1. Open the Snapshot Manager +2. Select a snapshot +3. Press **Restore** + + +Restoration takes effect on the next ComfyUI startup. For custom nodes not managed by Git, snapshot support is incomplete. + + +## Component sharing + +### Copy and paste + +Components support JSON format for clipboard sharing: + +```json +{ + "kind": "ComfyUI Components", + "timestamp": , + "components": { + "": "" + } +} +``` + +Component names should be in the format `::`. + +### Drag and drop + +Drag and drop `.pack` or `.json` files to add components. + +### Component behavior + +- Dragging/pasting a single component adds a node +- Adding multiple components does not add nodes automatically + +## Additional features + +### Fix node (recreate) + +Right-click on a node and select **Fix node (recreate)** to recreate the node. Widget values are reset while connections with the same names are maintained. + +Use this to correct errors in nodes from old workflows that are incompatible with newer custom node versions. + +### Double-click node title + +Configure double-click behavior in the ComfyUI-Manager menu: + +| Option | Behavior | +|--------|----------| +| **Copy All Connections** | Copies connections of the nearest node (within 1000px). Existing output connections are disconnected. | +| **Copy Input Connections** | Copies only input connections of the nearest node. | +| **Possible Input Connections** | Connects all outputs that match the closest type from nodes on the left. | +| **Possible(left) + Copy(right)** | Left half of title: Possible Input Connections. Right half: Copy All Connections. | From ecc815a95e32da384e2ffeb3cdefe60effe0dd74 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:51:10 +0000 Subject: [PATCH 4/7] Update manager/configuration.mdx --- manager/configuration.mdx | 150 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 manager/configuration.mdx diff --git a/manager/configuration.mdx b/manager/configuration.mdx new file mode 100644 index 00000000..021f8ab6 --- /dev/null +++ b/manager/configuration.mdx @@ -0,0 +1,150 @@ +--- +title: Configuration +description: Configure ComfyUI-Manager settings and paths +--- + +## Paths + +Starting from V3.38, Manager uses a protected system path for enhanced security. + +### User directory + +- Default path: `ComfyUI/user` +- Can be set using `--user-directory ` + +### Manager path + +| ComfyUI Version | Manager Path | +|-----------------|--------------| +| v0.3.76+ (with System User API) | `/__manager/` | +| Older versions | `/default/ComfyUI-Manager/` | + +### Configuration files + +| File | Description | +|------|-------------| +| `config.ini` | Basic configuration | +| `channels.list` | Configurable channel lists | +| `pip_overrides.json` | Custom pip package mappings | +| `pip_blacklist.list` | Packages to prevent installation | +| `pip_auto_fix.list` | Packages to auto-restore | +| `snapshots/` | Saved snapshot files | +| `startup-scripts/` | Startup script files | +| `components/` | Component files | + +## Config.ini options + +Modify the `config.ini` file to apply settings. The path is displayed in startup log messages. + +```ini +[default] +git_exe = +use_uv = +default_cache_as_channel_url = +bypass_ssl = +file_logging = +windows_selector_event_loop_policy = +model_download_by_agent = +downgrade_blacklist = +security_level = +always_lazy_install = +network_mode = +``` + +### Network modes + +| Mode | Description | +|------|-------------| +| `public` | Standard public network environment | +| `private` | Closed network with private node DB configured via `channel_url` (uses cache if available) | +| `offline` | No external connections (uses cache if available) | + +## Extra model paths + +Configure in `extra_model_paths.yaml`. Settings are applied based on the section marked as `is_default`: + +- `custom_nodes`: Path for installing custom nodes +- `download_model_base`: Path for downloading models + +## Environment variables + +| Variable | Description | +|----------|-------------| +| `COMFYUI_PATH` | Installation path of ComfyUI | +| `GITHUB_ENDPOINT` | Reverse proxy for GitHub access | +| `HF_ENDPOINT` | Reverse proxy for Hugging Face access | + +### Examples + +**GitHub proxy:** +```bash +GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com +``` +Redirects `https://github.com/ltdrdata/ComfyUI-Impact-Pack` to `https://mirror.ghproxy.com/https://github.com/ltdrdata/ComfyUI-Impact-Pack` + +**Hugging Face proxy:** +```bash +HF_ENDPOINT=https://some-hf-mirror.com +``` +Changes `https://huggingface.co/path/to/somewhere` to `https://some-hf-mirror.com/path/to/somewhere` + +## Advanced configuration + +### Prevent package downgrades + +List package names in `downgrade_blacklist` in `config.ini`, separated by commas: + +```ini +downgrade_blacklist = diffusers, kornia +``` + +### Custom pip mapping + +Create `pip_overrides.json` to change installation of specific pip packages. Refer to `pip_overrides.json.template` for format. + +### Prevent pip package installation + +List package names one per line in `pip_blacklist.list`. + +### Auto-restore pip packages + +List pip spec requirements in `pip_auto_fix.list` (similar to `requirements.txt`). Packages are automatically restored when starting ComfyUI or when versions get mismatched. + +`--index-url` can be used. + +### Use aria2 as downloader + +See the [aria2 setup guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/use_aria2.md) for configuration. + +## Security policy + +Set security level in `config.ini`: + +```ini +security_level = +``` + +### Security levels + +| Level | Description | +|-------|-------------| +| `strong` | Doesn't allow high and middle level risky features | +| `normal` | Doesn't allow high level risky features; middle level available | +| `normal-` | Doesn't allow high level risky features if `--listen` is specified and not starts with `127.`; middle level available | +| `weak` | All features available | + +### Risk levels + +**High risk features:** +- Install via git URL, pip install +- Installation of custom nodes not in the default channel +- Fix custom nodes + +**Middle risk features:** +- Uninstall/Update +- Installation of custom nodes in the default channel +- Restore/Remove Snapshot +- Restart + +**Low risk features:** +- Update ComfyUI From 4372af42cd8f94d3eeda64cc7e501d25e8497924 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:51:12 +0000 Subject: [PATCH 5/7] Update manager/cli.mdx --- manager/cli.mdx | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 manager/cli.mdx diff --git a/manager/cli.mdx b/manager/cli.mdx new file mode 100644 index 00000000..a422258f --- /dev/null +++ b/manager/cli.mdx @@ -0,0 +1,21 @@ +--- +title: CLI tools +description: Command line tools for ComfyUI-Manager +--- + +## Overview + +ComfyUI-Manager provides `cm-cli`, a command line tool that allows you to use Manager features without running ComfyUI. + +This is useful for: +- Automating custom node installation +- Managing installations in headless environments +- Scripting ComfyUI setup + +## Documentation + +For detailed cm-cli documentation, see the [official cm-cli guide](https://github.com/ltdrdata/ComfyUI-Manager/blob/main/docs/en/cm-cli.md). + +## Related tools + +For a more comprehensive CLI experience, consider using [comfy-cli](/comfy-cli/getting-started), which provides additional features for managing ComfyUI installations. From 81aef991433c22619f1d27d1f4b75c3a8ec90495 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:51:27 +0000 Subject: [PATCH 6/7] Update manager/troubleshooting.mdx --- manager/troubleshooting.mdx | 93 +++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 manager/troubleshooting.mdx diff --git a/manager/troubleshooting.mdx b/manager/troubleshooting.mdx new file mode 100644 index 00000000..163aca4e --- /dev/null +++ b/manager/troubleshooting.mdx @@ -0,0 +1,93 @@ +--- +title: Troubleshooting +description: Common issues and solutions for ComfyUI-Manager +--- + +## Common issues + +### Custom git executable path + +If your `git.exe` is installed in a specific location other than system git: + +1. Install ComfyUI-Manager and run ComfyUI +2. Open `/default/ComfyUI-Manager/config.ini` +3. Specify the path including the file name in `git_exe =` + +### ComfyUI-Manager update fails + +If updating ComfyUI-Manager itself fails: + +1. Navigate to the **ComfyUI-Manager** directory +2. Run: + ```bash + git update-ref refs/remotes/origin/main a361cc1 && git fetch --all && git pull + ``` + +### Windows: Overlapped Object error + +If you encounter `Overlapped Object has pending operation at deallocation on ComfyUI Manager load`: + +Edit `config.ini` and add: +```ini +windows_selector_event_loop_policy = True +``` + +### SSL certificate verification failed + +If you encounter `SSL: CERTIFICATE_VERIFY_FAILED` error: + +Edit `config.ini` and add: +```ini +bypass_ssl = True +``` + +## File logging + +File logging is enabled by default. To disable: + +Edit `config.ini`: +```ini +file_logging = False +``` + +## Custom node support guide + + +You should no longer assume that the GitHub repository name will match the subdirectory name under `custom_nodes`. The subdirectory name now uses the normalized name from the `name` field in `pyproject.toml`. + + +Avoid relying on directory names for imports whenever possible. + +### Resources for developers + +- [Comfy Registry documentation](https://docs.comfy.org/registry/overview) +- [Comfy-Org RFCs](https://github.com/Comfy-Org/rfcs) + +### Special purpose files (optional) + +| File | Description | +|------|-------------| +| `pyproject.toml` | Spec file for comfyregistry | +| `node_list.json` | Manual list of nodes when NODE_CLASS_MAPPINGS pattern is non-conventional | +| `requirements.txt` | Pip requirements installed automatically | +| `install.py` | Script called automatically during installation | + + +All scripts are executed from the root path of the corresponding custom node. + + +## Registering custom nodes + +To register your custom node in ComfyUI-Manager: + +1. Add an entry to `custom-node-list.json` in the root of ComfyUI-Manager +2. Submit a Pull Request +3. Before submitting, check **Use local DB** and ensure the extension list loads without issues in the **Install custom nodes** dialog + + +Check for missing or extra commas that can lead to JSON syntax errors. + + +## Disclaimer + +This extension provides the convenience of installing custom nodes and does not guarantee their proper functioning. From 337895bcbe9857351df91f8c7b53ff41387a4468 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 17:51:51 +0000 Subject: [PATCH 7/7] Update docs.json --- docs.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs.json b/docs.json index 2f6b2b48..2f33fa62 100644 --- a/docs.json +++ b/docs.json @@ -89,6 +89,18 @@ } ] }, + { + "group": "ComfyUI-Manager", + "icon": "puzzle-piece", + "pages": [ + "manager/overview", + "manager/installation", + "manager/usage", + "manager/configuration", + "manager/cli", + "manager/troubleshooting" + ] + }, { "group": "Tutorials", "icon": "book",