Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.comfy.org/llms.txt

Use this file to discover all available pages before exploring further.

ComfyUI is a modular GenAI inference engine that can be run as a server, accessed via API, extended with custom nodes, and managed from the command line. Choose your path below.

​
Deploy ComfyUI as a Server

Run ComfyUI in your own environment and expose it as an API endpoint. Learn about the WebSocket message protocol, available routes, and execution modes.

Server Overview

Get started with the local server setup, message types, route handling, and execution model inversion.
See also: Messages & Routes · Execution Model Inversion · Partner Node API Integration

​
Cloud API

Run workflows programmatically on Comfy Cloud without managing your own hardware. Use the REST API, browse the OpenAPI spec, and integrate Partner Nodes via API Key.

Cloud API Overview

Learn how to authenticate, submit jobs, check status, and download results from Comfy Cloud.
See also: API Reference · OpenAPI Specification · Getting an API Key

​
Agent Tools / MCP

Connect AI agents to ComfyUI via the Model Context Protocol (MCP). Use the hosted Cloud MCP or run the Partner MCP server locally for generation across 30+ providers.

MCP Overview

Compare Cloud MCP and Partner MCP, and find the right setup for your AI agent integration.
See also: Comfy Cloud MCP · Comfy Partner MCP

​
Comfy CLI

Manage your ComfyUI installation, custom nodes, and workflows from the command line. Install, update, configure, and automate with ease.

CLI Getting Started

Learn how to install, update, and manage ComfyUI from the terminal.
See also: CLI Reference · Troubleshooting

​
Develop Custom Nodes

Custom nodes let you extend ComfyUI with your own Python backends, JavaScript UI widgets, and integrations. This is one of the most powerful ways to contribute to the ecosystem.

Getting Started

New to custom nodes? Learn the anatomy of a node, how to publish it, and best practices.

Key pages: Walkthrough · v3 Migration Guide

Backend (Python)

Build the server-side of your custom node. Covers data types, image & mask handling, lazy evaluation, tensors, and more.

Key pages: Data Types · Images & Masks · Lazy Evaluation · Node Expansion

Frontend (JavaScript)

Add custom UI widgets, sidebar tabs, keybindings, and dialogs to your nodes. Full control over the ComfyUI frontend.

Key pages: Hooks · Sidebar Tabs · Commands & Keybindings · Examples
See also: Internationalization (i18n)

​
Registry

Publish and manage your custom nodes through the Comfy Registry. The Registry provides versioning, security scanning, and discovery for the community.

Publishing Overview

Register as a publisher, publish your first node, claim existing ones, and set up CI/CD for automated releases.
See also: Publishing Tutorial · Standards · CI/CD · Specifications