Skip to content

Commit 573f777

Browse files
authored
add readme for PR support (#288)
1 parent 8ee6f42 commit 573f777

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ terminal.
2222
- 🗄️ Download checkpoints and save model hash
2323
- 💻 Cross-platform compatibility (Windows, macOS, Linux)
2424
- 📖 Comprehensive documentation and examples
25+
- 🎉 install pull request to ComfyUI automatically
2526

2627
## Installation
2728

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

115+
- to run ComfyUI with a specific pull request:
116+
117+
`comfy install --pr "#1234"`
118+
119+
`comfy install --pr "jtydhr88:load-3d-nodes"`
120+
121+
`comfy install --pr "https://github.com/comfyanonymous/ComfyUI/pull/1234"`
122+
123+
- 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.
124+
- Important: When using --pr, any --version and --commit parameters are ignored. The PR branch will be checked out regardless of version settings.
125+
114126
### Managing Custom Nodes
115127

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

0 commit comments

Comments
 (0)