### View Installed Custom Nodes (Simple)

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Use 'simple-show installed' to display a concise list of installed custom node names. This is useful for a quick overview.

```bash
python cm-cli.py simple-show installed
```

--------------------------------

### View Installed Custom Nodes (Detailed)

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Use 'show installed' to display detailed information about custom nodes that are currently installed. This includes their enabled/disabled status and author.

```bash
python cm-cli.py show installed
```

--------------------------------

### Run ComfyUI with localtunnel

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Installs localtunnel, then starts ComfyUI and exposes it via a public URL. This method is preferred for full functionality. It prints the public IP address for access.

```bash
!npm install -g localtunnel
```

```python
import subprocess
import threading
import time
import socket
import urllib.request

def iframe_thread(port):
  while True:
      time.sleep(0.5)
      sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
      result = sock.connect_ex(('127.0.0.1', port))
      if result == 0:
        break
      sock.close()
  print("\nComfyUI finished loading, trying to launch localtunnel (if it gets stuck here localtunnel is having issues)\n")

  print("The password/enpoint ip for localtunnel is:", urllib.request.urlopen('https://ipv4.icanhazip.com').read().decode('utf8').strip("\n"))
  p = subprocess.Popen(["lt", "--port", "{}".format(port)], stdout=subprocess.PIPE)
  for line in p.stdout:
    print(line.decode(), end='')


threading.Thread(target=iframe_thread, daemon=True, args=(8188,)).start()

!python main.py --dont-print-server
```

--------------------------------

### Install ComfyUI and Manager with comfy-cli (Linux/macOS)

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Recommended installation for Linux/macOS using comfy-cli. Requires Python 3 and Git. Activates a virtual environment and installs ComfyUI and the manager.

```bash
python -m venv venv
. venv/bin/activate
pip install comfy-cli
comfy install
```

--------------------------------

### Install ComfyUI and Manager with comfy-cli (Windows)

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Recommended installation for Windows using comfy-cli. Requires Python 3 and Git. Activates a virtual environment and installs ComfyUI and the manager.

```bash
python -m venv venv
venv\Scripts\activate
pip install comfy-cli
comfy install
```

--------------------------------

### Install ControlNet Preprocessor Nodes

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Clone the ControlNet preprocessor custom nodes repository and run the installation script. This adds preprocessing capabilities to ComfyUI.

```bash
#!cd custom_nodes && git clone https://github.com/Fannovel16/comfy_controlnet_preprocessors; cd comfy_controlnet_preprocessors && python install.py
```

--------------------------------

### Install Custom Nodes

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Install one or more custom nodes by specifying their names. The names correspond to their git repository names.

```bash
python cm-cli.py install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack ComfyUI_experiments
```

--------------------------------

### Install ComfyUI Manager via Git

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

General installation method for ComfyUI-Manager. Ensure you are in the ComfyUI/custom_nodes directory before cloning.

```bash
git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager
```

--------------------------------

### Environment Setup for ComfyUI

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Configures the Colab environment, optionally mounts Google Drive, clones and updates ComfyUI, and installs core dependencies. Ensure to set USE_GOOGLE_DRIVE to True if you want to persist your ComfyUI installation on Google Drive.

```python
# #@title Environment Setup

from pathlib import Path

OPTIONS = {}

USE_GOOGLE_DRIVE = True  #@param {type:"boolean"}
UPDATE_COMFY_UI = True  #@param {type:"boolean"}
USE_COMFYUI_MANAGER = True  #@param {type:"boolean"}
INSTALL_CUSTOM_NODES_DEPENDENCIES = True  #@param {type:"boolean"}
OPTIONS['USE_GOOGLE_DRIVE'] = USE_GOOGLE_DRIVE
OPTIONS['UPDATE_COMFY_UI'] = UPDATE_COMFY_UI
OPTIONS['USE_COMFYUI_MANAGER'] = USE_COMFYUI_MANAGER
OPTIONS['INSTALL_CUSTOM_NODES_DEPENDENCIES'] = INSTALL_CUSTOM_NODES_DEPENDENCIES

current_dir = !pwd
WORKSPACE = f"{current_dir[0]}/ComfyUI"

if OPTIONS['USE_GOOGLE_DRIVE']:
    !echo "Mounting Google Drive..."
    %cd /

    from google.colab import drive
    drive.mount('/content/drive')

    WORKSPACE = "/content/drive/MyDrive/ComfyUI"
    %cd /content/drive/MyDrive

![ ! -d $WORKSPACE ] && echo -= Initial setup ComfyUI =- && git clone https://github.com/comfyanonymous/ComfyUI
%cd $WORKSPACE

if OPTIONS['UPDATE_COMFY_UI']:
  !echo -= Updating ComfyUI =-

  # Correction of the issue of permissions being deleted on Google Drive.
  ![ -f ".ci/nightly/update_windows/update_comfyui_and_python_dependencies.bat" ] && chmod 755 .ci/nightly/update_windows/update_comfyui_and_python_dependencies.bat
  ![ -f ".ci/nightly/windows_base_files/run_nvidia_gpu.bat" ] && chmod 755 .ci/nightly/windows_base_files/run_nvidia_gpu.bat
  ![ -f ".ci/update_windows/update_comfyui_and_python_dependencies.bat" ] && chmod 755 .ci/update_windows/update_comfyui_and_python_dependencies.bat
  ![ -f ".ci/update_windows_cu118/update_comfyui_and_python_dependencies.bat" ] && chmod 755 .ci/update_windows_cu118/update_comfyui_and_python_dependencies.bat
  ![ -f ".ci/update_windows/update.py" ] && chmod 755 .ci/update_windows/update.py
  ![ -f ".ci/update_windows/update_comfyui.bat" ] && chmod 755 .ci/update_windows/update_comfyui.bat
  ![ -f ".ci/update_windows/README_VERY_IMPORTANT.txt" ] && chmod 755 .ci/update_windows/README_VERY_IMPORTANT.txt
  ![ -f ".ci/update_windows/run_cpu.bat" ] && chmod 755 .ci/update_windows/run_cpu.bat
  ![ -f ".ci/update_windows/run_nvidia_gpu.bat" ] && chmod 755 .ci/update_windows/run_nvidia_gpu.bat

  !git pull

!echo -= Install dependencies =-
!pip3 install accelerate
!pip3 install einops transformers>=4.28.1 safetensors>=0.4.2 aiohttp pyyaml Pillow scipy tqdm psutil tokenizers>=0.13.3
!pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121
!pip3 install torchsde
!pip3 install kornia>=0.7.1 spandrel soundfile sentencepiece

if OPTIONS['USE_COMFYUI_MANAGER']:
  %cd custom_nodes

  # Correction of the issue of permissions being deleted on Google Drive.
  ![ -f "ComfyUI-Manager/check.sh" ] && chmod 755 ComfyUI-Manager/check.sh
  ![ -f "ComfyUI-Manager/scan.sh" ] && chmod 755 ComfyUI-Manager/scan.sh
  ![ -f "ComfyUI-Manager/node_db/dev/scan.sh" ] && chmod 755 ComfyUI-Manager/node_db/dev/scan.sh
  ![ -f "ComfyUI-Manager/node_db/tutorial/scan.sh" ] && chmod 755 ComfyUI-Manager/node_db/tutorial/scan.sh
  ![ -f "ComfyUI-Manager/scripts/install-comfyui-venv-linux.sh" ] && chmod 755 ComfyUI-Manager/scripts/install-comfyui-venv-linux.sh
  ![ -f "ComfyUI-Manager/scripts/install-comfyui-venv-win.bat" ] && chmod 755 ComfyUI-Manager/scripts/install-comfyui-venv-win.bat

  ![ ! -d ComfyUI-Manager ] && echo -= Initial setup ComfyUI-Manager =- && git clone https://github.com/ltdrdata/ComfyUI-Manager
  %cd ComfyUI-Manager
  !git pull

%cd $WORKSPACE

if OPTIONS['INSTALL_CUSTOM_NODES_DEPENDENCIES']:
  !echo -= Install custom nodes dependencies =-
  !pip install GitPython
  !python custom_nodes/ComfyUI-Manager/cm-cli.py restore-dependencies

```

--------------------------------

### Install ComfyUI and Manager on Linux with venv

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Installation script for Linux environments using a Python virtual environment. Requires python-is-python3, python3-venv, and git. Make the script executable and run it.

```bash
chmod +x install-comfyui-venv-linux.sh
./install-comfyui-venv-linux.sh
```

--------------------------------

### Example custom_node_list.json Entry

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

This is an example of how to add an entry to the custom-node-list.json file to register a custom node with ComfyUI-Manager. Ensure JSON syntax is correct before submitting a Pull Request.

```json
{
  "custom_nodes": [
    {
      "name": "ComfyUI-Manager",
      "url": "https://github.com/comfyanonymous/ComfyUI-Manager.git",
      "branch": "main"
    }
  ]
}
```

--------------------------------

### Component Node Data Example

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Example of node data for a component, including version, datetime, packname, and category. This data is used when saving components to files.

```json
            "version":"1.0",
            "datetime": 1705390656516,
            "packname": "mypack",
            "category": "util/pipe"
```

--------------------------------

### Set COMFYUI_PATH environment variable

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Example of a warning message indicating that the COMFYUI_PATH environment variable is not set. The tool will attempt to infer the path relative to the ComfyUI-Manager installation.

```text
WARN: The `COMFYUI_PATH` environment variable is not set. Assuming `custom_nodes/ComfyUI-Manager/../../` as the ComfyUI path.
```

--------------------------------

### Prevent Downgrade Blacklist Example

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Specify packages to prevent from being downgraded by listing them, separated by commas, in the `downgrade_blacklist` section of the `config.ini` file.

```ini
downgrade_blacklist = diffusers, kornia
```

--------------------------------

### Custom Pip Mapping Configuration

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Create a `pip_overrides.json` file to define custom installation methods for specific pip packages. Refer to the template file for structure.

```json
{
  "package_name": "custom_install_command",
  "another_package": "another_command"
}
```

--------------------------------

### Docker Compose for aria2

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/use_aria2.md

An example `docker-compose.yml` file to set up and run an aria2-pro container. This configuration includes volume mappings for persistence and ports for RPC access.

```yaml
services:

  aria2:
    container_name: aria2
    image: p3terx/aria2-pro
    environment:
      - PUID=1000
      - PGID=1000
      - UMASK_SET=022
      - RPC_SECRET=__YOU_MUST_CHANGE_IT__
      - RPC_PORT=5080
      - DISK_CACHE=64M
      - IPV6_MODE=false
      - UPDATE_TRACKERS=false
      - CUSTOM_TRACKER_URL=
    volumes:
      - ./config:/config
      - ./downloads:/downloads
      - ~/ComfyUI/models:/models
      - ~/ComfyUI/custom_nodes:/custom_nodes
    ports:
      - 6800:6800
    restart: unless-stopped
    logging:
      driver: json-file
      options:
        max-size: 1m
```

--------------------------------

### Displaying ComfyUI and Manager Paths

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/v3.38-userdata-security-migration.md

When ComfyUI starts, it logs the full paths for the user directory and the ComfyUI-Manager configuration. These lines are crucial for locating your data on the system.

```text
** User directory: /path/to/ComfyUI/user
** ComfyUI-Manager config path: /path/to/ComfyUI/user/__manager/config.ini
```

--------------------------------

### Run ComfyUI with Cloudflared Tunnel

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

This script downloads and installs cloudflared, then launches ComfyUI and creates a secure tunnel for remote access. It prints the public URL once available.

```python
!wget -P ~ https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64.deb
!dpkg -i ~/cloudflared-linux-amd64.deb

import subprocess
import threading
import time
import socket
import urllib.request

def iframe_thread(port):
  while True:
      time.sleep(0.5)
      sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
      result = sock.connect_ex(('127.0.0.1', port))
      if result == 0:
        break
      sock.close()
  print("\nComfyUI finished loading, trying to launch cloudflared (if it gets stuck here cloudflared is having issues)\n")

  p = subprocess.Popen(["cloudflared", "tunnel", "--url", "http://127.0.0.1:{}".format(port)], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
  for line in p.stderr:
    l = line.decode()
    if "trycloudflare.com " in l:
      print("This is the URL to access ComfyUI:", l[l.find("http"):], end='')
    #print(l, end='')


threading.Thread(target=iframe_thread, daemon=True, args=(8188,)).start()

!python main.py --dont-print-server
```

--------------------------------

### Save Current Snapshot

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Saves the current state of installed custom nodes as a snapshot. The snapshot can be saved to a specified file path and format (.json/.yaml).

```bash
python cm-cli.py save-snapshot --output snapshot.yaml
```

--------------------------------

### Run ComfyUI with Colab iframe

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Starts ComfyUI and embeds the UI in a Colab iframe for direct viewing within the notebook. Note that some features like live image previews may not work due to iframe limitations.

```python
import threading
import time
import socket
def iframe_thread(port):
  while True:
      time.sleep(0.5)
      sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
      result = sock.connect_ex(('127.0.0.1', port))
      if result == 0:
        break
      sock.close()
  from google.colab import output
  output.serve_kernel_port_as_iframe(port, height=1024)
  print("to open it in a window you can open this link here:")
  output.serve_kernel_port_as_window(port)

threading.Thread(target=iframe_thread, daemon=True, args=(8188,)).start()

!python main.py --dont-print-server
```

--------------------------------

### Pip Auto Fix Requirements

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

List pip requirements in `pip_auto_fix.list` to automatically restore specified versions upon ComfyUI startup or when custom node installations cause version mismatches. Supports `--index-url`.

```text
package_name==1.2.3
another_package>=2.0.0 --index-url https://example.com/pypi/simple
```

--------------------------------

### Custom Node List Schema

Source: https://github.com/comfy-org/comfyui-manager/blob/main/node_db/README.md

Defines the structure for custom node metadata, including display name, repository, source files, installation type, dependencies, and tags.

```json
{
  "custom_nodes": [
    {
      "title": "Node display name",
      "name": "Repository name",
      "reference": "Original repository if forked",
      "files": ["GitHub URL or other source location"],
      "install_type": "git",
      "description": "Description of the node's functionality",
      "pip": ["optional pip dependencies"],
      "js": ["optional JavaScript files"],
      "tags": ["categorization tags"]
    }
  ]
}
```

--------------------------------

### Configure Git Executable Path

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Specify the path to your git.exe executable in the ComfyUI-Manager config.ini file if it's not in the system's default PATH. This is required for ComfyUI-Manager to function correctly on Windows with custom git installations.

```ini
git_exe = <USER_DIRECTORY>/default/ComfyUI-Manager/config.ini
```

--------------------------------

### Execute CLI with portable Python

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Command to run the cm-cli.py script using the embedded Python interpreter found in portable ComfyUI installations. Ensure you are in the directory containing the run_nvidia_gpu.bat file.

```bash
.\python_embeded\python.exe ComfyUI\custom_nodes\ComfyUI-Manager\cm-cli.py update all
```

--------------------------------

### Update all nodes with remote channel and mode

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

This command updates all custom nodes using the latest information from the remote repository and targets only the nodes listed in the 'recent' channel. This option is available for commands like 'simple-show', 'show', 'install', 'uninstall', 'update', 'disable', 'enable', and 'fix'.

```bash
python cm-cli.py update all --channel recent --mode remote
```

--------------------------------

### ComfyUI-Manager Configuration Options

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Modify the config.ini file to customize ComfyUI-Manager settings. Options include git executable path, dependency installation methods, SSL bypass, logging, and network modes.

```ini
[default]
git_exe = <Manually specify the path to the git executable. If left empty, the default git executable path will be used.>
use_uv = <Use uv instead of pip for dependency installation.>
default_cache_as_channel_url = <Determines whether to retrieve the DB designated as channel_url at startup>
bypass_ssl = <Set to True if SSL errors occur to disable SSL.>
file_logging = <Configure whether to create a log file used by ComfyUI-Manager.>
windows_selector_event_loop_policy = <If an event loop error occurs on Windows, set this to True.>
model_download_by_agent = <When downloading models, use an agent instead of torchvision_download_url.>
downgrade_blacklist = <Set a list of packages to prevent downgrades. List them separated by commas.>
security_level = <Set the security level => strong|normal|normal-|weak>
always_lazy_install = <Whether to perform dependency installation on restart even in environments other than Windows.>
network_mode = <Set the network mode => public|private|offline>
```

--------------------------------

### Download GLIGEN Model

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download the GLIGEN text-to-bounding-box model. This model allows for text-conditioned object placement.

```bash
#!wget -c https://huggingface.co/comfyanonymous/GLIGEN_pruned_safetensors/resolve/main/gligen_sd14_textbox_pruned_fp16.safetensors -P ./models/gligen/
```

--------------------------------

### Download ESRGAN Upscale Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download various Real-ESRGAN models for upscaling images. These models offer different scaling factors and quality levels.

```bash
#!wget -c https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth -P ./models/upscale_models/
```

```bash
#!wget -c https://huggingface.co/sberbank-ai/Real-ESRGAN/resolve/main/RealESRGAN_x2.pth -P ./models/upscale_models/
```

```bash
#!wget -c https://huggingface.co/sberbank-ai/Real-ESRGAN/resolve/main/RealESRGAN_x4.pth -P ./models/upscale_models/
```

--------------------------------

### Download ControlNet Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Use wget to download various ControlNet models to the specified directory. Ensure the target directory exists before running.

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11e_sd15_ip2p_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11e_sd15_shuffle_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_canny_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11f1p_sd15_depth_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_inpaint_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_lineart_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_mlsd_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_normalbae_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_openpose_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_scribble_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_seg_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15_softedge_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11p_sd15s2_lineart_anime_fp16.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/comfyanonymous/ControlNet-v1-1_fp16_safetensors/resolve/main/control_v11u_sd15_tile_fp16.safetensors -P ./models/controlnet/
```

--------------------------------

### Download SD1.5 Anime Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Use these commands to download Stable Diffusion 1.5 anime-style models. Ensure the target directory `./models/checkpoints/` exists.

```shell
#!wget -c https://huggingface.co/WarriorMama777/OrangeMixs/resolve/main/Models/AbyssOrangeMix2/AbyssOrangeMix2_hard.safetensors -P ./models/checkpoints/
```

```shell
#!wget -c https://huggingface.co/WarriorMama777/OrangeMixs/resolve/main/Models/AbyssOrangeMix3/AOM3A1_orangemixs.safetensors -P ./models/checkpoints/
```

```shell
#!wget -c https://huggingface.co/WarriorMama777/OrangeMixs/resolve/main/Models/AbyssOrangeMix3/AOM3A3_orangemixs.safetensors -P ./models/checkpoints/
```

```shell
#!wget -c https://huggingface.co/Linaqruf/anything-v3.0/resolve/main/anything-v3-fp16-pruned.safetensors -P ./models/checkpoints/
```

--------------------------------

### cm-cli Help Output

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Displays the available commands and options for the ComfyUI-Manager CLI. Use this to understand the syntax for various operations.

```bash
python cm-cli.py [OPTIONS]

OPTIONS:
    [install|reinstall|uninstall|update|disable|enable|fix] node_name ... ?[--channel <channel name>] ?[--mode [remote|local|cache]]
    [update|disable|enable|fix] all ?[--channel <channel name>] ?[--mode [remote|local|cache]]
    [simple-show|show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list] ?[--channel <channel name>] ?[--mode [remote|local|cache]]
    save-snapshot ?[--output <snapshot .json/.yaml>]
    restore-snapshot <snapshot .json/.yaml> ?[--pip-non-url] ?[--pip-non-local-url] ?[--pip-local-url]
    cli-only-mode [enable|disable]
    restore-dependencies
    clear
```

--------------------------------

### Download T2I-Adapter Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download T2I-Adapter models for controlling image generation based on various inputs like depth, segmentation, or pose. These are saved in the `./models/controlnet/` directory.

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_depth_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_seg_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_sketch_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_keypose_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_openpose_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_color_sd14v1.pth -P ./models/controlnet/
```

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_canny_sd14v1.pth -P ./models/controlnet/
```

--------------------------------

### Download ControlNet SDXL Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download ControlNet LoRA models for SDXL. These are typically smaller and used for fine-tuning specific aspects.

```bash
#!wget -c https://huggingface.co/stabilityai/control-lora/resolve/main/control-LoRAs-rank256/control-lora-canny-rank256.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/stabilityai/control-lora/resolve/main/control-LoRAs-rank256/control-lora-depth-rank256.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/stabilityai/control-lora/resolve/main/control-LoRAs-rank256/control-lora-recolor-rank256.safetensors -P ./models/controlnet/
```

```bash
#!wget -c https://huggingface.co/stabilityai/control-lora/resolve/main/control-LoRAs-rank256/control-lora-sketch-rank256.safetensors -P ./models/controlnet/
```

--------------------------------

### Download VAE Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download Variational Autoencoder (VAE) models. These are crucial for improving image quality and are saved in the `./models/vae/` directory.

```shell
!wget -c https://huggingface.co/stabilityai/sd-vae-ft-mse-original/resolve/main/vae-ft-mse-840000-ema-pruned.safetensors -P ./models/vae/
```

```shell
#!wget -c https://huggingface.co/WarriorMama777/OrangeMixs/resolve/main/VAEs/orangemix.vae.pt -P ./models/vae/
```

```shell
#!wget -c https://huggingface.co/hakurei/waifu-diffusion-v1-4/resolve/main/vae/kl-f8-anime2.ckpt -P ./models/vae/
```

--------------------------------

### Download T2I Styles Model

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download the T2I-Adapter style model, used for style transfer in image generation. It is saved to the `./models/style_models/` directory.

```shell
#!wget -c https://huggingface.co/TencentARC/T2I-Adapter/resolve/main/models/t2iadapter_style_sd14v1.pth -P ./models/style_models/
```

--------------------------------

### Download ComfyUI Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Downloads various Stable Diffusion models and checkpoints. Uncomment the wget commands for the specific models you wish to download and place them in the appropriate subdirectories within the 'models' folder.

```bash
# Checkpoints

### SDXL
### I recommend these workflow examples: https://comfyanonymous.github.io/ComfyUI_examples/sdxl/

#!wget -c https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors -P ./models/checkpoints/
#!wget -c https://huggingface.co/stabilityai/stable-diffusion-xl-refiner-1.0/resolve/main/sd_xl_refiner_1.0.safetensors -P ./models/checkpoints/

# SDXL ReVision
#!wget -c https://huggingface.co/comfyanonymous/clip_vision_g/resolve/main/clip_vision_g.safetensors -P ./models/clip_vision/

# SD1.5
!wget -c https://huggingface.co/runwayml/stable-diffusion-v1-5/resolve/main/v1-5-pruned-emaonly.ckpt -P ./models/checkpoints/

# SD2
#!wget -c https://huggingface.co/stabilityai/stable-diffusion-2-1-base/resolve/main/v2-1_512-ema-pruned.safetensors -P ./models/checkpoints/
#!wget -c https://huggingface.co/stabilityai/stable-diffusion-2-1/resolve/main/v2-1_768-ema-pruned.safetensors -P ./models/checkpoints/

```

--------------------------------

### Download Waifu Diffusion 1.5 Model

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download the Waifu Diffusion 1.5 model for anime-style generation. The model is saved to the `./models/checkpoints/` directory.

```shell
#!wget -c https://huggingface.co/waifu-diffusion/wd-1-5-beta3/resolve/main/wd-illusion-fp16.safetensors -P ./models/checkpoints/
```

--------------------------------

### ComfyUI Manager File Structure Reference

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/v3.38-userdata-security-migration.md

Overview of the directory structure for ComfyUI Manager, including configuration, custom node channels, snapshots, and backup files.

```tree
user/
└── __manager/
    ├── config.ini              # Manager configuration
    ├── channels.list           # Custom node channels
    ├── snapshots/              # Environment snapshots
    └── .legacy-manager-backup/ # Backup of old Manager data (temporary)
```

--------------------------------

### Download LoRA Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download Low-Rank Adaptation (LoRA) models, which are used to fine-tune existing models. They are saved to the `./models/loras/` directory.

```shell
#!wget -c https://civitai.com/api/download/models/10350 -O ./models/loras/theovercomer8sContrastFix_sd21768.safetensors #theovercomer8sContrastFix SD2.x 768-v
```

```shell
#!wget -c https://civitai.com/api/download/models/10638 -O ./models/loras/theovercomer8sContrastFix_sd15.safetensors #theovercomer8sContrastFix SD1.x
```

```shell
#!wget -c https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_offset_example-lora_1.0.safetensors -P ./models/loras/ #SDXL offset noise lora
```

--------------------------------

### Download unCLIP Models

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download unCLIP models, which are used for specific generation tasks. Files are saved to `./models/checkpoints/`.

```shell
#!wget -c https://huggingface.co/comfyanonymous/illuminatiDiffusionV1_v11_unCLIP/resolve/main/illuminatiDiffusionV1_v11-unclip-h-fp16.safetensors -P ./models/checkpoints/
```

```shell
#!wget -c https://huggingface.co/comfyanonymous/wd-1-5-beta2_unCLIP/resolve/main/wd-1-5-beta2-aesthetic-unclip-h-fp16.safetensors -P ./models/checkpoints/
```

--------------------------------

### Download CLIPVision Model

Source: https://github.com/comfy-org/comfyui-manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb

Download the CLIPVision model, which is required for the T2I-Adapter styles model. The model is saved as `clip_vit14.bin` in the `./models/clip_vision/` directory.

```shell
#!wget -c https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/pytorch_model.bin -O ./models/clip_vision/clip_vit14.bin
```

--------------------------------

### Configure Hugging Face Endpoint Environment Variable

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Use this environment variable to redirect Hugging Face requests through a mirror or proxy. This is useful in environments with limited access to Hugging Face.

```bash
HF_ENDPOINT=https://some-hf-mirror.com 
```

--------------------------------

### Enable Windows Selector Event Loop Policy

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Add 'windows_selector_event_loop_policy = True' to config.ini to resolve the 'Overlapped Object has pending operation at deallocation' error on Windows.

```ini
windows_selector_event_loop_policy = True
```

--------------------------------

### Update all custom nodes (from ComfyUI directory)

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Specifies the path to cm-cli.py when executing the update all command from the ComfyUI directory.

```bash
python custom_nodes/ComfyUI-Manager/cm-cli.py update all
```

--------------------------------

### Configure GitHub Endpoint Environment Variable

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Use this environment variable to redirect GitHub requests through a mirror or proxy. This is useful in environments with limited access to GitHub.

```bash
GITHUB_ENDPOINT=https://mirror.ghproxy.com/https://github.com
```

--------------------------------

### Configure Security Level in config.ini

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/v3.38-userdata-security-migration.md

Edit the `user/__manager/config.ini` file to set the desired security level. `normal` is the default and recommended for most users.

```ini
[default]
security_level = normal
```

--------------------------------

### Restore Snapshot

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Restores the custom nodes configuration from a specified snapshot file. If the file is not found, it defaults to looking in the ComfyUI-Manager/snapshots directory.

```bash
python cm-cli.py restore-snapshot snapshot.yaml
```

--------------------------------

### Bypass SSL Certificate Verification

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Add 'bypass_ssl = True' to config.ini to bypass SSL certificate verification. Use this if you encounter 'SSL: CERTIFICATE_VERIFY_FAILED' errors.

```ini
bypass_ssl = True
```

--------------------------------

### Configure Security Level

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Set the 'security_level' in config.ini to control which features are allowed. Options include 'strong', 'normal', 'normal-', and 'weak', each with different restrictions on risky features.

```ini
security_level = <LEVEL>
```

--------------------------------

### Update all custom nodes

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/cm-cli.md

Execute this command from the ComfyUI-Manager directory to update all custom nodes. If running from the ComfyUI directory, specify the path to cm-cli.py.

```bash
python cm-cli.py update all
```

--------------------------------

### Legacy Backup Notification

Source: https://github.com/comfy-org/comfyui-manager/blob/main/docs/en/v3.38-userdata-security-migration.md

ComfyUI-Manager notifies you on every startup if a legacy backup exists, reminding you to verify and manually remove it when no longer needed.

```text
----------------------------------------------------------------------
[ComfyUI-Manager] NOTICE: Legacy backup exists
  - Your old Manager data was backed up to:
      /path/to/ComfyUI/user/__manager/.legacy-manager-backup
  - Please verify and remove it when no longer needed.
----------------------------------------------------------------------
```

--------------------------------

### Set GitHub Token Environment Variable

Source: https://github.com/comfy-org/comfyui-manager/blob/main/README.md

Set the GITHUB_TOKEN environment variable to avoid hitting GitHub API rate limits when the scanner script updates github-stats.json. This is recommended for frequent use.

```bash
export GITHUB_TOKEN=your_token_here
```

--------------------------------

### Extension Node Map Schema

Source: https://github.com/comfy-org/comfyui-manager/blob/main/node_db/README.md

Maps extension identifiers to lists of node classes they provide, along with author information and optional node name patterns.

```json
{
  "extension-id": [
    ["list", "of", "node", "classes"],
    {
      "author": "Author name",
      "description": "Extension description",
      "nodename_pattern": "Optional regex pattern for node name matching"
    }
  ]
}
```