开源推荐：comfyui-client，强大的ComfyUI客户端工具-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01084/article/details/147276355

开源推荐：comfyui-client，强大的ComfyUI客户端工具

comfyui-client all ComfyUI http/ws APIs. support NodeJS / Browser environments. and advanced programmable workflow. 项目地址: https://gitcode.com/gh_mirrors/co/comfyui-client

项目核心功能/场景

comfyui-client 是一款支持 NodeJS 和浏览器环境的 JavaScript API 客户端，为开发者提供全面的 RESTful 和 WebSocket API 支持，并内置 TypeScript 类型定义，增强开发体验。

项目介绍

在现代Web开发中，创建一个与用户友好的交互式图形界面变得越来越重要。comfyui-client 为此而生，它是一个功能全面的客户端库，允许开发者在NodeJS和浏览器环境中轻松接入ComfyUI的强大功能。无论是构建自动化工作流，还是处理图像、文本等复杂任务，comfyui-client 都提供了简单易用的API。

项目技术分析

comfyui-client 基于现代JavaScript技术构建，充分利用了TypeScript的静态类型系统，为开发者提供类型安全的API调用。它不仅支持RESTful API，还支持WebSocket API，使得与ComfyUI的交互更加实时、高效。

技术亮点

环境兼容性：无缝支持 NodeJS 和浏览器环境。
API支持：提供对所有可用RESTful和WebSocket API的全面支持。
TypeScript类型定义：内置TypeScript类型定义，提高开发体验和类型安全性。
可编程工作流：引入了易于阅读和高度可定制的工作流接口。

项目技术应用场景

comfyui-client 的应用场景广泛，适用于以下几种情况：

自动化图像处理：利用ComfyUI的图像处理能力，自动生成或编辑图像。
实时交互应用：通过WebSocket API，创建与用户实时交互的Web应用。
复杂工作流构建：利用内置的工作流API，构建和管理复杂的工作流程。
独立应用集成：在独立的NodeJS应用中集成ComfyUI功能，提供后端支持。

项目特点

comfyui-client 拥有以下显著特点：

环境兼容性：支持多种环境，无需担心平台限制。
全面API支持：覆盖ComfyUI所有API，满足各类开发需求。
TypeScript支持：提高代码质量和开发效率。
易用性：简化了工作流和API调用，使得开发更加便捷。
无依赖设计：尽可能减少外部依赖，降低项目复杂度。

使用指南

安装comfyui-client非常简单，使用npm或yarn即可：

pnpm add @stable-canvas/comfyui-client

对于浏览器环境，还可以通过CDN直接引入：

<script src="https://cdn.jsdelivr.net/npm/@stable-canvas/comfyui-client@latest/dist/main.module.mjs"></script>

使用示例

在NodeJS环境中，创建Client实例并连接：

import { Client } from "@stable-canvas/comfyui-client";
import WebSocket from "ws";
import fetch from "node-fetch";

const client = new Client({
    //...
    WebSocket,
    fetch,
});
// 连接WebSocket客户端
client.connect();

comfyui-client 提供了丰富的API接口，例如：

client.getExtensions()：获取扩展列表。
client.getEmbeddings()：获取嵌入名称列表。
client.getNodeDefs()：加载节点对象定义。

此外，它还支持自定义路由和高级功能，如工作流管理、任务状态监控等。

工作流使用

工作流（Workflow）是comfyui-client的核心特性之一，允许开发者创建文本到图像、图像到图像等任务，并监控其进度。

以下是一个简单的文本到图像的工作流示例：

import { BasePipe } from "@stable-canvas/comfyui-client";

new BasePipe()
  .with(/* client instance */)
  .model("sdxl.safetensors")
  .prompt("一个美丽的山川日落")
  .negative("低质量，模糊")
  .size(1024, 768)
  .steps(35)
  .cfg(5)
  .save()
  .wait() // 开始任务
  .then(({ images }) => {
    // 处理生成的图像
  })
  .finally(() => client.close());

通过comfyui-client，开发者可以轻松地构建功能丰富、交互性强、易于管理的Web应用程序，满足多种业务需求。

总结来说，comfyui-client 是一个值得推荐的JavaScript客户端库，它简化了与ComfyUI的交互，为开发者提供了极大的便利。无论是对于图像处理、实时交互还是复杂工作流的构建，comfyui-client 都是一个出色的选择。

comfyui-client all ComfyUI http/ws APIs. support NodeJS / Browser environments. and advanced programmable workflow. 项目地址: https://gitcode.com/gh_mirrors/co/comfyui-client