comfyui

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 once; uses correct /api routing automatically)
export COMFY_CLOUD_API_KEY="comfyui-..."
python3 scripts/run_workflow.py \
  --workflow workflow_api.json \
  --args '{"prompt": "..."}' \
  --host https://cloud.comfy.org \
  --output-dir ./outputs

# Real-time progress via WebSocket (requires `pip install websocket-client`)
python3 scripts/run_workflow.py \
  --workflow flux_dev.json \
  --args '{"prompt": "..."}' \
  --ws

# img2img / inpaint: pass --input-image to upload + reference automatically
python3 scripts/run_workflow.py \
  --workflow sdxl_img2img.json \
  --input-image image=./photo.png \
  --args '{"prompt": "make it watercolor", "denoise": 0.6}'

# Batch / sweep: 8 random seeds, parallel up to cloud tier limit
python3 scripts/run_batch.py \
  --workflow sdxl.json \
  --args '{"prompt": "abstract"}' \
  --count 8 --randomize-seed --parallel 3 \
  --output-dir ./outputs/batch

-1 for seed (or omitting it with --randomize-seed) generates a fresh random seed per run.

Step 4: Present results

The scripts emit JSON to stdout describing every output file:

{
  "status": "success",
  "prompt_id": "abc-123",
  "outputs": [
    {"file": "./outputs/sdxl_00001_.png", "node_id": "9",
     "type": "image", "filename": "sdxl_00001_.png"}
  ]
}

Decision Tree

| User says | Tool | Command | |-----------|------|---------| | Lifecycle (use comfy-cli) | | | | "install ComfyUI" | comfy-cli | bash scripts/comfyui_setup.sh | | "start ComfyUI" | comfy-cli | comfy launch --background | | "stop ComfyUI" | comfy-cli | comfy stop | | "install X node" | comfy-cli | comfy node install <name> | | "download X model" | comfy-cli | comfy model download --url <url> --relative-path models/checkpoints | | "list installed models" | comfy-cli | comfy model list | | "list installed nodes" | comfy-cli | comfy node show installed | | Execution (use scripts) | | | | "is everything ready?" | script | health_check.py (optionally with --workflow X --smoke-test) | | "what can I change in this workflow?" | script | extract_schema.py W.json | | "check if W's deps are met" | script | check_deps.py W.json | | "fix missing deps" | script | auto_fix_deps.py W.json | | "generate an image" | script | run_workflow.py --workflow W --args '{...}' | | "use this image" (img2img) | script | run_workflow.py --input-image image=./x.png ... | | "8 variations with random seeds" | script | run_batch.py --count 8 --randomize-seed ... | | "show me live progress" | script | ws_monitor.py --prompt-id <id> | | "fetch the error from job X" | script | fetch_logs.py <prompt_id> | | Direct REST | | | | "what's in the queue?" | REST | curl http://HOST:8188/queue (local) or --host https://cloud.comfy.org | | "cancel that" | REST | curl -X POST http://HOST:8188/interrupt | | "free GPU memory" | REST | curl -X POST http://HOST:8188/free |

Setup & Onboarding

When a user asks to set up ComfyUI, the FIRST thing to do is ask whether they want Comfy Cloud (hosted, zero install, API key) or Local (install ComfyUI on their machine). Don't start running install commands or hardware checks until they've answered.

Official docs: htt