Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ comfy setup

`comfy setup` walks you through everything — local or cloud routing, authentication, and agent skill installation — in one interactive wizard. Pass `-y` for non-interactive (CI/scripted) installs.

## Run a workflow in the cloud

No local GPU? Route any API-format workflow to [Comfy Cloud](https://www.comfy.org/) with `--where cloud`:

```bash
comfy cloud login # sign in via your browser (OAuth)
comfy run --workflow ./workflow.json --where cloud # submits, prints a prompt_id, returns immediately
comfy jobs wait <prompt_id> --where cloud # block until the job finishes (or: jobs status for a one-shot check)
comfy download <prompt_id> --where cloud -o ./outputs # save the results locally
```

`comfy run` submits asynchronously and prints the `prompt_id` you feed to `jobs`/`download`; add `--wait` to block inline instead. Check your sign-in anytime with `comfy cloud whoami`. Export the workflow JSON from ComfyUI via **File → Export (API)** (UI-format JSON is auto-converted). Set cloud as your default target so you can drop the flag: `comfy set-default --where cloud`.

**Credits:** cloud generation (`comfy run --where cloud`, `comfy generate`) consumes Comfy Cloud credits and needs an active subscription. Discovery and inspection commands — `comfy cloud whoami`, `comfy jobs status/ls`, `comfy templates ls`, `comfy generate list` — don't.

## Installation

1. (Recommended) Activate a virtual environment ([venv](https://docs.python.org/3/library/venv.html) or [conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html)).
Expand Down
12 changes: 11 additions & 1 deletion comfy_cli/cmdline.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,17 @@ def _maybe_nudge_setup(ctx: typer.Context, renderer) -> None:
pass


@app.callback(invoke_without_command=True)
@app.callback(
invoke_without_command=True,
epilog=(
"Cloud quickstart (no local GPU required):\n\n"
"comfy cloud login → comfy run --workflow wf.json --where cloud "
"(prints a prompt_id) → comfy jobs wait <prompt_id> --where cloud → "
"comfy download <prompt_id> --where cloud\n\n"
"Cloud generation consumes Comfy Cloud credits (needs an active subscription); "
"discovery commands (jobs status, templates ls, generate list) don't. See the README."
),
)
def entry(
ctx: typer.Context,
workspace: Annotated[
Expand Down
Loading