base on The desktop app for ComfyUI (Windows & macOS) # ComfyUI Desktop  # USER GUIDE Please read the [user guide](https://docs.comfy.org/installation/desktop) # Download Windows (NVIDIA) NSIS x64: [Download](https://download.comfy.org/windows/nsis/x64) macOS ARM: [Download](https://download.comfy.org/mac/dmg/arm64) # Overview This desktop app is a packaged way to use [ComfyUI](https://github.com/comfyanonymous/ComfyUI) and comes bundled with a few things: - Stable version of ComfyUI from [releases](https://github.com/comfyanonymous/ComfyUI/releases) - [ComfyUI_frontend](https://github.com/Comfy-Org/ComfyUI_frontend) - [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) (installed via pip when `--enable-manager` is set; legacy custom node is only cloned for older ComfyUI versions) - [uv](https://github.com/astral-sh/uv) On startup, it will install all the necessary python dependencies with uv and start the ComfyUI server. The app will automatically update with stable releases of ComfyUI, ComfyUI-Manager (pip), and the uv executable as well as some desktop-specific features. Developers, read on. ## Installed Files ### Electron The desktop application comes bundled with: - ComfyUI source code - ComfyUI-Manager (pip package or legacy custom node, depending on the bundled ComfyUI version) - Electron, Chromium binaries, and node modules **Windows** We use the [NSIS installer](https://www.electron.build/nsis.html) for Windows and it will install files in these locations: Bundled Resources: `%APPDATA%\Local\Programs\comfyui-electron`  User files are stored here: `%APPDATA%\ComfyUI` Automatic Updates: `%APPDATA%\Local\comfyui-electron-updater` **macOS** The macOS application is distributed as a [DMG](https://www.electron.build/dmg) and will install files in: `~/Library/Application Support/ComfyUI` The application will be dragged into `/Applications` **Linux** `~/.config/ComfyUI` ### ComfyUI You will also be asked to select a location to store ComfyUI files like models, inputs, outputs, custom_nodes and saved workflows. This directory is stored in the `basePath` key of `config.json`. On Windows: `%APPDATA%\ComfyUI\config.json` On macOS: `~/Library/Application Support/ComfyUI/config.json` On Linux: `~/.config/ComfyUI/config.json` #### Model Paths This directory is also written as the `base_path` in `extra_models_config.yaml`. The Desktop app will look for model checkpoints here by default, but you can add additional models to the search path by editing this file. On Windows: `%APPDATA%\ComfyUI\extra_models_config.yaml` On macOS: `~/Library/Application Support/ComfyUI/extra_models_config.yaml` On Linux: `~/.config/ComfyUI/extra_models_config.yaml` ### Logs We use electron-log to log everything. Electron main process logs are in `main.log`, and ComfyUI server logs are in `comfyui_<date>.log`. ``` on Linux: ~/.config/{app name}/logs on macOS: ~/Library/Logs/{app name} on Windows: %AppData%\{app name}\logs ``` # Development ## Setup Python Make sure you have python 3.12+ installed. It is recommended to setup a virtual environment. Linux/MacOS: ```bash python -m venv venv source venv/bin/activate ``` Windows: ```powershell py -3.12 -m venv venv .\venv\Scripts\Activate.ps1 ``` ## Windows ### Visual Studio Visual studio 2019 or later with the Desktop C++ workload is required for `node-gyp`. See the `node-gyp` [windows installation notes](https://github.com/nodejs/node-gyp#on-windows). Also requires the `spectre-mitigated` libraries, found in the individual components section of the VS installer. Confirmed working: - Visual Studio Community 2022 - 17.12.1 - Desktop development with C++ workload - MSVC v143 x64 spectre-mitigated libraries (Latest / v14.42-17.12) - Open the Visual Studio Installer - Click "Modify" on your Visual Studio 2022 Community installation - Go to the "Individual Components" tab - Search for "Spectre" - Check the boxes for the Spectre-mitigated libraries that match your project's architecture (x86 and/or x64) -  Look for "MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs" If you're using other toolsets, you may need their corresponding Spectre-mitigated libraries as well ## NPM Dependencies ### Node We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage node versions. This project uses node v20.x. #### Windows Microsoft recommends [nvm-windows](https://github.com/coreybutler/nvm-windows) on their [Node.js on Windows page](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows#install-nvm-windows-nodejs-and-npm). ```ps1 nvm install 20 nvm use 20 ``` ### Yarn This project uses `yarn` as its package manager. If you do not already have a `yarn` binary available on your PATH, run: ```bash # corepack is a set of utilities included with all recent distributions of node corepack enable yarn set version 4.5.0 # Look at the packageManager key in package.json for the exact version. ``` This will install a usable `yarn` binary. Then, in the root directory of this repo (ie adjacent to the top-level package.json file), run: ```bash yarn install ``` ## ComfyUI Assets Before you can start the electron application, you need to download the ComfyUI source code and other things that are usually bundled with the application. ### ComfyUI and other dependencies First, initialize the application resources by running `yarn make:assets`: This command will install ComfyUI under `assets/`. If the bundled ComfyUI version contains `manager_requirements.txt`, ComfyUI-Manager will be installed via pip at runtime; otherwise the legacy custom node is cloned for compatibility. The exact versions of each package is defined in `package.json`. You can then run `start` to build and launch the app. A watcher will also be started; it will automatically rebuild the app when a source file is changed: ```bash deactivate # Deactivate your existing python env to avoid influencing the yarn start ``` You can also build the package and/or distributables using the `make` command: ```bash # build the platform-dependent package and any distributables yarn make # build cross-platform, e.g. windows from linux yarn make --windows ``` ### Compiled Requirements The `requirements.compiled` file is a pre-compiled requirements file that is used to install the dependencies for the application. It is generated by the `comfy-cli`. You can generate the compiled requirements files by running the following commands from the project root directory: #### Windows ```powershell ## Nvidia Cuda requirements uv pip compile assets\ComfyUI\requirements.txt assets\ComfyUI\manager_requirements.txt --emit-index-annotation --emit-index-url --index-strategy unsafe-best-match -o assets\requirements\windows_nvidia.compiled --override assets\override.txt ` --index-url https://pypi.org/simple ` --extra-index-url https://download.pytorch.org/whl/cu129 ## CPU requirements uv pip compile assets\ComfyUI\requirements.txt assets\ComfyUI\manager_requirements.txt --emit-index-annotation --emit-index-url --index-strategy unsafe-best-match -o assets\requirements\windows_cpu.compiled ` --index-url https://pypi.org/simple ``` #### macOS ```bash ## macOS requirements uv pip compile assets/ComfyUI/requirements.txt assets/ComfyUI/manager_requirements.txt --emit-index-annotation --emit-index-url --index-strategy unsafe-best-match -o assets/requirements/macos.compiled --override assets/override.txt \ --index-url https://pypi.org/simple ``` If you are working with a legacy ComfyUI bundle that does not include `manager_requirements.txt`, replace that path in the commands above with `assets/ComfyUI/custom_nodes/ComfyUI-Manager/requirements.txt`. ### Troubleshooting If you get an error similar to: ``` The module '/electron/node_modules/node-pty/build/Release/pty.node' was compiled against a different Node.js version using NODE_MODULE_VERSION 115. This version of Node.js requires NODE_MODULE_VERSION 125. Please try re-compiling or re-installing the module (for instance, using `npm rebuild` or `npm install`). ``` You will need to rebuild the node-pty using [electron-rebuild](https://www.electronjs.org/docs/latest/tutorial/using-native-node-modules), for example: ``` npx electron-rebuild ``` or if that fails ``` yarn add -D @electron/rebuild rm -rf node_modules rm yarn.lock yarn install npx electron-rebuild ``` #### Missing libraries You may get errors reporting that the build is unable to find e.g. `libnss3.so` if `electron` prerequisites are not included in your distro. Find the correct package for your distro and install. `apt` example: ``` apt-get install libnss3 ``` ### Debugger There are helpful debug launch scripts for VSCode / Cursor under `.vscode/launch.json`. The default launch script runs the Electron launcher in the project root and attaches the debugger. By default, the app is not built when this is used. The default launch script can be run by pressing `F5` in VSCode or VSCode derivative. `Ctrl + Shift + F5` restarts the app with the debugger attached. `Shift + F5` terminates the debugger and the process tree it is attached to. To keep the app built and up to date as you make changes, run the `Start Vite Build Watchers` build task defined in `.vscode/tasks.json`. This spawns two watcher tasks - one for the main app, and one for the preload script. These watchers will automatically rebuild the app when a source file is changed. The launch environment can be customised, e.g. add a `"linux"` section to source your `~/.profile` (and other interactive config) when debugging in linux: ```json { "version": "2.0.0", "tasks": [ { "linux": { "options": { "shell": { "args": ["-ci"] } } } } ] } ``` ### Troubleshooting the packaged app When the app has been packaged for use as a production app, it ignores environment variables used to configure development settings. To force the app to read env vars when packaged, use the `--dev-mode` command line argument to launch the app. # Release We use Todesktop to build and codesign our distributables. To make a new release: 1. Create a PR that updates package.json to the next version. 1. Create a Github Release with semantic version tag eg. "v1.0.0" 1. Make sure it is a pre-release. 1. Check the Github action "Publish All" runs. It should update the release body with Download links when it is finished. 1. Test the build, and if it looks good release it on ToDesktop. Also mark the release as "Latest". If a build fails for some reason, you can manually retry by running the "Publish All" GH action with a release tag as input. ## Release using Claude Code There is a Claude Code command, "bump-stable", that can be used to automate the release process. ## Updating uv compiled requirements Applying the "Update Compiled Requirements" label to an open PR will automatically update compiled requirements. If changes are made, the action commits the updated files to the PR. ## Utility scripts A number of utility scripts are defined under the "scripts" field of package.json. For example, to clean up the build artifacts you can run: ```bash yarn clean # Remove files created by yarn make:assets yarn clean:assets # clean:slate also removes node_modules yarn clean:slate ``` ## Crash Reports & Metrics At the onboarding step, you can opt-in to send us usage metrics. This really helps us prioritize issues and focus our limited engineering time. Read our privacy policy [here](https://comfy.org/privacy). You can opt-out at anytime from the settings menu and nothing will ever be sent. In either case, no personal data, workflows or logs will be sent. ", Assign "at most 3 tags" to the expected json: {"id":"12342","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"