Skip to content

docs: document registry-install & --fast-deps, fix node-install example#587

Open
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-4275-document-registry-install
Open

docs: document registry-install & --fast-deps, fix node-install example#587
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-4275-document-registry-install

Conversation

@mattmillerai

Copy link
Copy Markdown
Collaborator

ELI-5

If you told comfy-cli to install a node using its GitHub-style name
(ComfyUI-Impact-Pack), it failed with a confusing Node 'ComfyUI-Impact-Pack@unknown' not found error, because the command actually
wants the node's lowercase Comfy Registry ID (comfyui-impact-pack). Also,
comfy-cli has two different install commands (install and registry-install)
and a --fast-deps speed 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.

  1. Node-install casing note — added a note under the comfy node install
    example 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 found error from the issue.
  2. install vs registry-install — new section explaining that install
    delegates to ComfyUI-Manager's cm-cli (multi-node, channel/mode-aware,
    supports the dependency flags, needs the Manager) while registry-install
    downloads 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).
  3. --fast-deps — new section documenting what it does, the commands that
    accept it (comfy install, comfy node install, comfy node reinstall),
    and why registry-install does not (it bypasses comfy-cli's dependency
    resolver entirely).

Acceptance criteria

  • README node-install example corrected to a working command — the literal
    example was already lowercase on main (fixed in 0cb2cb8, Mar 2026, after
    the issue was filed); this PR adds the missing explanation of why the
    capitalized form fails, which is the actual reporter confusion.
  • registry-install vs install documented (what each does, when to use
    which), verified against comfy_cli/command/custom_nodes/command.py.
  • --fast-deps documented, including which node commands accept it and the
    current reason registry-install does not, verified against the command
    signatures in source.
  • Follow-up bug: not needed. The ComfyUI-Impact-Pack failure is a
    case-sensitivity / stale-doc issue (node IDs are the lowercase registry IDs),
    not an install-resolution bug — the working form already ships on main. No
    resolver change is in scope (per the ticket's out-of-scope note).

Judgment calls / notes

  • registry-install is defined with hidden=True in the CLI. I documented it
    anyway (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.
  • The --fast-deps "not accepted by registry-install" claim was verified by
    reading registry_install's signature (it only exposes --force-download),
    and the docs redirect users to comfy node install for that capability
    rather than presenting a dead-end.
  • The docs.comfy.org custom-nodes pages that surface these commands live in a
    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

…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
@mattmillerai mattmillerai added the agent-coded PR authored by the agent-work loop label Jul 24, 2026
@mattmillerai
mattmillerai marked this pull request as ready for review July 24, 2026 05:23
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 35 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 478ea298-9834-4676-8b0d-b5ac8b8c78be

📥 Commits

Reviewing files that changed from the base of the PR and between 85b62da and 7f679cd.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch matt/be-4275-document-registry-install
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch matt/be-4275-document-registry-install

Comment @coderabbitai help to get the list of available commands.

@mattmillerai mattmillerai added the cursor-review Request Cursor bot review label Jul 24, 2026
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 24, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-coded PR authored by the agent-work loop cursor-review Request Cursor bot review documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for registry-install and --fast-deps

1 participant