malkuthroandClaude Opus 4.7
1bde57bf4e
* docs: fix stale fork READMEs + retire outdated copilot-instructions forks/README.md and forks/radiance_koolook/README.md both still pointed at v1_0_1 as the active version — v1_0_1 was removed in v0.1.5; the only active fork is v2_3_3. Layout examples and the Upgrade Flow Example pivot forward (v2_3_3 → hypothetical v2_4_0), with a note about SKIP_VERSION_SUFFIX for stable user-facing IDs across upgrades. .github/copilot-instructions.md was severely out of date — referenced a nonexistent k_easy_version.py, knew nothing about the Kforge Labs sidebar (now the main feature), and had no mention of koolook_routes.py, dev-sync, or the three-axis versioning model. Replaced with a thin pointer to CLAUDE.md plus the high-stability orientation Copilot needs to place a request before following links — file map, "things that bite", redirect. Nice-to-have follow-ups filed as #113 (markdown mirror of the visual sidebar guide) and #114 (small cross-ref / glossary polish). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(forks): fix v2.3.3 namespace-suffix bullet in THIRD_PARTY.md The bullet claimed all exposed v2.3.3 node IDs are namespaced with `__koolook_v2_3_3`, but both currently-registered IDs (`Easy_hdr_VAE_encode`, `Easy_hdr_VAE_decode`) are Koolook-original names that opt out via `SKIP_VERSION_SUFFIX` in versions/v2_3_3/__init__.py. The new wording names the actual exposed IDs, points at the opt-out set, and explains the reserved use of the `__koolook_v2_3_3` suffix for future ports of upstream-named classes. Caught in PR #115 review — the linked target (THIRD_PARTY.md) was contradicting the new forks/README.md and CLAUDE.md text on the same mechanism. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4.0 KiB
4.0 KiB
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:
-
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.
- Front-end entry:
web/koolook_sidebar.js; module bodies underweb/sidebar/. - Back-end snapshot/preset routes:
koolook_routes.py(registers/koolook/presets/*aiohttp routes on ComfyUI's PromptServer). - Bundled visual onboarding guide:
web/guide/index.html(also opened in-app via the sidebar's Tools-row Help button).
- Front-end entry:
-
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):k_easy_wan22_prompt.py→EasyWan22Prompt(readsconfig.jsonat import time — edits toconfig.jsonneed a ComfyUI restart).k_easy_resize.py→EasyResize_Koolook(deprecated aliasEasyResizestill registered for back-compat).k_ai_pipeline.py→EasyAIPipeline(paired with front-end widgets inweb/ai_pipeline.js).k_easy_image_batch.py→easy_ImageBatch.k_easy_track.py→KoolookLoadCameraPosesAbsolute.- Radiance VAE wrappers under
forks/radiance_koolook/versions/v2_3_3/→Easy_hdr_VAE_encode,Easy_hdr_VAE_decode.
__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
- Node IDs in saved workflows are stable. Never rename a registered node
ID without a back-compat alias — see
docs/maintainers/node-versioning.md. - 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/. Seeforks/README.mdandforks/THIRD_PARTY.md. dev-syncis 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 inCLAUDE.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.mdbefore any version bump.
Where to look next
CLAUDE.md— full project conventions and protocolsdocs/maintainers/— release procedure, dev-sync loop, registry API, sidebar starter preset, workflows-sidebar referencedocs/reference/— glossary, versioning modeldocs/user_guide/— per-node end-user docsREADME.md— public landing page + installCHANGELOG.md— what changed, in detail