Skip to main content

ComfyUI Skill CLI — Agent-friendly workflow management

Project description

ComfyUI Skill CLI

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

What is this?

ComfyUI Skill CLI turns ComfyUI workflows into callable commands. Any AI agent that can run shell commands (Claude, Codex, OpenClaw, etc.) can use ComfyUI through this CLI.

# List available skills
comfyui-skill list --json

# Execute a workflow
comfyui-skill run local/txt2img --args '{"prompt": "a white cat", "seed": 42}' --json

# Check server health
comfyui-skill server status --json

Every command supports --json for structured output. Pipe-friendly by default.

Install

pipx install comfyui-skill-cli

Usage

Run commands from within a ComfyUI Skills project directory:

cd /path/to/your-skills-project
comfyui-skill list

The CLI reads config.json and data/ from the current working directory.

Commands

Command Description
comfyui-skill list List all available skills with parameters
comfyui-skill info <id> Show skill details and parameter schema
comfyui-skill run <id> --args '{...}' Execute a skill (blocking)
comfyui-skill submit <id> --args '{...}' Submit a skill (non-blocking)
comfyui-skill status <prompt-id> Check execution status
comfyui-skill server list List configured servers
comfyui-skill server status Check if ComfyUI server is online
comfyui-skill deps check <id> Check missing dependencies
comfyui-skill deps install <id> Install missing dependencies

Global Options

Option Description
--json, -j Force JSON output
--server, -s Specify server ID
--dir, -d 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

Skill ID Format

comfyui-skill run local/txt2img          # server_id/workflow_id
comfyui-skill run txt2img                # uses default server
comfyui-skill run txt2img -s my_server   # explicit server

For AI Agents

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

## Available Commands
comfyui-skill list --json
comfyui-skill info <server_id>/<workflow_id> --json
comfyui-skill run <server_id>/<workflow_id> --args '{"prompt":"..."}' --json

## Typical Flow
1. `comfyui-skill server status --json` — verify server is online
2. `comfyui-skill list --json` — discover available skills
3. `comfyui-skill info <id> --json` — check required parameters
4. `comfyui-skill run <id> --args '{...}' --json` — execute

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.

License

MIT

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.1.0.tar.gz (12.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.1.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for comfyui_skill_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 176179674da049da4fa02da4494f7ea6beb6b1c0c765d8749b82a718f70261ae
MD5 733ba23479dabc728ab2b7e9292baa4e
BLAKE2b-256 2c304f15924508e5b74c5cd39201e9e24d17e7bbb266f74eb68a34356458534f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for comfyui_skill_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76e0f6f04d2dd532e42939d8fca30f5cd5c354c1aa21f251c65384f652bd650d
MD5 bceb13c8bfb30c7e8c337a7a0fbc49a0
BLAKE2b-256 1b34644608cf6c7d5bf3d211affa6cd44575bb19c5c212c4cb8d992d235185ea

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