Skip to main content

A CLI tool to install custom nodes for ComfyUI using YAML configuration.

Project description

Comfy Installer

Comfy Installer is a CLI tool that simplifies installing custom nodes and models for ComfyUI. It uses a YAML configuration to automate the setup, ensuring that all dependencies, custom nodes, and model files are installed correctly.

Features

  • Easy Custom Node Installation
    Install nodes from GitHub repositories, ZIP files, or direct file copy.

  • Automatic Model Download
    Fetches model files from URLs and places them into the correct ComfyUI directories.

  • YAML-Based Configuration
    Manage installations via a single YAML file, ensuring reproducible setups.

  • Workflow Integration
    The included ComfyRunner class can start ComfyUI, manage installations, and run workflows.

  • Lightweight & Extensible
    The tool is built with modular utilities, making it easy to customize or extend.

Requirements

  • Python 3.9+
  • pip or a similar package manager

Installation

From PyPI with uv

uv add comfy-installer

From Source

  1. Clone the repository:
    git clone https://github.com/yourusername/comfy-installer.git
    cd comfy-installer
    
  2. Install dependencies:
    uv run pip install -r requirements.txt
    
  3. (Optional) Install as a package:
    python setup.py install
    

Usage

1. Prepare a YAML File

Create a YAML file (e.g., config.yaml) with the nodes and models you want to install:

nodes:
  - name: "ComfyUI-AnimateDiff-Evolved"
    url: "https://github.com/Kosinkadink/ComfyUI-AnimateDiff-Evolved"
    install_type: "git-clone"

  - name: "ComfyUI-Advanced-ControlNet"
    url: "https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet"
    install_type: "git-clone"

models:
  - name: "sd_xl_base_18897557.0.safetensors"
    url: "https://civitai.com/api/download/models/299716"
    dest: "./ComfyUI/models/checkpoints/"

  - name: "mod_sdxl.safetensors"
    url: "https://civitai.com/api/download/models/299716"
    dest: "./ComfyUI/models/checkpoints/"

2. Run the Installer via CLI

comfy-install --yaml path/to/config.yaml [--install-dir /your/install/path]

Contributing

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature.
  3. Commit your changes: git commit -m 'Add feature'.
  4. Push to the branch: git push origin feature/your-feature.
  5. Open a pull request.

License

This project is licensed under the MIT License.

Support

For issues or feature requests, please open an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comfy_installer-0.1.9.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

comfy_installer-0.1.9-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file comfy_installer-0.1.9.tar.gz.

File metadata

  • Download URL: comfy_installer-0.1.9.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for comfy_installer-0.1.9.tar.gz
Algorithm Hash digest
SHA256 c2ef6a23ffeb130b4417845c73980b54c0b8ab64541badd38f15bbf109a73920
MD5 182dd14e388fbc8001e5a0ba34ef858a
BLAKE2b-256 b7b2480d1bec95ed1ca43871c47f228c4d0a95d98d5e91adb5d6a9f1d8ae339d

See more details on using hashes here.

Provenance

The following attestation bundles were made for comfy_installer-0.1.9.tar.gz:

Publisher: bump-version-release.yml on khengyun/comfy-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file comfy_installer-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for comfy_installer-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 51353069761ec6f9de4f64eb704b0f41431485793aacd946cdfd309fc6e1d890
MD5 94e0e8ae9bbdd59b3e70f64dff83583b
BLAKE2b-256 bf66435fcb352c74129eb085a17f324770089979d7eaff6b333361255eb272a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for comfy_installer-0.1.9-py3-none-any.whl:

Publisher: bump-version-release.yml on khengyun/comfy-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page