ComfyScript v0.6.0: Simpler to use

Note

ComfyScript is a Python frontend and library for ComfyUI. See README for details and examples.

New features

• Python 3.14 support

  (Solara UI doesn't support Python 3.14 yet: widgetti/solara#1108)

• Runtime

  • ComfyUI v3 schema support (#113,#85)

  • Add util module with some utlity functions (#29,#47,#76)

    • get_int, get_float, get_str and get_images
    • concat_images
    • save_image and save_image_cwd
    • save_image_and_get_paths and load_image_from_paths

    For example:

    latent = KSampler(...)
    image = VAEDecode(latent, vae)
    images = util.get_images(image)
    # `images` is of type `list[PIL.Image.Image]`

  • Add node module with nodes and get properties (#17, #30, #59)

    See util module for examples.

  • Virtual mode

    • Workflow only queues unqueued outputs (#29)
    • Support progress callbacks (#36,#102)
    • Wake result() when set new output (#108)

  • Change StrEnum stub type to StrEnum | str (#71, @dwgrth)

  • Using loaded comfyui if inside comfyui (#104)

  • Share comfyui package context vars by default

Docs

• Installation

  • Update installing only ComfyScript package (#3,#115,#95)

    Install/update ComfyScript:

    python -m pip install -U "comfy-script[default]"

    Save and run the following code to test (e.g. python examples/runtime.py):

    from comfy_script.runtime import *
    # ComfyUI server/path
    # or: load(r'path/to/ComfyUI')
    load('http://127.0.0.1:8188/')
    from comfy_script.runtime.nodes import *
    
    with Workflow(wait=True):
        image = EmptyImage()
        images = util.get_images(image, save=True)

    Or without installing Python, directly use ComfyScript with uv:

    uv run examples/uv.py

    examples/uv.py:

    # /// script
    # requires-python = ">=3.9"
    # dependencies = [
    #     "comfy-script[default]",
    # ]
    # ///
    from comfy_script.runtime import *
    load('http://127.0.0.1:8188/')
    from comfy_script.runtime.nodes import *
    
    with Workflow(wait=True):
        image = EmptyImage()
        images = util.get_images(image, save=True)

  • Add installing with ComfyUI & uv venv

  • Add VS Code Notebook kernel list troubleshooting

  • Bump comfyui package tested version (#33,#29)

• Transpiler: Update usage

  If you installed ComfyScript outside of ComfyUI, you can still use the transpiler by:

  • CLI

    python -m comfy_script.transpile "workflow.json" --api http://127.0.0.1:8188/

    Or without installing ComfyScript, directly with uv:

    uvx --from "comfy-script[default]" python -m comfy_script.transpile "workflow.json" --api http://127.0.0.1:8188/

  • Python code
  • Jupyter Notebook / web: MetadataViewer

• Runtime

  • Add docs for Workflow context manager

• Images: Add metadata (#19)

• Models

  • Add saving checkpoints (#82)
  • Add note about comfyui package path (#68,#69)

• Examples

  • Add plotting, ui and flux examples (#3)
  • Fix Modal example return PIL images (#73)

• Add projects using this library and some examples (#108)

  • CarbBot: Simple Discord Bot for interfacing with ComfyUI and/or the Stability AI API for text2image generation using the SDXL model
  • comfy-character-app: A ComfyUI and ComfyScript Gradio-based app for generating characters using a multi-step process.
  • io_comfyui: Let Blender work with ComfyUI by ComfyScript.
  • Mea comfy wrap: Simple script for wraping comfy ui workflows for future usage as a micro services with gRPC interface
  • the-searcher-SD: proof of concept of a tool to enhance likeness of subjects in SDXL
  • Randomize_ComfyScript: Randomizer script for ComfyUI using ComfyScript

• Add differences from ComfyUI-to-Python-Extension

Changes

• cli extra (optional dependencies) is now enabled by default

  click is ~100KB. You can still disable this if you like.

Fixes

• Runtime
  • main.server is no longer the server instance (#86)
  • ComfyUI LogInterceptor breaks Jupyter Notebook
  • redirect __main__.__file__ to ComfyUI/main.py (#89)
  • Node/output type namespace confusion (#22)
  • Virtual mode
    • Node output may be None
    • Extra bool inputs (#22, #80)
    • Output types may be lists (#9,#106)
  • Real mode
    • Unpack result for non-output nodes (#85)
    • Support kwds only valid for prompt (#85)
    • replace invalid chars in type stubs with � (#87)
    • Bool enum conversions (#91)
    • new node with original class (#112)
  • comfyui package breaks cli_args
  • comfyui package LogInterceptor breaks Jupyter Notebook too
  • comfyui package receive_all_progress_notifications is readonly now (#65)
• Transpiler
  • Avoid move same input multiple times (#55)
  • Prompt ignore hidden inputs (#85)
• Nodes
  • Update ComfyUI_Ib_CustomNodes to fix PILToImage and PILToMask (#83)