docs: document the Comfy Cloud run path in the README + --help epilog#513
docs: document the Comfy Cloud run path in the README + --help epilog#513mattmillerai wants to merge 1 commit into
Conversation
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.
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 20 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. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ 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)
|
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` |
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 ofcomfy --help, and explains that cloud generation costs credits while just looking around (listing jobs/templates) is free.What changed
comfy cloud login→comfy run --where cloud→comfy jobs wait→comfy downloadpath, how to export the workflow JSON, and a one-line credits/subscription note.comfy --helpepilog: the same ~1-line decision path + credits note now renders at the bottom of the root help, via anepilogon 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 logindoc bug — a command that didn't exist — as the reason this matters). Installed the package in a clean venv and ran--helpon each:comfy cloud login,comfy cloud whoami✓comfy run --workflow <path> --where cloud --wait✓ (submits async by default, printsprompt_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
a → b → c) split into two paragraphs so it stays legible after reflow. Verified visually withcomfy --help.ruff check+ruff format --checkclean on the changed file.