SwarmUI

SwarmUI v0.9.8 Beta。

• 前身为 StableSwarmUI。*

一个模块化的AI图像生成Web用户界面，专注于让强大工具易于访问、高性能且可扩展。支持AI图像模型（Stable Diffusion、Z-Image、Flux、Qwen Image等）和AI视频模型（Wan、Hunyuan Video等），未来还计划支持音频等领域。

• Discord社区：加入Discord，讨论项目、获取支持、查看公告等。
• 公告：关注功能公告帖，了解新功能更新。
• 通用文档：/docs文件夹
• 官网：SwarmUI.net

---

状态

该项目目前处于Beta阶段。这意味着对于大多数任务，Swarm已经提供了非常优秀的工具支持，但仍有许多功能正在规划中。Swarm被推荐作为大多数用户的理想UI，无论是初学者还是专业人士。不过，仍有一些细节需要进一步完善。

初学者会喜欢Swarm的“生成”主标签页界面，它通过多种强大的功能让用户轻松生成任何内容。而高级用户可能会更倾向于使用“Comfy工作流”标签页来获得完全自由的原始图谱，但他们仍然会因为便利的功能（如图像编辑器、自动工作流生成等）以及一些强大工具（例如网格生成器）而回到“生成”标签页。

如果您有兴趣帮助Swarm从Beta版本迈向全面完善的正式发布版，欢迎提交PR（请先阅读贡献指南），您也可以通过GitHub或Discord与我们联系。强烈建议在提交PR之前先咨询相关功能的开发计划，因为可能已经有具体的规划，甚至已经在开发中了。

尚未实现的关键功能目标：

• 更好的移动浏览器支持
• 在UI中以更详细的“当前模型”显示，与模型选择器分开（可能作为批处理侧边栏中的一个标签页）
• LLM辅助提示（目前已有相关扩展，但LLM控制应原生支持）
• 便捷地将Swarm直接打包为应用程序分发（例如使用Tauri、Blazor Desktop或Electron应用？）

捐赠

SwarmUI始终是100%免费且开源的。如果您希望帮助它在不设置付费墙或强制投放广告的情况下持续保持行业领先水平，请捐赠给SwarmUI！

在Google Colab上试用

Google Colab

警告：Google Colab并不一定允许运行远程WebUI，尤其是免费账户，使用需自担风险。

如果您想尝试Swarm，可以使用以下Colab链接：https://colab.research.google.com/github/mcmonkeyprojects/SwarmUI/blob/master/colab/colab-notebook.ipynb

在云端GPU服务商上运行

Runpod

Runpod模板（注：由第三方贡献者nerdylive123维护）：https://get.runpod.io/swarmui

Vast.ai

Vast.ai模板（说明文档）：https://cloud.vast.ai/?ref_id=62897&creator_id=62897&name=SwarmUI

请注意，首次启动可能需要几分钟时间。请查看容器日志以了解安装进度。有关使用方法的提示，请参阅模板的“?”信息。

Windows系统安装

注意：如果您使用的是Windows 10，可能需要手动安装git和DotNET 8 SDK。（Windows 11则会自动完成这些步骤）

• 下载Install-Windows.bat脚本，将其保存到您希望安装的位置（不要放在Program Files目录下），然后运行它。
  • 脚本会打开命令提示符并自行安装。
  • 如果脚本关闭而未继续执行，请尝试再次运行，有时需要运行两次。（待解决）
  • 安装完成后，会在桌面上创建一个图标，您可以随时通过该图标重新启动服务器。
  • 安装程序完成后，会自动启动SwarmUI服务器，并在浏览器中打开安装页面。
  • 请按照页面上的安装说明进行操作。
  • 提交后请耐心等待，部分安装过程（如下载模型等）可能需要几分钟时间。

（待办事项）：开发一个更加简便的自包含预安装程序，例如.msi或.exe文件，提供统一的安装界面，允许用户选择安装目录等。

Windows系统的另一种手动安装方式

• 从https://git-scm.com/download/win下载并安装Git。
• 从https://dotnet.microsoft.com/en-us/download/dotnet/8.0下载并安装DotNET 8 SDK（确保下载适用于Windows的x64版本SDK）。
• 打开您希望安装Swarm的文件夹终端，运行git clone https://github.com/mcmonkeyprojects/SwarmUI。
• 进入该文件夹并运行launch-windows.bat。

Linux系统安装

先决条件

• 如果您的系统尚未安装git和python3，请通过操作系统包管理器进行安装（确保在那些默认不包含pip和venv的发行版中也一并安装它们）。
  • 例如，在某些Ubuntu桌面版中，可以运行sudo apt install git python3-pip python3-venv，或者您可能需要使用https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa。
  • 对于Debian或Ubuntu Server，可以运行sudo apt install git python3-full。
  • 建议使用Python 3.11或3.12版本。3.10版本也能正常工作，但请勿使用3.13版本。
  • 请确保运行python3.11 -m pip --version时返回有效的软件包信息。

Linux简易安装

• 下载install-linux.sh脚本，将其保存到您希望安装的位置，然后运行它。
  • 如果您熟悉终端操作，可以直接在文件夹中打开终端并运行以下命令：（此链接目前仍然有效）
    • wget https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh -O install-linux.sh
    • chmod +x install-linux.sh
• 运行./install-linux.sh脚本，它将为您完成所有安装步骤，并最终在浏览器中打开网页。
• 请按照页面上的安装说明进行操作。

Linux 手动安装

• 使用 https://dotnet.microsoft.com/en-us/download/dotnet/8.0 上的说明安装 .NET 8（你需要 dotnet-sdk-8.0，因为它包含了所有相关子包）。
• 打开终端并切换到你希望安装的目录：cd。
• 运行以下命令：
  • git clone https://github.com/mcmonkeyprojects/SwarmUI
  • cd SwarmUI
  • ./launch-linux.sh
  • 或者，如果在无头服务器上运行，可以使用 ./launch-linux.sh --launch_mode none --host 0.0.0.0，并将主机替换为 cloudflared。
• 打开 http://localhost:7801/Install（如果未自动打开）。
• 按照页面上的安装说明进行操作。

Linux 安装注意事项

• 你可以在任何时候运行 launch-linux.sh 脚本来重新启动 Swarm。
• 如果页面没有自动打开，你可以手动访问 http://localhost:7801。

(TODO): 或许可以链接一个专门的文档，其中包含针对不同发行版的详细信息等。是否也可以为 Linux 制作一键安装程序？我们能否移除全局 Python 安装这一先决条件？

在 Mac 上安装

注意：SwarmUI 只能在搭载 M 系列 Apple 芯片的 Mac 计算机上运行（例如 M1、M2 等）。

• 打开终端。
• 确保你的 Homebrew 包是最新的：brew update。
• 使用 brew doctor 验证 Homebrew 的安装情况。命令输出中不应有任何错误。
• 安装适用于 macOS 的 .NET：brew install dotnet。
• 如果尚未安装 Python，请执行以下命令：brew install python@3.11 和 brew install virtualenv。
  • Python 3.11、3.12 或 3.10 均可。请勿使用 3.13。
• 将当前目录切换到你希望安装 SwarmUI 的文件夹：cd。
• 克隆 SwarmUI 的 GitHub 仓库：git clone https://github.com/mcmonkeyprojects/SwarmUI。
• 进入 SwarmUI 目录并运行安装脚本：./launch-macos.sh。
• 等待网页浏览器自动打开，并按照页面上的说明完成安装。

使用 Docker 安装

有关如何在 Docker 中使用 SwarmUI 的详细说明，请参阅 Docs/Docker.md。

文档

请参阅 文档文件夹。

设计动机

“Swarm”这个名字源自该界面的核心功能：允许多个 GPU 同时为同一用户生成图像（尤其适用于大规模网格生成）。这正是命名的灵感来源，但并非 Swarm 的全部功能。

SwarmUI 的总体目标是成为一个功能齐全、一站式的 Stable Diffusion 综合平台。

有关技术选择背后的动机，请参阅 动机文档。

法律声明

本项目：

• 嵌入了 7-zip 的副本（LGPL）。
• 具备自动安装 ComfyUI 的能力（GPL）。
• 可以选择将 AUTOMATIC1111/stable-diffusion-webui 作为后端（AGPL）。
• 可以自动安装 christophschuhmann/improved-aesthetic-predictor（Apache2）和 yuvalkirstain/PickScore（MIT）。
• 可以自动安装 git-for-windows（GPLv2）。
• 可以自动安装 MIT/BSD/Apache2/Python Software Foundation 提供的 pip 包：spandrel、dill、imageio-ffmpeg、opencv-python-headless、matplotlib、rembg、kornia、Cython。
• 可以自动安装 ultralytics（AGPL），用于 YOLOv8 人脸检测（即 SwarmYoloDetection 节点或 <segment:yolo-...> 语法的使用可能会受到 AGPL 条款的约束）。
• 可以自动安装 insightface（MIT），以支持 IP Adapter - Face 功能。
• 使用了 JSON.NET（MIT）、FreneticUtilities（MIT）、LiteDB（MIT）、ImageSharp（Apache2，采用开源 Split License）。
• 嵌入了来自 BootStrap（MIT）、Select2（MIT）、JQuery（MIT）、exif-reader（MPL-2.0）的 Web 资源副本。
• 包含部分图标来自 Cristian Munoz（CC-BY-4.0）、字体 inter by rsms（OFL）、Unifont by GNU（OFL）、Material Symbols Outlined by Google（Apache2）。
• 支持安装一些自定义节点包，这些包在安装前会针对非纯开源许可证单独列出许可说明。
• 支持用户构建的扩展插件，这些插件可能具有各自的许可证或法律条款。

SwarmUI 本身采用 MIT 许可证，然而某些用法可能会受到上述关联项目 GPL 类许可证的影响，并且请注意，所使用的任何模型均具有各自的许可证。

之前的许可证

（适用于 2024 年 6 月之前的更新）

MIT 许可证（MIT） 版权所有 © 2024 Stability AI

许可证

MIT 许可证（MIT）

版权所有 © 2024–2026 Alex "mcmonkey" Goodwin

特此授予任何人免费获取本软件及其相关文档文件（以下简称“软件”）副本的权利，允许其在不受限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利；同时，允许向任何接收软件的人提供软件，但须遵守以下条件：

上述版权声明及本许可声明应包含在软件的所有副本或实质性部分中。

软件按“原样”提供，不提供任何形式的保证，无论是明示还是默示，包括但不限于适销性、特定用途适用性和非侵权性。在任何情况下，作者或版权所有者均不对因合同、侵权或其他原因引起的任何索赔、损害赔偿或其他责任负责，无论此类责任源于软件本身、软件的使用或其他与软件相关的事项。

SwarmUI 快速上手指南

SwarmUI（原名 StableSwarmUI）是一款模块化 AI 图像与视频生成 Web 界面，强调高性能、易用性及强大的扩展能力。支持 Stable Diffusion、Flux、Wan 视频模型等多种主流模型。

环境准备

系统要求

• 操作系统：Windows 10/11、Linux (Ubuntu/Debian 等)、macOS (仅限 M 系列芯片)
• Python 版本：推荐 3.11 或 3.12（严禁使用 3.13），需包含 pip 和 venv
• .NET 版本：必须安装 .NET 8 SDK

前置依赖安装

Windows 用户：

• Windows 10 需手动安装 Git 和 .NET 8 SDK。
• Windows 11 通常可自动处理部分依赖，但建议确保上述两项已安装。

Linux 用户：

# Ubuntu/Debian 示例
sudo apt update
sudo apt install git python3-pip python3-venv python3-full
# 确保 Python 版本为 3.10 - 3.12
python3 --version 

随后请参照微软官方文档安装 .NET 8 SDK (dotnet-sdk-8.0)。

macOS 用户 (仅限 M1/M2/M3 等 Apple Silicon)：

brew update
brew doctor
brew install dotnet
brew install python@3.11 virtualenv

---

安装步骤

请选择对应系统的安装方式。国内用户若下载 GitHub 资源较慢，可配置 Git 代理或使用镜像源加速。

方案 A：Windows 一键安装（推荐）

1. 下载 install-windows.bat 到非 Program Files 的目录（如 D:\AI\SwarmUI）。
2. 双击运行该文件。
   • 若窗口闪退，请再次运行一次。
   • 安装完成后会自动启动服务并打开浏览器至安装页面。
   • 桌面会生成启动图标。

方案 B：Linux/macOS 脚本安装

Linux:

# 下载安装脚本
wget https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh -O install-linux.sh
chmod +x install-linux.sh
# 执行安装
./install-linux.sh

macOS:

# 进入目标目录
cd /path/to/your/install/folder
# 克隆仓库
git clone https://github.com/mcmonkeyprojects/SwarmUI
cd SwarmUI
# 运行启动脚本（首次运行会自动完成环境配置）
./launch-macos.sh

方案 C：手动通用安装 (Git Clone)

适用于所有平台的高级用户：

# 1. 克隆仓库
git clone https://github.com/mcmonkeyprojects/SwarmUI
cd SwarmUI

# 2. 根据系统运行启动脚本
# Windows:
launch-windows.bat
# Linux:
./launch-linux.sh
# macOS:
./launch-macos.sh

# 3. 若无头服务器 (Headless Linux)，使用以下命令暴露端口：
# ./launch-linux.sh --launch_mode none --host 0.0.0.0

启动后，在浏览器访问 http://localhost:7801/Install 跟随网页指引完成后续模型后端（如 ComfyUI）的配置。

---

基本使用

安装完成后，浏览器将自动打开 SwarmUI 主界面。

1. 初始配置

• 首次访问会进入 Install 页面。
• 选择后端类型（推荐默认安装 ComfyUI 以获得最佳兼容性和性能）。
• 等待模型下载与环境初始化完成（视网络情况可能需要几分钟）。

2. 生成第一张图片 (Generate 标签页)

适合新手及快速出图：

• 点击顶部导航栏的 Generate。
• Prompt: 输入正向提示词（例如：a cute cat, cyberpunk style, high quality）。
• Negative Prompt: 输入反向提示词（例如：blurry, low quality）。
• Model: 在下拉菜单中选择已下载的模型（如 SDXL 或 Flux）。
• 点击右侧 Generate 按钮开始生成。

3. 高级工作流 (Comfy Workflow 标签页)

适合专业用户：

• 点击 Comfy Workflow 标签。
• 此处提供完整的节点式编辑器，可加载自定义 ComfyUI 工作流 JSON。
• 利用左侧工具栏进行精细控制、网格生成 (Grid Generator) 或图像编辑。

4. 多 GPU 集群 (Swarm 特性)

• 若拥有多张显卡或多台机器，可在设置中配置多个后端实例，SwarmUI 将自动分配任务以实现并行生成，大幅提升大图或网格图的产出速度。