跳转到主要内容

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 是一个模块化的 GenAI 推理引擎,可以部署为 API 服务器、通过接口调用、用自定义节点扩展,也能用命令行管理。根据你的需求选择下面的路径。

部署 ComfyUI 作为 API 服务

在自有环境中运行 ComfyUI 并将其暴露为 API 端点。了解 WebSocket 消息协议、可用路由和执行模式。

服务概览

从本地服务器搭建开始,了解消息类型、路由处理和执行模型反转。
另见:消息与路由 · 执行模型反转 · Partner Node API 集成

Cloud API

在 Comfy Cloud 上以编程方式运行工作流,无需管理硬件。使用 REST API、查看 OpenAPI 规范,并通过 API Key 集成 Partner Node。

Cloud API 概览

了解如何认证、提交任务、查询状态以及从 Comfy Cloud 下载结果。
另见:API 参考 · OpenAPI 规范 · 获取 API Key

Agent Tools / MCP

通过模型上下文协议(MCP)将 AI 代理连接到 ComfyUI。使用托管的 Cloud MCP 或在本地运行 Partner MCP 服务器,对接 30+ 个服务商。

MCP 概览

比较 Cloud MCP 和 Partner MCP,找到适合你 AI 代理集成的方式。
另见:Comfy Cloud MCP · Comfy Partner MCP

Comfy CLI

通过命令行管理 ComfyUI 的安装、自定义节点和工作流。轻松完成安装、更新、配置和自动化。

CLI 快速上手

了解如何从终端安装、更新和管理 ComfyUI。
另见:CLI 参考 · 故障排除

开发自定义节点

自定义节点让你可以通过 Python 后端、JavaScript UI 组件和外部集成来扩展 ComfyUI。这是为 ComfyUI 生态做贡献最强大的方式之一。

快速入门

自定义节点新手?了解节点结构、发布方法和最佳实践。

关键页面:教程 · v3 迁移指南

后端(Python)

构建自定义节点的服务端。涵盖数据类型、图像与遮罩处理、惰性求值、张量操作等。

关键页面:数据类型 · 图像与遮罩 · 惰性求值 · 节点扩展示例

前端(JavaScript)

为节点添加自定义 UI 组件、侧边栏标签页、快捷键和对话框,完全掌控 ComfyUI 的前端。

关键页面:钩子(Hooks) · 侧边栏标签页 · 命令与快捷键 · 示例代码
另见:国际化(i18n)

注册表(Registry)

通过 Comfy 注册表发布和管理你的自定义节点。注册表为社区提供版本控制、安全扫描和节点发现能力。

发布概览

注册为发布者、发布你的第一个节点、认领已有节点,并配置 CI/CD 实现自动化发布。
另见:发布教程 · 标准 · CI/CD · 规范