README.md

ComfyUI_frontend

Official front-end implementation of ComfyUI.

Release Schedule

Nightly Release

Nightly releases are published daily at https://github.com/Comfy-Org/ComfyUI_frontend/releases.

To use the latest nightly release, add the following command line argument to your ComfyUI launch script:

--front-end-version Comfy-Org/ComfyUI_frontend@latest

For Windows Stand-alone Build Users

Edit your run_cpu.bat or run_nvidia_gpu.bat file as follows:

.\python_embeded\python.exe -s ComfyUI\main.py --windows-standalone-build --front-end-version Comfy-Org/ComfyUI_frontend@latest
pause

Stable Release

Stable releases are published weekly in the ComfyUI main repository, aligned with ComfyUI backend's stable release schedule.

Feature Freeze

There will be a 2-day feature freeze before each stable release. During this period, no new major features will be merged.

Release Summary

Major features

v1.2.4: Node library sidebar tab

Drag & Drop

nodelib_dnd.mp4

Filter

nodelist_filter.mp4

v1.2.0: Queue/History sidebar tab

QueueDemo2.mp4

v1.1.0: Node search box

Fuzzy search & Node preview

Release link with shift

07.07.2024_23.27.39_REC.mp4

QoL changes

v1.2.44: **Litegraph** Double click group title to edit

groupTitleEditDemo.mp4

v1.2.39: **Litegraph** Group selected nodes with Ctrl + G

quickGroupDemo.mp4

v1.2.38: **Litegraph** Double click node title to edit

editFinalDemo.mp4

v1.2.7: **Litegraph** drags multiple links with shift pressed

batch_connect_demo.mp4

batch_disconnect.mp4

v1.2.2: **Litegraph** auto connects to correct slot

Before

link_slot_broken.mp4

After

link_slot_fixed.mp4

v1.1.8: **Litegraph** hides text overflow on widget value

overflowfix.mp4

Node developers API

v1.2.4: Extension API to register custom sidebar tab

Extensions now can call the following API to register a sidebar tab.

  app.extensionManager.registerSidebarTab({
    id: "search",
    icon: "pi pi-search",
    title: "search",
    tooltip: "search",
    type: "custom",
    render: (el) => {
      el.innerHTML = "<div>Custom search tab</div>";
    },
  });

The list of supported icons can be found here: https://primevue.org/icons/#list

We will support custom icons later.

v1.2.27: Extension API to add toast message

Extensions can call the following API to add toast messages.

  app.extensionManager.toast.add({
    severity: 'info',
    summary: 'Loaded!',
    detail: 'Extension loaded!',
    life: 3000
  })

Documentation of all supported options can be found here: https://primevue.org/toast/#api.toast.interfaces.ToastMessageOptions

Road Map

What has been done

• Migrate all code to TypeScript with minimal change modification to the original logic.
• Bundle all code with Vite's rollup build.
• Added a shim layer to be backward compatible with the existing extension system. https://github.com/huchenlei/ComfyUI_frontend/pull/15
• Front-end dev server.
• Zod schema for input validation on ComfyUI workflow.
• Make litegraph a npm dependency. Comfy-Org#89
• Introduce Vue to start managing part of the UI.
• Easy install and version management (comfyanonymous/ComfyUI#3897).
• Better node management. Sherlock https://github.com/Nuked88/ComfyUI-N-Sidebar.
• Replace the existing ComfyUI front-end implementation. comfyanonymous/ComfyUI#4379

What to be done

• Remove @ts-ignores.
• Turn on strict on tsconfig.json.
• Add more widget types for node developers.
• LLM streaming node.
• Linear mode (Similar to InvokeAI's linear mode).
• Keybinding settings management. Register keybindings API for custom nodes.

Development

Git pre-commit hooks

Run npm run prepare to install Git pre-commit hooks. Currently, the pre-commit hook is used to auto-format code on commit.

Dev Server

Note: The dev server will NOT load any extension from the ComfyUI server. Only core extensions will be loaded.

• Run npm install to install the necessary packages
• Start local ComfyUI backend at localhost:8188
• Run npm run dev to start the dev server

Test

• git clone https://github.com/comfyanonymous/ComfyUI_examples.git to tests-ui/ComfyUI_examples or the EXAMPLE_REPO_PATH location specified in .env
• npm i to install all dependencies
• npm run test:generate to fetch tests-ui/data/object_info.json
• npm run test:generate:examples to extract the example workflows
• npm run test to execute all unit tests.

LiteGraph

This repo is using litegraph package hosted on https://github.com/Comfy-Org/litegraph.js. Any changes to litegraph should be submitted in that repo instead.

Test litegraph changes

• Run npm link in the local litegraph repo.
• Run npm uninstall @comfyorg/litegraph in this repo.
• Run npm link @comfyorg/litegraph in this repo.

This will replace the litegraph package in this repo with the local litegraph repo.

Deploy

• Option 1: Set DEPLOY_COMFYUI_DIR in .env and run npm run deploy.
• Option 2: Copy everything under dist/ to ComfyUI/web/ in your ComfyUI checkout manually.

Publish release to ComfyUI main repo

Run following command to publish a release to ComfyUI main repo. The script will create a new branch and do a commit to web/ folder by checkout dist.zip from GitHub release.

• python scripts/main_repo_release.py <path_to_comfyui_main_repo> <version>