92 lines
4.2 KiB
Markdown
92 lines
4.2 KiB
Markdown
# ComfyUI-ComfySidebar
|
|
|
|
A compact and powerful layout overhaul for ComfyUI that makes generation results easier to browse, preview, compare, and manage.
|
|
|
|
## ✨ Features
|
|
|
|
* **Compact, information-dense layout** with visual previews that let you see what is happening at a glance. Optional UI elements and sidebar tabs can be hidden when you don't need them.
|
|
|
|
<img src="assets/layout.png" alt="ComfySidebar layout" width="100%">
|
|
|
|
* **Left or right side:** Choose which side the sidebar appears on in ComfyUI settings.
|
|
|
|
* **Simplified mouse-friendly workflow** with drag-and-drop support and convenient actions for moving results back into the workflow, opening files, and managing outputs. Hold `Ctrl` for extra actions such as opening an image's location or deleting it directly from your device.
|
|
|
|
<img src="assets/controls.png" alt="ComfySidebar controls overview" width="100%">
|
|
|
|
* **Built-in comparison tool** for quickly comparing two generated results side by side.
|
|
|
|
<img src="assets/compare.png" alt="ComfySidebar compare" width="100%">
|
|
|
|
* **[NEW] Output Gallery sidebar:** Browse files and subfolders directly from your ComfyUI `output` directory without leaving the interface. Features dedicated cards for images, videos, audio, and 3D assets (`.glb`/`.gltf`), breadcrumb navigation, filename and prompt metadata search across subfolders, and persistent sorting.
|
|
|
|
* **Hotkeys on any keyboard layout:** Shortcuts such as `Q`, `Ctrl+Q` and `Alt+R` keep working while a non-Latin layout (for example Russian) is active. Non-Latin keys are treated as the Latin key in the same physical position, and typing in text fields is not affected. Can be turned off with **Fix non-ASCII keybinds** in the settings.
|
|
|
|
* **Runtime preview mode** combined with workflow overview makes ComfyUI practical for running and monitoring workflows in a more streamlined, queue-oriented way.
|
|
|
|
<img src="assets/runtime.png" alt="ComfySidebar runtime mode" width="100%">
|
|
|
|
## 🛠️ Installation
|
|
|
|
### ComfyUI Registry
|
|
|
|
Install directly from the ComfyUI Manager or run:
|
|
|
|
```bash
|
|
comfy node install comfy-sidebar
|
|
```
|
|
|
|
ComfySidebar is available on the [ComfyUI Registry](https://registry.comfy.org/publishers/soundslikethunder/nodes/comfy-sidebar).
|
|
|
|
### Manual installation
|
|
|
|
Clone the repository into your ComfyUI custom nodes directory:
|
|
|
|
```bash
|
|
cd /path/to/ComfyUI/custom_nodes
|
|
git clone https://github.com/m0rtus59/ComfyUI-ComfySidebar.git
|
|
```
|
|
|
|
Restart ComfyUI and refresh the browser.
|
|
|
|
## ⚙️ Settings
|
|
|
|
Open **Settings → Comfy Sidebar** to configure:
|
|
|
|
* Queue layout and column width
|
|
* Queue display mode
|
|
* Working node display
|
|
* Automatic cleanup of cancelled or failed jobs
|
|
* Sidebar tabs to hide
|
|
* Stock Job History replacement
|
|
* Graph button visibility
|
|
* Unified top bar layout
|
|
* Permanent deletion behavior
|
|
* Output Gallery sidebar toggle
|
|
* Fix non-ASCII keybinds (hotkeys on any keyboard layout)
|
|
|
|
## ⌨️ Controls
|
|
|
|
| Shortcut | Action |
|
|
| ------------- | ---------------------------------------------- |
|
|
| `Q` | Toggle ComfySidebar |
|
|
| `Ctrl+Q` | Exclude the selected node from sidebar results |
|
|
| `Alt+R` | Renumber nodes in execution order |
|
|
| `Click` | Open result preview |
|
|
| `Shift+Click` | Compare another result |
|
|
| `Ctrl+Click` | Open the file location / alternative action |
|
|
|
|
`Q` is a regular ComfyUI keybinding, so you can see and change it in **Settings → Keybinding**.
|
|
|
|
You can also use the available actions from result cards, the sidebar header, and the node/canvas context menus.
|
|
|
|
## 📝 Notes
|
|
|
|
ComfySidebar integrates with the ComfyUI frontend and depends on parts of its UI structure. Frontend changes in ComfyUI may require updates to this extension.
|
|
|
|
**Keyboard layouts:** the *Fix non-ASCII keybinds* option only re-maps keys that produce a non-ASCII character, so QWERTY, AZERTY and Dvorak users are not affected. It cannot help with layouts that type a *different ASCII* symbol on a key (for example, `+` where a US layout has `=`). ComfyUI's "edit keybinding" dialog still records the typed character, so switch to an English layout while rebinding a key.
|
|
|
|
## License
|
|
|
|
See [LICENSE](LICENSE).
|