|
1 | | -ComfyUI |
2 | | -======= |
3 | | -The most powerful and modular stable diffusion GUI and backend. |
4 | | ------------ |
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +# ComfyUI |
| 4 | +**The most powerful and modular stable diffusion GUI and backend.** |
| 5 | + |
| 6 | + |
| 7 | +[![Website][website-shield]][website-url] |
| 8 | +[![Dynamic JSON Badge][discord-shield]][discord-url] |
| 9 | +[![Matrix][matrix-shield]][matrix-url] |
| 10 | +<br> |
| 11 | +[![][github-release-shield]][github-release-link] |
| 12 | +[![][github-release-date-shield]][github-release-link] |
| 13 | +[![][github-downloads-shield]][github-downloads-link] |
| 14 | +[![][github-downloads-latest-shield]][github-downloads-link] |
| 15 | + |
| 16 | +[matrix-shield]: https://img.shields.io/badge/Matrix-000000?style=flat&logo=matrix&logoColor=white |
| 17 | +[matrix-url]: https://app.element.io/#/room/%23comfyui_space%3Amatrix.org |
| 18 | +[website-shield]: https://img.shields.io/badge/ComfyOrg-4285F4?style=flat |
| 19 | +[website-url]: https://www.comfy.org/ |
| 20 | +<!-- Workaround to display total user from https://github.com/badges/shields/issues/4500#issuecomment-2060079995 --> |
| 21 | +[discord-shield]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fcomfyorg%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Discord&color=green&suffix=%20total |
| 22 | +[discord-url]: https://www.comfy.org/discord |
| 23 | + |
| 24 | +[github-release-shield]: https://img.shields.io/github/v/release/comfyanonymous/ComfyUI?style=flat&sort=semver |
| 25 | +[github-release-link]: https://github.com/comfyanonymous/ComfyUI/releases |
| 26 | +[github-release-date-shield]: https://img.shields.io/github/release-date/comfyanonymous/ComfyUI?style=flat |
| 27 | +[github-downloads-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/total?style=flat |
| 28 | +[github-downloads-latest-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/latest/total?style=flat&label=downloads%40latest |
| 29 | +[github-downloads-link]: https://github.com/comfyanonymous/ComfyUI/releases |
| 30 | + |
5 | 31 |  |
| 32 | +</div> |
6 | 33 |
|
7 | 34 | This ui will let you design and execute advanced stable diffusion pipelines using a graph/nodes/flowchart based interface. For some workflow examples and see what ComfyUI can do you can check out: |
8 | 35 | ### [ComfyUI Examples](https://comfyanonymous.github.io/ComfyUI_examples/) |
@@ -219,6 +246,47 @@ Use `--tls-keyfile key.pem --tls-certfile cert.pem` to enable TLS/SSL, the app w |
219 | 246 |
|
220 | 247 | See also: [https://www.comfy.org/](https://www.comfy.org/) |
221 | 248 |
|
| 249 | +## Frontend Development |
| 250 | + |
| 251 | +As of August 15, 2024, we have transitioned to a new frontend, which is now hosted in a separate repository: [ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend). This repository now hosts the compiled JS (from TS/Vue) under the `web/` directory. |
| 252 | + |
| 253 | +### Reporting Issues and Requesting Features |
| 254 | + |
| 255 | +For any bugs, issues, or feature requests related to the frontend, please use the [ComfyUI Frontend repository](https://github.com/Comfy-Org/ComfyUI_frontend). This will help us manage and address frontend-specific concerns more efficiently. |
| 256 | + |
| 257 | +### Using the Latest Frontend |
| 258 | + |
| 259 | +The new frontend is now the default for ComfyUI. However, please note: |
| 260 | + |
| 261 | +1. The frontend in the main ComfyUI repository is updated weekly. |
| 262 | +2. Daily releases are available in the separate frontend repository. |
| 263 | + |
| 264 | +To use the most up-to-date frontend version: |
| 265 | + |
| 266 | +1. For the latest daily release, launch ComfyUI with this command line argument: |
| 267 | + |
| 268 | + ``` |
| 269 | + --front-end-version Comfy-Org/ComfyUI_frontend@latest |
| 270 | + ``` |
| 271 | + |
| 272 | +2. For a specific version, replace `latest` with the desired version number: |
| 273 | + |
| 274 | + ``` |
| 275 | + --front-end-version Comfy-Org/[email protected] |
| 276 | + ``` |
| 277 | + |
| 278 | +This approach allows you to easily switch between the stable weekly release and the cutting-edge daily updates, or even specific versions for testing purposes. |
| 279 | + |
| 280 | +### Accessing the Legacy Frontend |
| 281 | + |
| 282 | +If you need to use the legacy frontend for any reason, you can access it using the following command line argument: |
| 283 | + |
| 284 | +``` |
| 285 | +--front-end-version Comfy-Org/ComfyUI_legacy_frontend@latest |
| 286 | +``` |
| 287 | + |
| 288 | +This will use a snapshot of the legacy frontend preserved in the [ComfyUI Legacy Frontend repository](https://github.com/Comfy-Org/ComfyUI_legacy_frontend). |
| 289 | + |
222 | 290 | # QA |
223 | 291 |
|
224 | 292 | ### Which GPU should I buy for this? |
|
0 commit comments