comfy-deploy

Deploy ComfyUI build releases as serverless endpoints using comfy-cli deploy commands.

961|148|Updated Apr 14, 2024
One-click install
npx skills add https://github.com/Comfy-Org/comfy-cli --skill comfy-deploy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: comfy-deploy
Source: https://github.com/Comfy-Org/comfy-cli/tree/main/comfy_cli/skills/comfy-deploy
Command: npx skills add https://github.com/Comfy-Org/comfy-cli --skill comfy-deploy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Running a ComfyUI build as a hosted, serverless endpoint involves cost traps and state complexity: deployments bill continuously while holding compute, new releases create duplicate billing deployments, and failed stops can silently keep charging. This Skill guides an AI agent through the comfy deploy command group so deployments are created, scaled, monitored, and torn down without surprise bills.

Core Features & Use Cases

  • Deployment lifecycle management: Create or reconcile deployments with up, submit API-format workflows with run, and pause or tear down compute with stop, start, scale, and delete.
  • Cost and state awareness: Explains the five billing states (queued, provisioning, starting, ready, unhealthy), the supersedes warning on duplicate deployments, and the --min standing charge so users consent before spending.
  • Health and failure diagnosis: Reads status, events, and logs to identify why a deployment failed, and maps deploy_* error codes (like deploy_job_submit_unknown or deploy_payment_required) to the correct recovery move.
  • Use Case: A user has a green Comfy Build release and wants to serve it. The agent checks comfy deploy refs compute for available GPU/region pairs, discloses the continuous billing model, runs comfy deploy up --watch, submits a workflow with comfy deploy run, and stops the deployment when finished.

Quick Start

Ask the agent to deploy the current Comfy Build release as a serverless endpoint and run your API-format workflow against it, then stop the deployment when done.

Frequently Asked Questions about comfy-deploy

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a ComfyUI build as a serverless endpoint?

Run comfy deploy up with a GPU class and region taken from comfy deploy refs compute, after confirming a deployable release exists with comfy build release show. The deployment must reach the ready state before comfy deploy run will submit workflows to it.

How do I run a workflow on a ComfyUI deployment?

Use comfy deploy run with an API-format workflow JSON exported via ComfyUI's File → Export (API). The deployment must be in the ready state, and local files are uploaded only from the install's models/, input/, and output/ directories or paths passed via --asset-root.

Why is my ComfyUI deployment still billing after I stopped it?

A stop_failed status means the stop did not take and compute may still be billing; run comfy deploy stop again with the deployment id. Also check comfy deploy ls for older deployments of the same Build, since a new release creates a second deployment rather than replacing the first.

What is the difference between comfy deploy stop and delete?

Stop pauses the deployment while retaining its endpoint URL and staged models, so start resumes the same deployment. Delete enqueues teardown and soft-deletes the record irreversibly; serving again requires up to create a new deployment with a new URL.

Can I change the GPU or region of a running ComfyUI deployment?

No, GPU and region are immutable on a live deployment and changing them returns deploy_immutable_compute. Stop the deployment first, then use comfy deploy scale --gpu or --region, and start it again.

What does deploy_job_submit_unknown mean when submitting a workflow?

It means the submission timed out and the job may or may not have been created, with no API to confirm either way. Do not resubmit, since each run uses a fresh idempotency key and a retry would be a second billed job; check comfy deploy status and report the ambiguity to the user.