Edit Comfy Workflow

Edit Comfy Workflow

Use this when the graph needs to change. Follow the same shape as the agentic tests: identify the target, inspect it, materialize an editable Python surface if needed, make the smallest graph change, then validate.

Shared Edit Spine

Use the same spine as the Comfy app agent edit path and the structural/live agentic tests:

target graph -> inspect/research -> Python editable surface -> VibeWorkflow edit -> finalize_metadata -> validate/doctor -> candidate or run

For package-side edits, the editable surface is a recipe, scratchpad, or ready template. For the Comfy app, the same idea returns a candidate UI graph plus apply eligibility. Do not treat an edit candidate as an executed result; execution belongs to run-comfy-workflow.

Fast Path

vibecomfy inspect <target>
vibecomfy analyze info <target>

If the target is raw JSON, load it only as import evidence and materialize Python before editing:

vibecomfy port check <workflow.json> --json
vibecomfy port convert <workflow.json> --out out/scratchpads/<name>.py --json

If the target is a ready template and the edit is user-specific:

vibecomfy copy-to-recipe <ready_id> --out recipes/<name>.py

Then edit the Python recipe, scratchpad, or template.

Edit Shape

Use the lightest public API that fits:

from vibecomfy.cli_loader import load_bundle

def build():
    wf = load_bundle("image/z_image").workflow
    wf.set_prompt("a glass teapot on basalt")
    wf.set_seed(42)
    wf.set_steps(20)
    return wf.finalize_metadata()

Reach for patches when decorating an existing graph. Reach for blocks or direct VibeWorkflow methods only when the edit changes handles, splices nodes, or rewires topology.

Never invent node fields, sockets, or class names. Use vibecomfy nodes spec <ClassType>, visible graph data, local precedents, or search-comfy-workflows.

Validate

vibecomfy validate <edited.py>
vibecomfy doctor <edited.py> --json

For converted source workflows:

vibecomfy port doctor-all <source_or_edited_workflow> --json

If the edit adds custom nodes:

vibecomfy nodes install-plan <edited.py>

Return Shape

For package-side edits, return the edited file path and validation evidence:

• recipe/scratchpad/template path
• changed intent in plain language
• vibecomfy validate / vibecomfy doctor status
• any node/model install plan

For Comfy app style edits, the returned object is a candidate envelope: outcome.kind, candidate.graph, apply_eligibility, graph hashes, change details, and artifact paths such as candidate.ui.json / response.json. The user still has to Apply or run it.

Boundaries

• Do not run GPU work unless the user asked to execute or validation requires it.
• Do not promote a one-off composition to ready_templates; use recipes/.
• Keep upstream JSON close to upstream. Put local edits in Python.
• If the environment is missing, hand off to vibecomfy-setup; if execution fails, hand off to debug-comfy-workflow.