Skip to content

AGENTS.md

Latest commit

 

History

History
152 lines (110 loc) · 5.18 KB

AGENTS.md

File metadata and controls

152 lines (110 loc) · 5.18 KB

ComfyUI Desktop - Claude Code Instructions

Project Overview

ComfyUI Desktop (@comfyorg/comfyui-electron) is an Electron-based desktop application that packages ComfyUI with a user-friendly interface. It's "the best modular GUI to run AI diffusion models" and automatically handles Python environment setup, dependency management, and provides a seamless desktop experience for running AI models.

Key Technologies

  • Electron: Desktop app framework
  • TypeScript: Primary language
  • Vite: Build tool and bundler
  • Node.js: Runtime (use nvm)
  • Yarn: Package manager
  • Vitest: Unit testing
  • Playwright: E2E testing
  • ESLint: Linting
  • Prettier: Formatting

Development Commands

Code Quality (ALWAYS RUN AFTER CHANGES)

yarn lint              # Check & auto-fix ESLint issues
yarn format            # Auto-format code
yarn typecheck         # TypeScript type checking (all)

Development

yarn start             # Build and launch app with file watching
yarn make:assets       # Download ComfyUI dependencies
yarn clean             # Remove build artifacts

Testing

yarn test:unit         # Run unit tests (Vitest)
yarn test:e2e          # Run E2E tests (Playwright)
yarn test:e2e:update   # Update Playwright snapshots

Building

yarn make              # Build platform package
yarn make:nvidia       # Build with NVIDIA GPU support
yarn vite:compile      # Compile with Vite

Troubleshooting

  • If you encounter errors regarding NODE_MODULE_VERSION, try running npx electron-rebuild before other troubleshooting steps.
    • If that still fails, try yarn rebuild

Custom testing

We have testing configured with Vitest. Use vitest to create any tests you need. Do not attempt to custom code your own testing infrastructure, as that is pointless and will do nothing but derail you.

Project Structure

Source Code (/src/)

  • main.ts: Main Electron process entry point
  • desktopApp.ts: Core application logic
  • preload.ts: Electron preload script
  • main-process/: Main process modules
    • comfyDesktopApp.ts - ComfyUI server management
    • appWindow.ts - Window management
    • comfyServer.ts - Server lifecycle
  • install/: Installation & setup logic
  • handlers/: IPC message handlers
  • services/: Core services (telemetry, Sentry)
  • config/: Configuration management
  • store/: Persistent storage
  • utils.ts: Utility functions

Tests (/tests/)

  • unit/: Vitest-based component tests
  • integration/: Playwright E2E tests
    • install/ - Fresh installation testing
    • post-install/ - Tests after app setup
    • shared/ - Common test functionality

Development Setup

  • Python 3.12+ with virtual environment support required
  • Node.js v20.x (use nvm for version management)
  • Visual Studio 2019+ with C++ workload (Windows)
  • Spectre-mitigated libraries for node-gyp compilation

Important Files & Configuration

  • package.json: Defines ComfyUI versions and dependencies
  • assets/requirements/: Pre-compiled Python requirements by platform
  • todesktop.json: Cloud build and distribution config
  • builder-debug.config.ts: Local development build settings
  • Multi-config Vite setup with separate configs for main, preload, and types

Bundled Components

The app packages these components:

  • ComfyUI: AI diffusion model GUI
  • ComfyUI_frontend: Modern web frontend
  • ComfyUI-Manager: Plugin/extension manager
  • uv: Fast Python package manager

Development Environment Variables

  • --dev-mode: Flag for packaged apps in development
  • COMFY_HOST/COMFY_PORT: External server for development
  • VUE_DEVTOOLS_PATH: Frontend debugging support

Platform-Specific Paths

  • Windows: %APPDATA%\ComfyUI (config), %LOCALAPPDATA%\Programs\ComfyUI (app)
  • macOS: ~/Library/Application Support/ComfyUI
  • Linux: ~/.config/ComfyUI

Code Style & Conventions

  • Follow existing TypeScript patterns in the codebase
  • Use ESLint and Prettier for code formatting
  • Maintain clean separation between main process, renderer, and preload scripts
  • Follow Electron security best practices
  • Use the existing store patterns for configuration management
  • Test changes with both unit tests (Vitest) and E2E tests (Playwright)
  • Use JSDoc format to write documentation for methods
    • Common tags are @param, and @return (do not use for void return type)
    • Use {@link } to reference symbols

Type constraints

This project must maintain exceptionally high type standards. The any type must not be used. unknown can be used when the type is unknown.

  • unknown means "I do not know what the type is".
  • any means "I do not care what the type is".

Before Committing

  1. Use yarn format to ensure consistent formatting
  2. Run yarn lint and yarn typecheck to check code quality
  3. Run yarn test:unit to ensure unit tests pass
  4. Consider running yarn test:e2e for UI changes

This is a sophisticated Electron application with comprehensive testing, automated CI/CD, cross-platform support, and professional development practices.
⚡