Skip to main content

ComfyUI Skill CLI — Agent-friendly workflow management

Project description

ComfyUI Skill CLI

+--------------------------------------------------+
|                                                  |
|      ____                 __       _   _ ___     |
|     / ___|___  _ __ ___  / _|_   _| | | |_ _|    |
|    | |   / _ \| '_ ` _ \| |_| | | | | | || |     |
|    | |__| (_) | | | | | |  _| |_| | |_| || |     |
|     \____\___/|_| |_| |_|_|  \__, |\___/|___|    |
|                              |___/               |
|        ____  _    _ _ _    ____ _     ___        |
|       / ___|| | _(_) | |  / ___| |   |_ _|       |
|       \___ \| |/ / | | | | |   | |    | |        |
|        ___) |   <| | | | | |___| |___ | |        |
|       |____/|_|\_\_|_|_|  \____|_____|___|       |
|                                                  |
+--------------------------------------------------+

中文版 | English

Agent-friendly command-line tool for managing and executing ComfyUI workflow skills. Any AI agent that can run shell commands (Claude, Codex, OpenClaw, etc.) can use ComfyUI through this CLI.

Install · Quick Start · Commands · For AI Agents

Why comfyui-skill?

  • Agent-native — structured JSON output, pipe-friendly, designed for AI agents to call
  • Zero config — reads config.json and data/ from the current directory, no setup needed
  • Full lifecycle — discover, import, execute, manage workflows and dependencies in one tool
  • Multi-server — manage multiple ComfyUI instances, route jobs to different hardware

Install

pipx install comfyui-skill-cli

Development Mode

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

The -e flag (editable) links directly to your local source — any code change is reflected instantly.

Update

pipx upgrade comfyui-skill-cli

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

This CLI uses two types of IDs:

Notation Meaning Example
<workflow_id> Workflow identifier, format: server_id/workflow_name local/txt2img
<server_id> Server identifier local, remote-a100

When <workflow_id> omits the server prefix, the default server is used:

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

Commands

Workflow Discovery & Execution

Command Description
comfyui-skill list List all available workflows with parameters
comfyui-skill info <workflow_id> Show workflow details and parameter schema
comfyui-skill run <workflow_id> --args '{...}' Execute a workflow (blocking, returns images)
comfyui-skill submit <workflow_id> --args '{...}' Submit a workflow (non-blocking, returns prompt_id)
comfyui-skill status <prompt_id> Check execution status and download results
comfyui-skill upload <image_path> Upload image to ComfyUI for use in workflows

Workflow Management

Command Description
comfyui-skill workflow import <json_path> Import workflow from local JSON (auto-detect format, auto-convert, auto-generate schema)
comfyui-skill workflow import --from-server Import workflows from ComfyUI server userdata
comfyui-skill workflow enable <workflow_id> Enable a workflow
comfyui-skill workflow disable <workflow_id> Disable a workflow
comfyui-skill workflow delete <workflow_id> Delete a workflow

Server Management

Command Description
comfyui-skill server list List all configured servers
comfyui-skill server status [<server_id>] Check if ComfyUI server is online
comfyui-skill server add --id <server_id> --url <url> Add a new server
comfyui-skill server enable <server_id> Enable a server
comfyui-skill server disable <server_id> Disable a server
comfyui-skill server remove <server_id> Remove a server

Dependency Management

Command Description
comfyui-skill deps check <workflow_id> Check missing custom nodes and models
comfyui-skill deps install <workflow_id> --repos '[...]' Install missing custom nodes via Manager
comfyui-skill deps install <workflow_id> --models Install missing models via Manager
comfyui-skill deps install <workflow_id> --all Auto-detect and install all missing deps

Configuration Transfer

Command Description
comfyui-skill config export --output <path> Export config and workflows as bundle
comfyui-skill config import <path> Import config bundle (supports --dry-run)

Execution History

Command Description
comfyui-skill history list <workflow_id> List execution history for a workflow
comfyui-skill history show <workflow_id> <run_id> Show details of a specific run

Global Options

Option Description
--json, -j Force JSON output
--server, -s <server_id> Specify server ID
--dir, -d <path> Specify data directory (default: current directory)
--verbose, -v Verbose output

Output Modes

  • TTY → Rich tables and progress bars (human-friendly)
  • Pipe / --json → Structured JSON (agent-friendly)
  • Errors → Always stderr

For AI Agents

This CLI is designed to be called from SKILL.md definitions:

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

Import a new workflow

# Import and check dependencies in one step
comfyui-skill workflow import ./workflow.json --check-deps --json

# Install missing dependencies
comfyui-skill deps install local/my-workflow --all --json

Exit Codes

Code Meaning
0 Success
1 General error
2 Invalid arguments
3 Server connection failed
4 Resource not found
5 Execution failed
6 Timeout

Compatibility

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

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

comfyui_skill_cli-0.2.2.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

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

comfyui_skill_cli-0.2.2-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file comfyui_skill_cli-0.2.2.tar.gz.

File metadata

  • Download URL: comfyui_skill_cli-0.2.2.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for comfyui_skill_cli-0.2.2.tar.gz
Algorithm Hash digest
SHA256 9e88bc19e1c33eb484c2ae0bc4d654d325cc05f2efdf96560cd944ccef82237f
MD5 b64267306cb6ff4c2c6e72c7b7bed2ba
BLAKE2b-256 41466a9faa3470dc87968bdad428640ec4011282ffc1b7d3231ef5fd5cc3f0f7

See more details on using hashes here.

File details

Details for the file comfyui_skill_cli-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for comfyui_skill_cli-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 37fb2c0964c74a494725959e1ce3f5cd2407f8061edc6648771a8fad4263b43f
MD5 5f9b8e5fa624b1645656024ca22c542b
BLAKE2b-256 17791b7b6e59e306e099c92b26b6c629a862643433561e04004d0f58d0bef0f5

See more details on using hashes here.

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