--- title: "Comfy API Quickstart" sidebarTitle: "Quickstart" description: "Use an AI coding agent and comfy-cli to build, release, and deploy a local ComfyUI environment as a managed endpoint." icon: "cloud-arrow-up" --- ## Start with an agent (recommended) Start your coding agent in the folder for the local ComfyUI install you want to deploy. Paste this prompt: ```text Install or update comfy-cli, then read its Build and Deploy skills: pip install -U comfy-cli comfy skills show comfy-build comfy skills show comfy-deploy Use comfy-build to inspect this local ComfyUI install and package its models, custom nodes, and pinned dependencies into a Comfy API Build. Show me what will be included and create a Linux/NVIDIA release. Then use comfy-deploy to show the available GPU and region options, worker bounds, and current rates. Wait for my approval before creating a deployment. After approval, deploy it and explain how to run a workflow. ``` ## Quick start Use these commands when the local install and an [API-format workflow](/development/api-development/workflow-api-format) saved as `workflow_api.json` are ready. ```bash comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes ``` Push the Build and its assets, check the available targets, then wait for the Linux/NVIDIA release to finish: ```bash comfy build push comfy build refs build-targets comfy build release create --target linux/nvidia --watch ``` Check the catalog for available GPU and region pairs, then replace the GPU, region, and worker-bound placeholders with your settings: ```bash comfy deploy refs compute comfy deploy up --gpu --region --min --max --watch ``` Use the deployment ID printed by `comfy deploy up` with `--deployment`: ```bash comfy deploy run \ --workflow workflow_api.json \ --deployment \ --output-dir ./results ``` ## Other ways to start Use these paths if your environment or workflow already exists in Comfy Desktop or a workflow file. Export a snapshot from Desktop, then import it into the Build Wizard. Start a Build by importing a saved workflow into the Build Wizard. ## Next steps Browse ComfyUI workflows shared by the community. Explore community apps built with ComfyUI.