/comfyui

name: comfyui
description: "Generate images, video, and audio with ComfyUI — install, launch, manage nodes/models, run workflows with parameter injection. Uses the official comfy-cli for lifecycle and direct REST/WebSocket API for execution."
version: 5.0.0
author: [kshitijk4poor, alt-glitch]
license: MIT
platforms: [macos, linux, windows]
compatibility: "Requires ComfyUI (local, Comfy Desktop, or Comfy Cloud) and comfy-cli (auto-installed via pipx/uvx by the setup script)."
prerequisites:
  commands: ["python3"]
setup:
  help: "Run scripts/hardware_check.py FIRST to decide local vs Comfy Cloud; then scripts/comfyui_setup.sh auto-installs locally (or use Cloud API key for platform.comfy.org)."
metadata:
  hermes:
    tags:
      - comfyui
      - image-generation
      - stable-diffusion
      - flux
      - sd3
      - wan-video
      - hunyuan-video
      - creative
      - generative-ai
      - video-generation
    related_skills: [stable-diffusion-image-generation, image_gen]
    category: creative
origin: aggregated
source_license: MIT
source_repo: NousResearch/hermes-agent
source_url: https://github.com/NousResearch/hermes-agent/tree/main/skills/creative/comfyui
language: en

ComfyUI

Generate images, video, audio, and 3D content through ComfyUI using the official `comfy-cli` for setup/lifecycle and direct REST/WebSocket API for workflow execution.

What's in this skill

**Reference docs (`references/`):**

• `official-cli.md` — every `comfy ...` command, with flags
• `rest-api.md` — REST + WebSocket endpoints (local + cloud), payload schemas
• `workflow-format.md` — API-format JSON, common node types, param mapping

**Scripts (`scripts/`):**

| Script | Purpose | |--------|---------| | `_common.py` | Shared HTTP, cloud routing, node catalogs (don't run directly) | | `hardware_check.py` | Probe GPU/VRAM/disk → recommend local vs Comfy Cloud | | `comfyui_setup.sh` | Hardware check + comfy-cli + ComfyUI install + launch + verify | | `extract_schema.py` | Read a workflow → list controllable params + model deps | | `check_deps.py` | Check workflow against running server → list missing nodes/models | | `auto_fix_deps.py` | Run check_deps then `comfy node install` / `comfy model download` | | `run_workflow.py` | Inject params, submit, monitor, download outputs (HTTP or WS) | | `run_batch.py` | Submit a workflow N times with sweeps, parallel up to your tier | | `ws_monitor.py` | Real-time WebSocket viewer for executing jobs (live progress) | | `health_check.py` | Verification checklist runner — comfy-cli + server + models + smoke test | | `fetch_logs.py` | Pull traceback / status messages for a given prompt_id |

**Example workflows (`workflows/`):** SD 1.5, SDXL, Flux Dev, SDXL img2img, SDXL inpaint, ESRGAN upscale, AnimateDiff video, Wan T2V. See `workflows/README.md`.

When to Use

• User asks to generate images with Stable Diffusion, SDXL, Flux, SD3, etc.
• User wants to run a specific ComfyUI workflow file
• User wants to chain generative steps (txt2img → upscale → face restore)
• User needs ControlNet, inpainting, img2img, or other advanced pipelines
• User asks to manage ComfyUI queue, check models, or install custom nodes
• User wants video/audio/3D generation via AnimateDiff, Hunyuan, Wan, AudioCraft, etc.

Architecture: Two Layers

┌─────────────────────────────────────────────────────┐
│ Layer 1: comfy-cli (official lifecycle tool)        │
│   Setup, server lifecycle, custom nodes, models     │
│   → comfy install / launch / stop / node / model    │
└─────────────────────────┬───────────────────────────┘
                          │
┌─────────────────────────▼───────────────────────────┐
│ Layer 2: REST/WebSocket API + skill scripts         │
│   Workflow execution, param injection, monitoring   │
│   POST /api/prompt, GET /api/view, WS /ws           │
│   → run_workflow.py, run_batch.py, ws_monitor.py    │
└─────────────────────────────────────────────────────┘

**Why two layers?** The official CLI is excellent for installation and server management but has minimal workflow execution support. The REST/WS API fills that gap — the scripts handle param injection, execution monitoring, and output download that the CLI doesn't do.

Quick Start

Detect environment

# What's available?
command -v comfy >/dev/null 2>&1 && echo "comfy-cli: installed"
curl -s http://127.0.0.1:8188/system_stats 2>/dev/null && echo "server: running"

# Can this machine run ComfyUI locally? (GPU/VRAM/disk check)
python3 scripts/hardware_check.py

If nothing is installed, see **Setup & Onboarding** below — but always run the hardware check first.

One-line health check

python3 scripts/health_check.py
# → JSON: comfy_cli on PATH? server reachable? at least one checkpoint? smoke-test passes?

Core Workflow

Step 1: Get a workflow JSON in API format

Workflows must be in API format (each node has `class_type`). They come from:

• ComfyUI web UI → **Workflow → Export (API)** (newer UI) or

the legacy "Save (API Format)" button (older UI)

• This skill's `workflows/` directory (ready-to-run examples)
• Community downloads (civitai, Reddit, Discord) — usually editor format,

must be loaded into ComfyUI then re-exported

Editor format (top-level `nodes` and `links` arrays) is **not directly executable**. The scripts detect this and tell you to re-export.

Step 2: See what's controllable

python3 scripts/extract_schema.py workflow_api.json --summary-only
# → {"parameter_count": 12, "has_negative_prompt": true, "has_seed": true, ...}

python3 scripts/extract_schema.py workflow_api.json
# → full schema with parameters, model deps, embedding refs

Step 3: Run with parameters

# Local (defaults to http://127.0.0.1:8188)
python3 scripts/run_workflow.py \
  --workflow workflow_api.json \
  --args '{"prompt": "a beautiful sunset over mountains", "seed": -1, "steps": 30}' \
  --output-dir ./outputs

# Cloud (export API key on