feat(skills): comfyui skill v3 — official CLI + REST API, no third-party deps#17607
Closed
alt-glitch wants to merge 5 commits into
Closed
feat(skills): comfyui skill v3 — official CLI + REST API, no third-party deps#17607alt-glitch wants to merge 5 commits into
alt-glitch wants to merge 5 commits into
Conversation
…y dependency Complete rewrite of the ComfyUI skill to use: - comfy-cli (official, Comfy-Org/comfy-cli) for lifecycle management: install, launch, stop, node management, model downloads - Direct REST API + helper scripts for workflow execution: parameter injection, submission, monitoring, output download - No dependency on comfyui-skill-cli or any unofficial tool New files: - SKILL.md: full rewrite with two-layer architecture, decision tree, pitfalls - references/official-cli.md: complete comfy-cli command reference - references/rest-api.md: all REST endpoints (local + cloud) - references/workflow-format.md: API format spec, common nodes, param mapping - scripts/extract_schema.py: analyze workflow → extract controllable params - scripts/run_workflow.py: inject args, submit, poll, download outputs - scripts/check_deps.py: check missing nodes/models against running server - scripts/comfyui_setup.sh: full setup automation with official CLI Removed: - references/cli-reference.md (was for unofficial comfyui-skill-cli) - references/api-notes.md (replaced by rest-api.md) Addresses feedback from PR #17316 comment: - Correct author attribution - Remove references to unofficial OpenClaw project - License field reflects hermes-agent repo (MIT)
…links, cloud setup Adds structured onboarding flow to SKILL.md: - Decision table: which install path for which situation - Path A: Comfy Cloud (zero setup, API key, pricing) - Path B: Desktop app (Windows/macOS, one-click) - Path C: Portable build (Windows, extract-and-run) - Path D: comfy-cli (recommended for agents, all platforms) - Path E: Manual install (advanced, all hardware types) - Post-install: model downloads, custom nodes, verification All paths link to official docs: - https://docs.comfy.org/installation - https://docs.comfy.org/comfy-cli/getting-started - https://docs.comfy.org/get_started/cloud - https://docs.comfy.org/installation/desktop - https://docs.comfy.org/installation/comfyui_portable_windows - https://docs.comfy.org/installation/manual_install
…ring sanitization' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
…ring sanitization' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
…to onboarding Instead of asking the user what they have, the agent now: 1. Runs system detection commands (OS, GPU, VRAM, RAM, disk, Python) 2. Checks if ComfyUI is already installed/running 3. Recommends the best path based on findings Adds: - Step 1: detection script block (nvidia-smi, system_profiler, etc.) - Step 2: decision table mapping detected system → recommended path - Hardware requirements table (VRAM tiers, RAM, disk) - Specific recommendations per platform: macOS → Desktop app, Linux+NVIDIA → comfy-cli, no GPU → Cloud, etc.
Contributor
|
Merged via #17610 — all four of your commits (v4 rewrite, onboarding docs, two CodeQL fixes) were cherry-picked onto current main with your authorship preserved via rebase-merge. A hardware-feasibility check (scripts/hardware_check.py) was layered on top to auto-gate the local install so users with <6 GB VRAM, Intel Macs, or <16 GB Apple unified memory get routed to Comfy Cloud instead of silently hitting OOM on first workflow. Thanks for the excellent rewrite! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Complete rewrite of the ComfyUI optional skill. Replaces the previous approach
(which depended on the unofficial
comfyui-skill-cli) with a two-layerarchitecture using only official tooling:
comfy-cli(Comfy-Org/comfy-cli) for lifecycle management — install,launch, stop, custom node management, model downloads
injection, submission, monitoring, output download, dependency checking
What's Included
SKILL.mdreferences/official-cli.mdreferences/rest-api.mdreferences/workflow-format.mdscripts/comfyui_setup.shscripts/extract_schema.pyscripts/run_workflow.pyscripts/check_deps.pyWhy Scripts Are Needed: Gaps in the Official CLI
The official
comfy-cliis excellent for installation and server lifecycle butwas not designed for agent-driven workflow execution. Here's what it can and
can't do:
comfy-clicomfy installcomfy launch/stopcomfy node installcomfy model downloadcomfy run --workflowrun_workflow.pyrun_workflow.pyX-API-Keyheader)run_workflow.pyrun_workflow.pyrun_workflow.pyextract_schema.pycheck_deps.pyThe
comfy runcommand in particular is very limited — it takes a raw JSON file,submits it verbatim to a local server with a 30-second timeout, shows a progress
bar, and exits. No parameter modification, no cloud support, no output download,
no structured response the agent can parse.
Our scripts (
run_workflow.py,extract_schema.py,check_deps.py) fill thesegaps using stdlib Python + requests (~740 lines total), making the full ComfyUI
execution flow agent-friendly without depending on any unofficial third-party CLI.
Onboarding
Comprehensive setup guide covering all installation pathways:
Each path links to official docs (docs.comfy.org).
Credits
The approach for workflow parameter extraction, schema mapping, and execution
orchestration in our helper scripts was informed by
@HuangYuChuh's work on
comfyui-skill-cli —
particularly the patterns for identifying controllable nodes by class type,
the model loader → folder mapping for dependency checking, and the
WebSocket/polling execution flow. Credit to their project for pioneering the
agent-friendly ComfyUI interface patterns.
Closes #17316
Closes #11143
Closes #13271