Skip to content

docs: document the Comfy Cloud run path in the README + --help epilog#513

Open
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-2976-readme-cloud-run-path
Open

docs: document the Comfy Cloud run path in the README + --help epilog#513
mattmillerai wants to merge 1 commit into
mainfrom
matt/be-2976-readme-cloud-run-path

Conversation

@mattmillerai

Copy link
Copy Markdown
Collaborator

ELI-5

If you don't have a beefy GPU, comfy-cli can run your workflow on Comfy Cloud instead. Until now the README never told you how — it only showed comfy generate. This PR adds a short recipe: sign in, submit your workflow to the cloud, wait for it to finish, and download the results. It also drops the same recipe at the bottom of comfy --help, and explains that cloud generation costs credits while just looking around (listing jobs/templates) is free.

What changed

  • README: new "Run a workflow in the cloud" section right after Quick Start — the full comfy cloud logincomfy run --where cloudcomfy jobs waitcomfy download path, how to export the workflow JSON, and a one-line credits/subscription note.
  • comfy --help epilog: the same ~1-line decision path + credits note now renders at the bottom of the root help, via an epilog on the existing @app.callback (cheap — no new callback needed).

Command validation

Every command/flag in the new docs was validated against the actual registered CLI surface (the ticket flags a prior comfy auth login doc bug — a command that didn't exist — as the reason this matters). Installed the package in a clean venv and ran --help on each:

  • comfy cloud login, comfy cloud whoami
  • comfy run --workflow <path> --where cloud --wait ✓ (submits async by default, prints prompt_id)
  • comfy jobs wait <prompt_id> --where cloud, comfy jobs status, comfy jobs ls
  • comfy download <prompt_id> --where cloud -o <dir>
  • comfy set-default --where cloud, comfy templates ls, comfy generate list

Notes / judgment calls

  • Epilog formatting: the Rich help renderer collapses hard newlines within a paragraph, so a 4-line aligned block reflowed into a run-on. I rendered the path as a single arrow-chain (a → b → c) split into two paragraphs so it stays legible after reflow. Verified visually with comfy --help.
  • Credits wording mirrors the ticket's own framing (generation consumes credits + needs a subscription; discovery/inspection commands don't). It's user guidance, not a hard technical assertion — no capability is denied by this diff.
  • Docs-only + a metadata-only Typer kwarg. Full suite green (2573 passed, 37 skipped); ruff check + ruff format --check clean on the changed file.

Add a compact cloud quickstart (login → run → jobs wait → download) plus
credits/subscription guidance to the README, and mirror the same decision
path in the root --help epilog. Command names validated against the actual
registered CLI surface.
@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:31
@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jul 14, 2026
@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: 20 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: 7d579423-018b-404d-8864-37d85df64b95

📥 Commits

Reviewing files that changed from the base of the PR and between a732f5c and 1caa6df.

📒 Files selected for processing (2)
  • README.md
  • comfy_cli/cmdline.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch matt/be-2976-readme-cloud-run-path
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch matt/be-2976-readme-cloud-run-path

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

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label 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

CI note: the red Windows Specific Commands (`test`) check is a pre-existing, repo-wide Windows flake — `comfy install --fast-deps` fails to overwrite the already-loaded `pydantic_core` .pyd (Access is denied / `ImportError: cannot import name 'version' from 'pydantic_core'`). It reproduces on every recent PR that touches `comfy_cli/**` (and re-running the failed job here reproduces it identically), so it is unrelated to this docs-only change (README + a Typer epilog string). No code, dependency, or install logic was modified. All other checks are green; no review threads or panel findings are outstanding. The documented cloud commands (`cloud login/whoami`, `run --where cloud`, `jobs wait/status/ls`, `download`, `templates ls`, `generate list`, `set-default --where cloud`) were each verified to exist in the codebase.

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