Skip to content

fix(help): correct skill count, disable-gui verb, missing help strings, install error tone#514

Open
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-2977-help-text-correctness
Open

fix(help): correct skill count, disable-gui verb, missing help strings, install error tone#514
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-2977-help-text-correctness

Conversation

@mattmillerai

Copy link
Copy Markdown
Collaborator

ELI-5

Several comfy ... --help blurbs were wrong or missing: the skills installer bragged about "4 bundled skills" when there are actually 5, the manager disable-gui command's help said it enables the GUI, a couple of commands had no help at all, and the installer greeted a bad --nvidia/--m-series combo with memes ("What are you smoking? 🤔") instead of telling you what went wrong and how to fix it. This PR makes the help text tell the truth.

What changed

  • Stale skill count → derived from data. comfy skills install --help and comfy skills show --help said "all 4 bundled skills"; BUNDLED_SKILLS has 5. Both now interpolate len(BUNDLED_SKILLS) so the count can never drift again.
  • Dropped "Aider" restored. The top-level comfy skills help came from the add_typer(..., help=...) override, which listed only "Claude Code, Cursor, and AGENTS.md" — dropping Aider that the sub-app's own help advertises. The registration now lists the full set ("Claude Code, Cursor, Aider, and any AGENTS.md-aware tool").
  • manager disable-gui verb fixed. Help read "Enable ComfyUI-Manager without GUI" → now "Enable ComfyUI-Manager but disable its GUI" (matches the command's docstring and behavior).
  • Missing help strings added. tracking enable / tracking disable had no help or docstring — added. model remove / model list already rendered help via their docstrings, but the audit's decorator scan flagged them; added explicit help= (belt-and-suspenders, and consistent with model download).
  • Install error tone. The two meme messages in install are replaced with actionable text stating the detected condition + the fix:
    • --nvidia on macOS (fatal, unchanged behavior): now explains macOS has no NVIDIA GPU and to re-run with --m-series/--cpu or omit the flag to pick interactively.
    • --m-series on a non-Mac platform (non-fatal — see judgment call): now a yellow warning naming the detected platform and the alternative flags.

Judgment calls

  • --m-series-on-non-Mac stays non-fatal. The ticket asked to "confirm intended behavior and make the message match reality." The existing code only warns and then proceeds (treating the machine as Apple silicon); it does not exit. I preserved that behavior (Chesterton's fence) and made the message a yellow warning that honestly describes the continuation, rather than adding a new exit. If a hard exit is actually wanted, that's a behavior change worth its own discussion.
  • model remove / model list already had help (via docstrings, verified by rendering comfy model --help). The audit listed them as "missing help strings entirely" because a decorator-level scan doesn't see docstrings. Added explicit help= anyway so the surface is uniform and robust to future docstring edits.

Testing

  • ruff format + ruff check clean on all touched files.
  • Full unit suite green: 2471 passed, 13 skipped.
  • Manually rendered --help for the skills, tracking, and model apps to confirm the new strings and the derived count ("5").

…s, install error tone

- skills: derive bundled-skill count from len(BUNDLED_SKILLS) instead of the
  stale literal '4' (there are 5); restore 'Aider' in the skills app help that
  the add_typer registration override had dropped
- manager disable-gui: help now describes disabling the GUI, not enabling it
- add help strings to 'tracking enable/disable' and explicit help to
  'model remove/list' (previously relied on docstrings; audit's scan missed them)
- install: replace meme error strings with actionable messages stating the
  detected condition and the fix; the --m-series-on-non-Mac warning is now a
  yellow warning that matches its non-fatal behavior
@coderabbitai

coderabbitai Bot commented Jul 14, 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: 16 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: 3e3a9ee1-3985-4f88-9af9-ba68834e7b87

📥 Commits

Reviewing files that changed from the base of the PR and between a732f5c and 761758a.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (5)
  • comfy_cli/cmdline.py
  • comfy_cli/command/custom_nodes/command.py
  • comfy_cli/command/models/models.py
  • comfy_cli/skills/command.py
  • comfy_cli/tracking.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch matt/be-2977-help-text-correctness
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch matt/be-2977-help-text-correctness

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

@mattmillerai mattmillerai added agent-coded PR authored by the agent-work loop cursor-review Request Cursor bot review labels Jul 14, 2026
@mattmillerai mattmillerai marked this pull request as ready for review July 14, 2026 19:35
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 14, 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)

@mattmillerai

Copy link
Copy Markdown
Collaborator Author

Reviews-resolver pass: no unresolved review threads, and the Cursor panel reported no high-signal findings (CodeRabbit was rate-limited and produced no findings). Ruff check + format are clean and the full pytest matrix (ubuntu/macos/windows + GPU) is green.

The one red check — Windows Specific Commands — is a repo-wide runner infra issue, not this diff: it fails identically on every PR opened today (BE-2999, BE-3001, BE-2994, BE-2982, BE-2975) with ImportError: cannot import name '__version__' from 'pydantic_core' (unknown location) during comfy install. Nothing in this help-text/lock change touches that path. Safe to merge once the Windows runner is unblocked.

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:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant