aimusic / ComfyUI /custom_nodes /koolook /.github /copilot-instructions.md
vidfom's picture
Upload folder using huggingface_hub (part 7)
e4ab0d4 verified
|
Raw
History Blame Contribute Delete
4.71 kB

GitHub Copilot β€” repo orientation

Thin pointer. The canonical agent context lives in CLAUDE.md at the repo root β€” read that first for source-of-truth conventions, dev-sync rules, release rules, fork policy, and trigger phrases. This file only carries the high-stability orientation that helps Copilot place a request before it follows links.

What this repo is

ComfyUI-Koolook is a custom-node pack for ComfyUI. Two shipped surfaces:

  1. Kforge Labs sidebar β€” the main user-facing experience. A ComfyUI sidebar tab that saves favorite nodes, workflows (with subdirectories + archive + tags + reusable modules), and full-state snapshots to a configurable on-disk library.

  2. Koolook custom nodes β€” Python node classes at the repo root, each exposing the standard ComfyUI node contract (INPUT_TYPES, RETURN_TYPES, RETURN_NAMES, FUNCTION, CATEGORY):

__init__.py imports each module's NODE_CLASS_MAPPINGS / NODE_DISPLAY_NAME_MAPPINGS and exposes the merged set plus WEB_DIRECTORY.

Things that bite if you don't know them

  • Backward compatibility is opt-in for Koolook-created nodes only (the root k_*.py custom nodes). For those, make the cleanest change by default β€” rename/drop/reorder IDs, inputs, and outputs freely, no aliases or _v2 suffixes β€” unless the maintainer says check backward compatibility. Fork nodes are different: anything under forks/ keeps full back-compat discipline by default (never rename a fork ID in saved workflows, version via new suffix/namespace, keep the __koolook_vX_Y_Z collision suffix). See docs/maintainers/node-versioning.md and CLAUDE.md β†’ Change management.
  • Third-party code stays out of MAIN. Modified fork code lives under forks/<name>/versions/<vX_Y_Z>/; raw upstream checkouts live in ../ComfyUI-Forks/. See forks/README.md and forks/THIRD_PARTY.md.
  • dev-sync is user-triggered only. Never run it automatically (e.g. after a commit, after a merge, on session end). The maintainer runs parallel worktrees and an unsolicited sync overwrites whatever they're reviewing in their live ComfyUI. Wait for the explicit phrase. Full rules in CLAUDE.md.
  • UI work needs visual QA. See AGENTS.md β€” open the changed page in a browser, take a screenshot, verify before claiming done.
  • Three independent version axes (pack version / fork wrapper version / upstream pinned commit) β€” see docs/reference/versioning.md before any version bump.

Where to look next