ComfyUI/README.md
2025-12-26 15:36:44 -08:00

2.0 KiB

ComfyUI LTS

A vanilla, up-to-date fork of ComfyUI intended for long term support (LTS) from AppMana and Hidden Switch.

Quickstart (Linux)

UI Users

For users who want to run ComfyUI for generating images and videos.

  1. Install uv:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    
  2. Create a Workspace:

    mkdir comfyui-workspace
    cd comfyui-workspace
    
  3. Install and Run:

    # Create a virtual environment
    uv venv --python 3.12
    
    # Install ComfyUI LTS
    uv pip install --torch-backend=auto "comfyui@git+https://github.com/hiddenswitch/ComfyUI.git"
    
    # Run
    uv run comfyui
    

Developers

For developers contributing to the codebase or building on top of it.

  1. Clone the Repository:

    git clone https://github.com/hiddenswitch/ComfyUI.git
    cd ComfyUI
    
  2. Setup Environment:

    # Create virtual environment
    uv venv --python 3.12
    source .venv/bin/activate
    
    # Install in editable mode with dev dependencies
    uv pip install -e .[dev]
    
  3. Run:

    uv run comfyui
    

Documentation

Full documentation is available in docs/index.md.

Table of Contents