README.md

April 13, 2026 · View on GitHub

ComfyUI Skill CLI

Agent-friendly command-line tool for managing and executing ComfyUI workflow skills.

Any AI agent that can run shell commands (Claude Code, Codex, OpenClaw, etc.) can use ComfyUI through this CLI.

PyPI License Python 3.10+ GitHub stars

Install · Quick Start · Commands · For AI Agents

English · 简体中文 · 繁體中文 · 日本語 · 한국어 · Español


Why comfyui-skill?

CapabilityWhy it matters
Agent-nativeStructured JSON output, pipe-friendly, designed for AI agents to call
Zero configReads config.json and data/ from the current directory, no setup needed
Full lifecycleDiscover, import, execute, cancel, manage workflows and dependencies in one tool
Multi-serverManage multiple ComfyUI instances, route jobs to different hardware
Model discoveryInspect model folders and available model names directly from the target server
Workflow fleet managementImport, enable, disable, delete, and migrate multiple workflows across machines
Error guidanceCommon failures (OOM, unauthorized, missing models) return actionable hints

Install

pipx install comfyui-skill-cli

Or with pip:

pip install comfyui-skill-cli

Update

pipx upgrade comfyui-skill-cli

Development Mode

git clone https://github.com/HuangYuChuh/ComfyUI_Skill_CLI.git
cd ComfyUI_Skill_CLI
pipx install -e .

Quick Start

# 1. Go to your ComfyUI Skills project directory
cd /path/to/your-skills-project

# 2. Check server status
comfyui-skill server status

# 3. List available workflows
comfyui-skill list

# 4. Execute a workflow
comfyui-skill run local/txt2img --args '{"prompt": "a white cat"}'

Every command supports --json for structured output.

ID Convention

Workflows are addressed as <server_id>/<workflow_id>:

comfyui-skill run local/txt2img          # explicit server
comfyui-skill run txt2img                # uses default server
comfyui-skill run txt2img -s my_server   # override with --server flag

Commands

Workflow Discovery & Execution

CommandDescription
comfyui-skill listList all available workflows with parameters
comfyui-skill info <id>Show workflow details and parameter schema
comfyui-skill run <id> --args '{...}'Execute a workflow (blocking, real-time WebSocket streaming)
comfyui-skill run <id> --validateValidate workflow without executing
comfyui-skill submit <id> --args '{...}'Submit a workflow (non-blocking)
comfyui-skill status <prompt_id>Check execution status and show discovered results
comfyui-skill cancel <prompt_id>Cancel a running or queued job
comfyui-skill upload <file>Upload a file to ComfyUI for use in workflows
comfyui-skill upload <file> --maskUpload a mask image for inpainting workflows
comfyui-skill upload --from-output <prompt_id>Chain a previous run's output as input for the next workflow

Queue & Resource Management

CommandDescription
comfyui-skill queue listShow running and pending jobs
comfyui-skill queue clearClear all pending jobs
comfyui-skill queue delete <prompt_id>...Remove specific jobs from queue
comfyui-skill freeRelease GPU memory and unload models
comfyui-skill free --modelsUnload models only
comfyui-skill free --memoryFree cached memory only

Node & Model Discovery

CommandDescription
comfyui-skill nodes listList all available ComfyUI nodes by category
comfyui-skill nodes info <class>Show node input/output schema
comfyui-skill nodes search <query>Search nodes by name or category
comfyui-skill models listList all available model folders
comfyui-skill models list <folder>List models in a specific folder (e.g., checkpoints, loras)

Workflow Management

CommandDescription
comfyui-skill workflow import <path>Import workflow (auto-detect format, auto-generate schema)
comfyui-skill workflow import --from-serverImport one or more workflows from ComfyUI server userdata
comfyui-skill workflow enable <id>Enable a workflow
comfyui-skill workflow disable <id>Disable a workflow
comfyui-skill workflow delete <id>Delete a workflow

Server Management

CommandDescription
comfyui-skill server listList all configured servers
comfyui-skill server statusCheck if ComfyUI server is online
comfyui-skill server statsShow VRAM, RAM, GPU info (--all for multi-server)
comfyui-skill server add --id <id> --url <url>Add a new server
comfyui-skill server enable/disable <id>Toggle server availability
comfyui-skill server remove <id>Remove a server

Dependency Management

CommandDescription
comfyui-skill deps check <id>Check missing custom nodes and models
comfyui-skill deps install <id> --allAuto-detect and install all missing deps
comfyui-skill deps install <id> --repos '[...]'Install specific custom nodes
comfyui-skill deps install <id> --modelsInstall missing models via Manager

Configuration & History

CommandDescription
comfyui-skill config export --output <path>Export config and workflows as bundle
comfyui-skill config import <path>Import config bundle (supports --dry-run)
comfyui-skill history list <id>List execution history
comfyui-skill history show <id> <run_id>Show details of a specific run
comfyui-skill jobs listList server-side job history (--status to filter)
comfyui-skill jobs show <prompt_id>Show details of a specific job
comfyui-skill logs showShow recent ComfyUI server logs
comfyui-skill templates listList workflow templates from custom nodes
comfyui-skill templates subgraphsList reusable subgraph components

Global Options

OptionDescription
--json, -jForce JSON output
--output-formatOutput format: text, json, stream-json
--server, -sSpecify server ID
--dir, -dSpecify data directory (default: current directory)
--verbose, -vVerbose output
--no-update-checkSkip automatic CLI update check

Output Modes

ModeWhenFormat
TextTTY terminalRich tables and progress bars
JSONPipe or --jsonSingle JSON result
Stream JSON--output-format stream-jsonNDJSON events in real time
ErrorsAlwaysstderr

Common Management Tasks

Inspect models on a server

comfyui-skill models list
comfyui-skill models list checkpoints
comfyui-skill models list loras

Use this when you need to confirm model names before wiring them into a workflow or schema.

Manage multiple workflows

# Preview workflows available in ComfyUI server userdata
comfyui-skill workflow import --from-server --preview

# Import matching workflows from the server
comfyui-skill workflow import --from-server --name sdxl

# Temporarily disable or re-enable a workflow
comfyui-skill workflow disable local/old-flow
comfyui-skill workflow enable local/old-flow

# Remove a workflow you no longer want to expose
comfyui-skill workflow delete local/old-flow

Move workflow bundles between machines

comfyui-skill config export --output ./bundle.json --portable-only
comfyui-skill config import ./bundle.json --dry-run
comfyui-skill config import ./bundle.json --apply-environment

Use this when you want to migrate many workflows at once instead of re-importing them manually.

Check models and dependencies before running

comfyui-skill deps check local/txt2img
comfyui-skill deps install local/txt2img --models
comfyui-skill deps install local/txt2img --all

For AI Agents

This CLI is designed to be called from SKILL.md definitions. A typical agent workflow:

comfyui-skill server status --json                    # 1. verify server
comfyui-skill list --json                             # 2. discover workflows
comfyui-skill info local/txt2img --json               # 3. check parameters
comfyui-skill run local/txt2img --args '{...}' --json # 4. execute

Workflow chaining (multi-step pipelines)

# Run first workflow
comfyui-skill run local/txt2img --args '{"prompt": "a cat"}' --json

# Chain output into next workflow
comfyui-skill upload --from-output <prompt_id> --json
comfyui-skill run local/upscale --args '{"image": "<uploaded_name>"}' --json

Import and validate

comfyui-skill workflow import ./workflow.json --check-deps --json
comfyui-skill deps install local/my-workflow --all --json

Contributing

Contributions are welcome! Please read the Contributing Guide in the main repository for design principles and PR workflow.

Resources

Built with Typer, the same framework as comfy-cli. Designed to be integrated as a comfy skills subcommand in the future.