Skip to content

add readme for PR support #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jtydhr88 merged 1 commit into from
Jun 25, 2025
Merged

add readme for PR support #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ terminal.
- 🗄️ Download checkpoints and save model hash
- 💻 Cross-platform compatibility (Windows, macOS, Linux)
- 📖 Comprehensive documentation and examples
- 🎉 install pull request to ComfyUI automatically

## Installation

Expand Down Expand Up @@ -111,6 +112,17 @@ Comfy provides commands that allow you to easily run the installed ComfyUI.
- Since "Comfy Server Running" in `comfy env` only shows the default port 8188, it doesn't display ComfyUI running on a different port.
- Background-running ComfyUI can be stopped with `comfy stop`.

- to run ComfyUI with a specific pull request:

`comfy install --pr "#1234"`

`comfy install --pr "jtydhr88:load-3d-nodes"`

`comfy install --pr "https://github.com/comfyanonymous/ComfyUI/pull/1234"`

- If you want to run ComfyUI with a specific pull request, you can use the `--pr` option. This will automatically install the specified pull request and run ComfyUI with it.
- Important: When using --pr, any --version and --commit parameters are ignored. The PR branch will be checked out regardless of version settings.

### Managing Custom Nodes

comfy provides a convenient way to manage custom nodes for extending ComfyUI's functionality. Here are some examples:
Expand Down