Getting Started

📥Downloading

It is recommended to download Source code (zip) from the latest release on the releases page for better stability, however if you want the most up-to-date version with the most features you can clone the repo with the following command:

git clone https://github.com/ImDarkTom/ComfyUIMini.git
cd ./ComfyUIMini

⚡Quick Start

Installing

Using Install Script (Recommended)

For the most straightforward installation, use the provided install script for your platform:

Windows:

.\scripts\install.bat

Linux/MacOS:

chmod +x ./scripts/install.sh
./scripts/install.sh

Manual Installation

If you prefer to install manually, you can do so too:

1. Install dependencies

npm install

2. Build the app

npm run build

Configuration

Before starting, you will need to make sure that you set some initial configs or the app may not run, copy the default config template at config/default.example.json to config/default.json, and make sure that output_dir is set to your ComfyUI's output images folder.

(If you are on Windows, you may need to use two backslahes to denote directory, e.g. C:\\path\\to\\output\\dir)

For a more comprehensive list on each config option, you can look at configuring.

Starting

After setting configurations, you can then start the app with:

Scripts

Windows:

.\scripts\start.bat

Linux/MacOS:

chmod +x ./scripts/start.sh
./scripts/start.sh

or manually

npm start

Note: You may experience a crash on first launch, this should be resolve by launching again.

🔄Updating

For updating, you can run the update script in the ./scripts/ directory for your respective platform (.bat for Windows, .sh for Linux and MacOS).