Skip to main content
OpenClaw 随附内置的 comfy 插件,用于以工作流驱动的 ComfyUI 运行。该 插件完全由工作流驱动:OpenClaw 不会把通用的 sizeaspectRatioresolutiondurationSeconds 或 TTS 风格控制映射到 你的图。
属性详情
提供商comfy
模型comfy/workflow
共享工具image_generatevideo_generatemusic_generate
凭证本地 ComfyUI 无需;Comfy Cloud 使用 COMFY_API_KEYCOMFY_CLOUD_API_KEY
APIComfyUI /prompt / /history / /view;Comfy Cloud /api/*

支持内容

  • 从工作流 JSON 生成和编辑图像(编辑接受 1 张上传的参考图像)
  • 从工作流 JSON 生成视频,支持文本生成视频或图像生成视频(1 张参考图像)
  • 通过共享的 music_generate 工具生成音乐/音频,可选 1 张参考图像
  • 从配置的节点下载输出,或在未配置时从所有匹配的输出节点下载

入门指南

选择在你自己的机器上运行 ComfyUI,或使用 Comfy Cloud。
最适合: 在你的机器或局域网上运行你自己的 ComfyUI 实例。
1

在本地启动 ComfyUI

确保你的本地 ComfyUI 实例正在运行(默认值为 http://127.0.0.1:8188)。
2

准备你的工作流 JSON

导出或创建一个 ComfyUI 工作流 JSON 文件。记下提示词输入节点和你希望 OpenClaw 读取的输出节点的节点 ID。
3

配置提供商

设置 mode: "local" 并指向你的工作流文件。最小图像示例:
{
  plugins: {
    entries: {
      comfy: {
        config: {
          mode: "local",
          baseUrl: "http://127.0.0.1:8188",
          image: {
            workflowPath: "./workflows/flux-api.json",
            promptNodeId: "6",
            outputNodeId: "9",
          },
        },
      },
    },
  },
}
4

设置默认模型

将 OpenClaw 指向你已配置能力的 comfy/workflow 模型:
{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "comfy/workflow",
      },
    },
  },
}
5

验证

openclaw models list --provider comfy

配置

Comfy 支持共享的顶层连接设置,以及按能力划分的工作流小节(imagevideomusic):
{
  plugins: {
    entries: {
      comfy: {
        config: {
          mode: "local",
          baseUrl: "http://127.0.0.1:8188",
          image: {
            workflowPath: "./workflows/flux-api.json",
            promptNodeId: "6",
            outputNodeId: "9",
          },
          video: {
            workflowPath: "./workflows/video-api.json",
            promptNodeId: "12",
            outputNodeId: "21",
          },
          music: {
            workflowPath: "./workflows/music-api.json",
            promptNodeId: "3",
            outputNodeId: "18",
          },
        },
      },
    },
  },
}

共享键

类型描述
mode"local""cloud"连接模式。默认值为 "local"
baseUrlstring本地默认值为 http://127.0.0.1:8188,云端默认值为 https://cloud.comfy.org
apiKeystring可选内联 key,可替代 COMFY_API_KEY / COMFY_CLOUD_API_KEY 环境变量。
allowPrivateNetworkboolean允许在云模式中使用私有/局域网 baseUrl

按能力配置的键

这些键适用于 imagevideomusic 小节内部:
必需默认值描述
workflowworkflowPath内联工作流 JSON,或 ComfyUI 工作流 JSON 文件的路径。
promptNodeId接收文本提示词的节点 ID。
promptInputName"text"提示词节点上的输入名称。
outputNodeId要读取输出的节点 ID。如果省略,则使用所有匹配的输出节点。
pollIntervalMs1500作业完成轮询间隔,单位为毫秒。
timeoutMs300000工作流运行超时时间,单位为毫秒。
imagevideo 小节还支持参考图像输入节点:
必需默认值描述
inputImageNodeId是(传入参考图像时)接收已上传参考图像的节点 ID。
inputImageInputName"image"图像节点上的输入名称。
apiKey 接受字面字符串或 secret reference 对象。

工作流详情

将默认图像模型设置为 comfy/workflow
{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "comfy/workflow",
      },
    },
  },
}
参考图像编辑示例:要启用带上传参考图像的图像编辑,请在你的图像配置中添加 inputImageNodeId
{
  plugins: {
    entries: {
      comfy: {
        config: {
          image: {
            workflowPath: "./workflows/edit-api.json",
            promptNodeId: "6",
            inputImageNodeId: "7",
            inputImageInputName: "image",
            outputNodeId: "9",
          },
        },
      },
    },
  },
}
将默认视频模型设置为 comfy/workflow
{
  agents: {
    defaults: {
      videoGenerationModel: {
        primary: "comfy/workflow",
      },
    },
  },
}
Comfy 视频工作流通过配置的图支持文本生成视频和图像生成视频。
OpenClaw 不会将输入视频传入 Comfy 工作流。仅支持文本提示词和单张参考图像作为输入。
内置插件为工作流定义的音频或音乐输出注册音乐生成提供商,并通过共享的 music_generate 工具公开。它接受可选参考图像(最多 1 张):
/tool music_generate prompt="Warm ambient synth loop with soft tape texture"
使用 music 配置小节指向你的音频工作流 JSON 和输出节点。
现有的顶层图像配置(没有嵌套的 image 小节)仍可使用:
{
  plugins: {
    entries: {
      comfy: {
        config: {
          workflowPath: "./workflows/flux-api.json",
          promptNodeId: "6",
          outputNodeId: "9",
        },
      },
    },
  },
}
OpenClaw 会将该旧形状视为图像工作流配置。你无需立即迁移,但建议新设置使用嵌套的 image / video / music 小节。如果你只使用图像生成,旧的扁平配置和新的嵌套 image 小节在功能上等价。
内置插件提供可选择启用的实时覆盖:
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts
除非配置了匹配的 Comfy 工作流小节,否则实时测试会跳过单独的图像、视频或音乐用例。

相关

图像生成

图像生成工具配置和用法。

视频生成

视频生成工具配置和用法。

音乐生成

音乐和音频生成工具设置。

提供商目录

所有提供商和模型引用的概览。

配置参考

包含 Agent 默认值的完整配置参考。