ComfyUI_Skills_OpenClaw/docs/getting-started.md

title, description, permalink

title	description	permalink
Getting Started	Install ComfyUI Skills for OpenClaw, connect your first ComfyUI server, upload a workflow, and verify that the skill can generate images.	/getting-started/

Getting Started

Install the skill, connect ComfyUI, and run your first workflow.

This page is the shortest reliable path from cloning the repository to triggering a real ComfyUI workflow through OpenClaw or the local CLI.

Open Repository See Use Cases View Architecture

Prerequisites

What you need before setup

• Python 3.10 or newer.
• A reachable ComfyUI server, commonly http://127.0.0.1:8188.
• At least one ComfyUI workflow exported in API format.
• A workflow output path that ends in Save Image or another downloadable image output.

Quick Install

Install into an OpenClaw workspace

cd ~/.openclaw/workspace/skills
git clone https://github.com/HuangYuChuh/ComfyUI_Skills_OpenClaw.git comfyui-skill-openclaw
cd comfyui-skill-openclaw
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt
cp config.example.json config.json

If python3 --version is below 3.10, create the virtual environment with any installed python3.10+ interpreter, for example python3.12 -m venv .venv.

If your macOS Python blocks global package changes, keep everything inside the virtual environment above.

Recommended Flow

Use the local web dashboard first

1. Start the UI with ./ui/run_ui.sh on macOS or Linux, or ui\run_ui.bat on Windows.
2. Open http://localhost:18189.
3. Add a ComfyUI server and confirm the server URL is correct.
4. Upload a workflow exported from ComfyUI with Save (API Format).
5. Select the parameters you want OpenClaw to expose and save the mapping.

Best practice: start with the UI once, then automate later with CLI or agent edits.

CLI Verification

Confirm the skill can see and call your workflow

First list the registered workflows:

python scripts/registry.py list

Then run a real generation test:

python scripts/comfyui_client.py \
  --workflow local/Default \
  --args '{"prompt":"A premium product photo"}'

Successful runs return a prompt_id and one or more local image paths in ./outputs.

Workflow Files

The minimum file layout

data/local/Default/
  workflow.json
  schema.json

• workflow.json is the ComfyUI API-format export.
• schema.json exposes only the parameters the agent should be allowed to call.
• The workflow identity used by the client is <server_id>/<workflow_id>.