Skip to content

Commit a655999

Browse files
committed
docs: update documentation for Manager v4 and uv-sync
1 parent 07e1a61 commit a655999

5 files changed

Lines changed: 617 additions & 15 deletions

File tree

DEV_README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,24 +124,49 @@ def remove(name: str):
124124
- For progress reporting, use either [`rich.progress`](https://rich.readthedocs.io/en/stable/progress.html)
125125

126126
## Develop comfy-cli and ComfyUI-Manager (cm-cli) together
127+
128+
ComfyUI-Manager is now installed as a pip package (via `manager_requirements.txt`
129+
in the ComfyUI root) rather than being git-cloned into `custom_nodes/`.
130+
127131
### Making changes to both
128-
1. Fork your own branches of `comfy-cli` and `ComfyUI-Manager`, make changes
129-
2. Be sure to commit any changes to `ComfyUI-Manager` to a new branch, and push to remote
132+
1. Fork your own branches of `comfy-cli` and `ComfyUI-Manager`, make changes.
133+
2. Live-install `comfy-cli`:
134+
- `pip install -e /path/to/comfy-cli`
135+
3. Live-install your fork of `ComfyUI-Manager` in editable mode:
136+
- `pip install -e /path/to/ComfyUI-Manager`
137+
4. This makes the `cm-cli` entry point available and points it at your local source.
130138

131139
### Trying changes to both
132-
1. clone the changed branch of `comfy-cli`, then live install `comfy-cli`:
133-
- `pip install -e comfy-cli`
140+
1. Install both packages in editable mode as described above.
134141
2. Go to a test dir and run:
135-
- `comfy --here install --manager-url=<path-or-url-to-fork-of-ComfyUI-Manager>`
136-
3. Run:
137-
- `cd ComfyUI/custom_nodes/ComfyUI-Manager/ && git checkout <changed-branch> && cd -`
138-
4. Further changes can be pulled into these copies of the `comfy-cli` and `ComfyUI-Manager` repos
142+
- `comfy --here install`
143+
3. The `cm-cli` command will resolve to your locally installed editable package.
139144

140145
### Debugging both simultaneously
141-
1. Follow instructions above to get working install with changes
146+
1. Follow instructions above to get working install with changes.
142147
2. Add breakpoints directly to code: `import ipdb; ipdb.set_trace()`
143-
3. Execute relevant `comfy-cli` command
148+
3. Execute relevant `comfy-cli` command.
149+
150+
151+
## Running E2E tests
152+
153+
E2E tests perform real `comfy install`, `comfy launch`, and `comfy node` operations.
154+
They are **disabled by default** and must be explicitly enabled.
155+
156+
```bash
157+
TEST_E2E=true pytest tests/e2e/
158+
```
159+
160+
For pre-release testing against alternate ComfyUI repositories (e.g. Manager v4):
161+
162+
```bash
163+
TEST_E2E=true \
164+
TEST_E2E_COMFY_URL="https://github.com/ltdrdata/ComfyUI.git@dr-bump-manager" \
165+
pytest tests/e2e/ -v
166+
```
144167

168+
See [docs/TESTING-e2e.md](docs/TESTING-e2e.md) for the full guide including
169+
environment variables, test suite details, and scenario descriptions.
145170

146171
## Contact
147172

README.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ will simply update the comfy.yaml file to reflect the local setup
7575
- Example 1: To run the recently executed ComfyUI:
7676
- `comfy --recent launch`
7777
- Example 2: To install a package on the ComfyUI in the current directory:
78-
- `comfy --here node install ComfyUI-Impact-Pack`
78+
- `comfy --here node install comfyui-impact-pack`
7979
- Example 3: To update the automatically selected path of ComfyUI and custom nodes based on priority:
8080

8181
- `comfy node update all`
@@ -168,7 +168,7 @@ comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snap
168168

169169
`comfy node update all`
170170

171-
`comfy node install ComfyUI-Impact-Pack`
171+
`comfy node install comfyui-impact-pack`
172172

173173
- Managing snapshot:
174174

@@ -186,6 +186,32 @@ comfy node [show|simple-show] [installed|enabled|not-installed|disabled|all|snap
186186

187187
`comfy node deps-in-workflow --workflow=<workflow .json/.png file> --output=<output deps .json file>`
188188

189+
#### Unified Dependency Resolution (--uv-compile)
190+
191+
Requires ComfyUI-Manager v4.1+. Instead of installing dependencies per-node with
192+
`pip install`, `--uv-compile` batch-resolves all custom node dependencies via
193+
`uv pip compile` to avoid version conflicts.
194+
195+
- Install with unified resolution:
196+
197+
`comfy node install comfyui-impact-pack --uv-compile`
198+
199+
- Available on: `install`, `reinstall`, `update`, `fix`, `restore-snapshot`,
200+
`restore-dependencies`, `install-deps`
201+
202+
- Run standalone (resolve all existing custom node dependencies):
203+
204+
`comfy node uv-sync`
205+
206+
- `--uv-compile` is mutually exclusive with `--fast-deps` and `--no-deps`.
207+
208+
- To make `--uv-compile` the default for all commands, see
209+
[uv-compile default](#uv-compile-default) below.
210+
211+
- Use `--no-uv-compile` to override the default for a single command:
212+
213+
`comfy node install comfyui-impact-pack --no-uv-compile`
214+
189215
#### Bisect custom nodes
190216

191217
If you encounter bugs only with custom nodes enabled, and want to find out which custom node(s) causes the bug,
@@ -216,18 +242,40 @@ the bisect tool can help you pinpoint the custom node that causes the issue.
216242

217243
### Managing ComfyUI-Manager
218244

219-
- disable GUI of ComfyUI-Manager (disable Manager menu and Server)
245+
- Disable ComfyUI-Manager completely (no manager flags passed to ComfyUI):
220246

221-
`comfy manager disable-gui`
247+
`comfy manager disable`
222248

223-
- enable GUI of ComfyUI-Manager
249+
- Enable ComfyUI-Manager with new GUI:
224250

225251
`comfy manager enable-gui`
226252

253+
- Enable ComfyUI-Manager without GUI (manager runs but UI is hidden):
254+
255+
`comfy manager disable-gui`
256+
257+
- Enable ComfyUI-Manager with legacy GUI:
258+
259+
`comfy manager enable-legacy-gui`
260+
227261
- Clear reserved startup action:
228262

229263
`comfy manager clear`
230264

265+
#### uv-compile default
266+
267+
Set `--uv-compile` as the default behavior for all custom node operations:
268+
269+
`comfy manager uv-compile-default true`
270+
271+
When enabled, all node commands (`install`, `reinstall`, `update`, `fix`,
272+
`restore-snapshot`, `restore-dependencies`, `install-deps`) will automatically
273+
use `--uv-compile`. Use `--no-uv-compile` on any individual command to override.
274+
275+
To disable:
276+
277+
`comfy manager uv-compile-default false`
278+
231279
## Beta Feature: format of comfy-lock.yaml (WIP)
232280

233281
```

0 commit comments

Comments
 (0)