Repository navigation
docs(desktop): consolidate open lin-bot23 Desktop PRs #1961
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
fd94046
02896d7
2ec25dc
5a418b6
03080ee
5eaf9a0
17caa5a
a271812
6166958
9add9c1
2f34388
bd89c32
4a12c78
e8f7ff3
f29818d
59da492
bb975bc
6d8d4b1
d5fd0ec
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
|
|
||
| To put it simply: **Comfy Desktop** is the app that manages and launches **ComfyUI**, the node-based engine for generative AI. You don't install ComfyUI separately — Comfy Desktop handles the installation, Python environment, and dependencies for you. Each ComfyUI instance runs independently with its own version, custom nodes, and settings. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Comfy Desktop runs on **Windows 10+**, **macOS 13+ (Apple Silicon)**, and **Linux** (official `.deb` and AppImage packages). Each standalone installation requires at least **4.85 GB** of disk space and **8 GB RAM (16 GB recommended)**. Check the platform-specific pages for full details. | ||
|
|
||
|
|
@@ -31,6 +31,54 @@ | |
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## First Launch | ||
|
|
||
| The first time you open Comfy Desktop, a full-screen setup asks **How do you want to run Comfy?** and collects the choices it needs before anything is installed. The window stays in this setup until you finish it: if you close the app partway through, the same screen comes back on the next launch. | ||
|
|
||
| ### Cloud or Local | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win Add both setup screenshots to the translated pages. The structure-parity check reports that the Japanese, Korean, and Chinese overview pages each lack two images and are stale. Add both image references, with localized alt text, to each page and refresh its translation hash so the check passes. Also applies to: 59-59 🤖 Prompt for AI AgentsSource: Pipeline failures |
||
|
|
||
| Two cards cover the two ways to run ComfyUI: | ||
|
|
||
| - **Cloud** runs ComfyUI on Comfy Cloud GPUs. Nothing is installed on your machine and there is nothing to download. The card carries a **TRY FREE** pill while free Cloud runs are available. | ||
| - **Local** installs ComfyUI on this machine. You control the ComfyUI version, custom nodes, and startup arguments, and it runs offline. | ||
|
|
||
| If Comfy Desktop detects that this machine's GPU is not powerful enough for most workflows, the Cloud card carries a **Recommended for your hardware** badge and neither card is preselected, so the choice is deliberate rather than a default. **Continue** stays disabled until a card is selected. | ||
|
|
||
| ### Terms and data sharing | ||
|
|
||
| Three checkboxes sit below the cards: | ||
|
|
||
| - **I agree to the EULA and Terms of Service**: required. The links open the EULA, the Terms of Service, and the Privacy Policy. **Continue** does not proceed until this box is ticked, every time the setup runs. | ||
| - **Help improve Comfy by sharing anonymous usage data**: optional and ticked by default. Comfy Desktop sends anonymous usage data and never collects workflow contents, prompts, generated media, or personal information. You can change this later in [Desktop Settings](/installation/desktop/usage/settings). | ||
| - **Opt in to beta features and help test what ships next**: optional and ticked by default, and available only while data sharing is on. Clearing data sharing also clears this box. | ||
|
|
||
| ### Express Install | ||
|
|
||
|  | ||
|
|
||
| When **Local** is selected, an **Express Install with recommended settings** checkbox appears. It is cleared by default, so the install wizard shows the ComfyUI version, install location, and startup options before anything is written to disk. Tick it to skip that step and install a Standalone instance with the recommended settings. Comfy Desktop then names the hardware it detected under the checkbox, so you can clear it if the detected GPU is not the one you want to use. | ||
|
|
||
| ### Migrating an existing install | ||
|
|
||
| If Comfy Desktop finds a Legacy Desktop installation on the machine, a **Migrate existing instance** checkbox appears next to Express Install, ticked by default. Leave it ticked to bring your workflows, models, and settings over when you continue, see [Migrate from Legacy Desktop](/installation/desktop/usage/migrate) for what moves. Clear it to install a fresh instance instead. With both checkboxes cleared, Comfy Desktop asks once more before the install starts: select **Migrate** to bring the Legacy Desktop install over, or **Start Fresh** to install a clean instance and leave the existing projects in place. | ||
|
|
||
| ### Chinese mirrors | ||
|
|
||
| When the app runs in Chinese, the setup adds one question after **Continue**: **Enable Chinese Mirrors?** Select **Enable Mirrors** to clone Git repositories from `gitcode.com` and fetch PyPI packages from Aliyun and Tencent mirrors instead of `github.com` and `pypi.org`, which is faster in mainland China. Select **Not now** to keep the defaults. Either answer is stored as the **Use Chinese Mirrors (Git & PyPI)** setting, so you can change it later. | ||
|
Check warning on line 69 in installation/desktop/overview.mdx
|
||
|
|
||
| ### After setup | ||
|
|
||
| **Continue** saves your choices and shows a short **Preparing your install…** step. | ||
|
|
||
| - **Cloud**: Comfy Desktop closes the setup and launches Comfy Cloud. | ||
| - **Local**: the install wizard runs unless Express Install is on, the install shows its progress, and the finished instance appears on the dashboard. | ||
|
|
||
| If Comfy Desktop already has a standalone, tracked, or remote installation, it skips the Cloud or Local choice and takes you straight to the dashboard once the terms are accepted. Consenting is required every time the setup runs. | ||
|
|
||
| The setup is a full-screen takeover: the title bar is locked while it is open, and once you leave the consent step the app menu (☰) is reduced to a single **Skip Onboarding** item, which closes the setup and drops you on the dashboard without installing anything. | ||
|
|
||
| ## Usage Guide | ||
|
|
||
| Once installed, learn how to use Comfy Desktop: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,13 +16,13 @@ | |
| | Type | Icon | Description | | ||
| |------|------|-------------| | ||
| | **Standalone** | 💻 | A self-contained ComfyUI instance created by Comfy Desktop. Includes bundled Python, automatic updates, and full snapshot support. This is the default when you click **New Instance**. | | ||
| | **Cloud** | ☁️ | A Comfy Cloud instance. Requires a Comfy Cloud account. Cloud instances run on Comfy's servers and are billed separately. | | ||
| | **Remote** | 🌐 | Connects to a ComfyUI instance running on another machine on your network. Configure the remote host and port during setup. | | ||
| | **Tracked** | — | Tracks an existing ComfyUI installation (Git clone or portable). Uses the same icon as **Standalone** — there is no separate icon for tracked instances. You manage updates manually. See [Tracking an Existing Installation](#tracking-an-existing-installation). | | ||
|
|
||
| The image below labels the key actions available for each instance card: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 1. **New Instance**: Create a brand new ComfyUI instance. See [Creating a New Instance](#creating-a-new-instance). You can also [create an instance from a snapshot file](/installation/desktop/usage/snapshots#create-an-instance-from-a-snapshot-file). | ||
| 2. **⋮ Menu**: Click the three-dot icon to open the action menu for an instance. | ||
|
|
@@ -30,7 +30,7 @@ | |
| 4. **Restore Snapshot**: Revert the instance to a previous snapshot. See the [Snapshots](/installation/desktop/usage/snapshots) page. | ||
| 5. **Share**: Export a snapshot of the instance to share with others. | ||
| 6. **Copy Installation**: Duplicate an existing standalone installation with its own Python environment and custom nodes. See [Copying an Installation](#copying-an-installation). | ||
| 7. **Forget**: Remove the instance from the Chooser without deleting its files (equivalent to Untrack). | ||
| 8. **Uninstall**: Permanently delete the instance and all its files from disk. | ||
| See [Uninstalling an Instance](#uninstalling-an-instance) for details on Forget and Uninstall. | ||
|
|
||
|
|
@@ -48,6 +48,9 @@ | |
| <Tab title="macOS"> | ||
|  | ||
| </Tab> | ||
| <Tab title="Linux"> | ||
|  | ||
| </Tab> | ||
|
Comment on lines
+51
to
+53
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win Bring the localized pages into structural parity. Structure Parity fails for
📍 Affects 2 files
🤖 Prompt for AI AgentsSource: Pipeline failures |
||
| </Tabs> | ||
|
|
||
| 1. **Name**: The name of your instance. The default is "ComfyUI". | ||
|
|
@@ -58,17 +61,19 @@ | |
|
|
||
| If free space looks low, the wizard shows a **Low Disk Space** dialog. Choose **Continue Anyway**, or cancel and pick another path. | ||
|
|
||
|  | ||
|
|
||
| </Step> | ||
| <Step title="Installing"> | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Comfy Desktop will handle the rest: downloading Python, setting up the environment, and installing ComfyUI. The progress screen shows the current step. | ||
|
|
||
| </Step> | ||
| <Step title="Choose a Template"> | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Once the installation is complete, Comfy Desktop opens the template library where you can pick a workflow template to get started. | ||
|
|
||
|
|
@@ -126,6 +131,41 @@ | |
|
|
||
| > **Note:** Tracked installations use `launchMode: 'external'`. Comfy Desktop launches the existing ComfyUI process without managing it internally. Snapshots are currently supported for Standalone instances only. | ||
|
|
||
| ## Launching, Stopping, and Restarting an Instance | ||
|
|
||
| [↩ Back to overview](#overview) | ||
|
|
||
| ### Launching an Instance | ||
|
|
||
| Click an instance card in the Chooser to launch it. While ComfyUI starts, the window shows the startup progress, then the ComfyUI interface once the server is ready. | ||
|
|
||
| ### Launching While Another Instance Is Running | ||
|
|
||
| When you launch a local instance while another local instance is running or starting, Comfy Desktop shows an **An instance is already running** dialog that lists the instances it would stop: | ||
|
|
||
| - **Close & Launch**: stops the listed instances, then launches the one you picked. | ||
| - **Run All**: launches the new instance alongside the running ones. | ||
|
|
||
| Dismiss the dialog to cancel the launch. Restarting an instance never shows this dialog. To stop seeing it, turn off **Warn before running multiple instances** in [Desktop Settings → Preferences](/installation/desktop/usage/settings#preferences). | ||
|
|
||
| ### Stopping an Instance | ||
|
|
||
| Select **Stop** from the instance card's ⋮ menu. The ComfyUI server stops and the window stays open with a **ComfyUI is stopped** card. Select **Relaunch ComfyUI** to start the server again, or **Return to Dashboard** to go back to the Chooser. | ||
|
|
||
| ### Restarting After a Crash | ||
|
|
||
| If ComfyUI fails to start or exits unexpectedly, the window stays open with a card describing what happened: | ||
|
|
||
| - **ComfyUI could not start**: the instance did not start. | ||
| - **ComfyUI exited unexpectedly**: the process stopped. When Comfy Desktop can read it, the card also shows the exit code, or the signal that ended the process. | ||
|
|
||
| On Windows, a crash can report a memory access violation and note that some Microsoft Visual C++ Redistributable files appear to be missing. Expand the card's logs for details, then select **Restart ComfyUI** to launch again, or **Back** to return to the dashboard. | ||
|
|
||
| If ComfyUI stops because it cannot open the asset database it keeps inside the installation, the error it stops with explains the reason instead of only reporting an exit code: | ||
|
|
||
| - **Another ComfyUI is using this installation's database**: close that ComfyUI (or the app that started it), or give one of them its own database location with the `--database-url` startup argument. | ||
| - **Any other database failure**, from one locked by another program to one written by a newer version of ComfyUI or impossible to create in that folder: the message names the file and the fix, and ends with the option to start the instance without the asset system, by adding `--disable-assets` to its startup arguments. | ||
|
|
||
| ## Uninstalling an Instance | ||
|
|
||
| [↩ Back to overview](#overview) | ||
|
|
@@ -134,10 +174,10 @@ | |
|
|
||
|  | ||
|
|
||
| 1. **Forget / Untrack**: Removes the instance from the Chooser list without deleting any files. The installation folder and all its data remain on disk. Use this when you just want to clean up the list but might need the instance again later. | ||
| 2. **Uninstall / Delete**: Permanently removes the installation and all its files from disk. Model files in shared directories are not affected. | ||
|
|
||
| The name you see in the menu depends on the instance type: **Forget** appears for standalone installations (untrack doesn't apply because standalone installs are local), while **Untrack** appears for installations that were adopted or added manually. Both do the same thing: remove the instance from the list without deleting its files. | ||
|
Check warning on line 180 in installation/desktop/usage/instance-management.mdx
|
||
|
|
||
| ## Copying an Installation | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: Comfy-Org/docs
Length of output: 3755
The FAQ is contradictory. With Automatically install Desktop updates enabled, it says the update “installs without asking,” but the linked instructions require clicking Desktop Update Ready to restart and install it. Correct the FAQ to state that the update downloads automatically and requires clicking the title-bar button to restart and install.
🤖 Prompt for AI Agents