docs: document registry-install & --fast-deps, fix node-install example#587
docs: document registry-install & --fast-deps, fix node-install example#587mattmillerai wants to merge 1 commit into
Conversation
…xample Add README documentation for the two custom-node install paths (comfy node install vs registry-install), document the --fast-deps flag (which commands accept it and why registry-install does not), and add a note explaining that node-install arguments are lowercase Comfy Registry IDs — the source of the 'Node "ComfyUI-Impact-Pack@unknown" not found' error reported in #257. Closes #257
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 35 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
There was a problem hiding this comment.
🔍 Cursor Review — Consolidated panel
Triggered by @mattmillerai.
✅ No high-signal findings.
Panel: 6/8 reviewers contributed findings.
Reviewers that did not contribute: kimi-k2.5:adversarial (empty), kimi-k2.5:edge-case (empty)
ELI-5
If you told comfy-cli to install a node using its GitHub-style name
(
ComfyUI-Impact-Pack), it failed with a confusingNode 'ComfyUI-Impact-Pack@unknown' not founderror, because the command actuallywants the node's lowercase Comfy Registry ID (
comfyui-impact-pack). Also,comfy-cli has two different install commands (
installandregistry-install)and a
--fast-depsspeed flag that were never explained. This PR is docs-only:it explains all of that in the README so nobody hits the same wall.
What changed
Documentation only (
README.md) — no code changes.comfy node installexample clarifying the argument is the node's lowercase Comfy Registry ID,
not the GitHub repo name, and that the wrong casing produces the
Node '...@unknown' not founderror from the issue.installvsregistry-install— new section explaining thatinstalldelegates to ComfyUI-Manager's
cm-cli(multi-node, channel/mode-aware,supports the dependency flags, needs the Manager) while
registry-installdownloads a single published node straight from the Comfy Registry API and
runs its bundled install script (no Manager required — the command the
Registry's own instructions use).
--fast-deps— new section documenting what it does, the commands thataccept it (
comfy install,comfy node install,comfy node reinstall),and why
registry-installdoes not (it bypasses comfy-cli's dependencyresolver entirely).
Acceptance criteria
example was already lowercase on
main(fixed in0cb2cb8, Mar 2026, afterthe issue was filed); this PR adds the missing explanation of why the
capitalized form fails, which is the actual reporter confusion.
registry-installvsinstalldocumented (what each does, when to usewhich), verified against
comfy_cli/command/custom_nodes/command.py.--fast-depsdocumented, including which node commands accept it and thecurrent reason
registry-installdoes not, verified against the commandsignatures in source.
ComfyUI-Impact-Packfailure is acase-sensitivity / stale-doc issue (node IDs are the lowercase registry IDs),
not an install-resolution bug — the working form already ships on
main. Noresolver change is in scope (per the ticket's out-of-scope note).
Judgment calls / notes
registry-installis defined withhidden=Truein the CLI. I documented itanyway (the Registry's install instructions use it and the issue explicitly
asks for its docs) but left it hidden — unhiding is a behavior change and
out of scope for a docs ticket.
--fast-deps"not accepted by registry-install" claim was verified byreading
registry_install's signature (it only exposes--force-download),and the docs redirect users to
comfy node installfor that capabilityrather than presenting a dead-end.
separate docs repo, not this repo — those are out of scope for this
comfy-cli README PR and would need a follow-up there if the same guidance is
wanted on the docs site.
Closes #257