Update README.md
Browse files
README.md
CHANGED
|
@@ -1,84 +1,98 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
-
# UmeAiRT
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
-
|
| 19 |
-
-
|
| 20 |
-
-
|
| 21 |
-
-
|
| 22 |
-
-
|
| 23 |
-
-
|
| 24 |
-
- Triton
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
-
|
| 30 |
-
-
|
| 31 |
-
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
-
|
| 41 |
-
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
-
|
| 46 |
-
-
|
| 47 |
-
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
-
|
| 56 |
-
-
|
| 57 |
-
|
| 58 |
-
-
|
| 59 |
-
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
-
|
| 67 |
-
-
|
| 68 |
-
- ComfyUI
|
| 69 |
-
- ComfyUI
|
| 70 |
-
-
|
| 71 |
-
-
|
| 72 |
-
-
|
| 73 |
-
-
|
| 74 |
-
-
|
| 75 |
-
-
|
| 76 |
-
-
|
| 77 |
-
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
|
| 83 |
|
| 84 |
![alt text][logo]
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- code
|
| 5 |
+
- comfyui
|
| 6 |
+
- installer
|
| 7 |
+
- auto
|
| 8 |
---
|
| 9 |
+
# UmeAiRT's ComfyUI Auto-Installer
|
| 10 |
+
|
| 11 |
+

|
| 12 |
+

|
| 13 |
+

|
| 14 |
+
|
| 15 |
+
This project provides a suite of PowerShell scripts to fully automate the installation and configuration of ComfyUI on Windows. The approach uses a clean installation based on `git` and a Python virtual environment (`venv`), ensuring an isolated, easy-to-update, and maintainable setup.
|
| 16 |
+
|
| 17 |
+
## Features
|
| 18 |
+
|
| 19 |
+
- **Clean Installation:** Clones the latest version of ComfyUI from the official repository and installs it in a dedicated Anaconda Python virtual environment.
|
| 20 |
+
- **Dependency Management:** Automatically checks for and installs necessary tools:
|
| 21 |
+
- Anaconda Python 3.12 (if not present on the system)
|
| 22 |
+
- Git
|
| 23 |
+
- 7-Zip
|
| 24 |
+
- Aria2 (for accelerated downloads)
|
| 25 |
+
- **CSV-Managed Custom Nodes:** Installs a comprehensive list of custom nodes defined in an external `custom_nodes.csv` file, making it simple to add new nodes.
|
| 26 |
+
- **Interactive Model Downloaders:** Dedicated scripts guide you with menus to download the model packs you want (FLUX, WAN, HIDREAM, LTXV), with recommendations based on your graphics card's VRAM.
|
| 27 |
+
- **Dedicated Update Script:** A specific `UmeAiRT-Updater.ps1` script allows you to update ComfyUI, all custom nodes, and workflows with a single command.
|
| 28 |
+
- **Automated Launchers:** The project generates `.bat` files to run the installation, updates, and the final application, automatically handling administrator rights and PowerShell execution policies.
|
| 29 |
+
- **Supplementary modules:** The script also installs some complex modules such as: Sageattention, Triton, Visual Studio Build Tools, ...
|
| 30 |
+
- **Workflow included:** A large amount of workflows are pre-installed for each model.
|
| 31 |
+
|
| 32 |
+
## Prerequisites
|
| 33 |
+
|
| 34 |
+
- Windows 10 or Windows 11 (64-bit).
|
| 35 |
+
- An active internet connection.
|
| 36 |
+
- An NVIDIA GPU is strongly recommended to use the models.
|
| 37 |
+
|
| 38 |
+
## Installation and Usage
|
| 39 |
+
|
| 40 |
+
The entire process is designed to be as simple as possible.
|
| 41 |
+
|
| 42 |
+
1. **Download the Project:** Download `UmeAiRT-Install-ComfyUI.bat` from GitHub and put it to a folder of your choice (e.g., `C:\UmeAiRT-Installer`).
|
| 43 |
+
|
| 44 |
+
2. **Run the Installer:**
|
| 45 |
+
- Run the file `UmeAiRT-Install-ComfyUI.bat`.
|
| 46 |
+
- It will ask for administrator privileges. Please accept.
|
| 47 |
+
- The script will first download the latest versions of all installation scripts from the repository to ensure you are using the most recent version.
|
| 48 |
+
|
| 49 |
+
3. **Follow the Instructions:**
|
| 50 |
+
- The main installation script will then launch. It will install Python (if necessary), Git, 7-Zip, Aria2, and then ComfyUI.
|
| 51 |
+
- Next, it will install all custom nodes and their Python dependencies into the virtual environment.
|
| 52 |
+
- Finally, it will ask you a series of questions about which model packs you wish to download. Simply answer `Y` (yes) or `N` (no) to each question.
|
| 53 |
+
|
| 54 |
+
At the end of the process, your ComfyUI installation will be complete and ready to use.
|
| 55 |
+
|
| 56 |
+
## Post-Installation Usage
|
| 57 |
+
|
| 58 |
+
Three main `.bat` files will be available in your folder to manage the application:
|
| 59 |
+
|
| 60 |
+
- **`UmeAiRT-Start-ComfyUI.bat`**
|
| 61 |
+
- This is the file you will use to **launch ComfyUI**. It activates the virtual environment and starts the server.
|
| 62 |
+
|
| 63 |
+
- **`UmeAiRT-Download_models.bat`**
|
| 64 |
+
- Run this script if you want to **add more model packs** later without reinstalling everything. It will present you with the same selection menu as the initial installation.
|
| 65 |
+
|
| 66 |
+
- **`UmeAiRT-Update-ComfyUI.bat`**
|
| 67 |
+
- Execute this script to **update your entire installation**. It will update the code for ComfyUI, all custom nodes, and your workflows, and it will install any new Python dependencies if required.
|
| 68 |
+
|
| 69 |
+
## File Structure
|
| 70 |
+
|
| 71 |
+
- **`/` (your root folder)**
|
| 72 |
+
- `UmeAiRT-Installer-Updater.bat` (Main launcher that updates and installs)
|
| 73 |
+
- `UmeAiRT-Start-ComfyUI.bat` (Created after installation to launch ComfyUI)
|
| 74 |
+
- `UmeAiRT-Update-ComfyUI.bat` (Launcher for the update script)
|
| 75 |
+
- `UmeAiRT-Download_models.bat` (Menu to download more models later)
|
| 76 |
+
- **`scripts/`** (Contains all PowerShell scripts)
|
| 77 |
+
- `Install-ComfyUI.ps1`
|
| 78 |
+
- `UmeAiRT-Updater.ps1`
|
| 79 |
+
- `Download-FLUX-Models.ps1` (and other model downloaders)
|
| 80 |
+
- `custom_nodes.csv` (The list of all custom nodes to install)
|
| 81 |
+
- **`ComfyUI/`** (Created after installation, contains the application)
|
| 82 |
+
- **`logs/`** (Created, contains installation/update logs)
|
| 83 |
+
|
| 84 |
+
## Contributing
|
| 85 |
+
|
| 86 |
+
Suggestions and contributions are welcome. If you find a bug or have an idea for an improvement to the scripts, feel free to open an "Issue" on this GitHub repository.
|
| 87 |
+
|
| 88 |
+
## License
|
| 89 |
+
|
| 90 |
+
This project is under the MIT License. See the `LICENSE` file for more details.
|
| 91 |
+
|
| 92 |
+
## Acknowledgements
|
| 93 |
+
|
| 94 |
+
- To **Comfyanonymous** for creating the incredible ComfyUI.
|
| 95 |
+
- To the authors of all the **custom nodes** that enrich the ecosystem.
|
| 96 |
|
| 97 |
|
| 98 |
![alt text][logo]
|