Skip to content

DEV_README.md

Latest commit

 

History

History
175 lines (118 loc) · 4.87 KB

DEV_README.md

File metadata and controls

175 lines (118 loc) · 4.87 KB

Development Guide

This guide provides an overview of how to develop in this repository.

General guide

  1. Clone the repo, create and activate a conda env. Minimum Python version is 3.9.

  2. Install the package to your conda env.

pip install -e .

  1. Set ENVIRONMENT variable to DEV.

export ENVIRONMENT=dev

  1. Check if the "comfy" package can run.

comfy --help

  1. Install the pre-commit hook to ensure that your code won't need reformatting later.

pre-commit install

  1. To save time during code review, it's recommended that you also manually run the unit tests before submitting a pull request (see below).

Running the unit tests

  1. Install pytest into your conda env. You should preferably be using Python 3.9 in your conda env, since it's the version we are targeting for compatibility.

pip install pytest pytest-cov

  1. Verify that all unit tests run successfully.

pytest --cov=comfy_cli --cov-report=xml .

Debugging

You can add following config to your VSCode launch.json to launch debugger.

{
  "name": "Python Debugger: Run",
  "type": "debugpy",
  "request": "launch",
  "module": "comfy_cli.__main__",
  "args": [],
  "console": "integratedTerminal"
}

Making changes to the code base

There is a potential need for you to reinstall the package. You can do this by either run pip install -e . again (which will reinstall), or manually uninstall pip uninstall comfy-cli and reinstall, or even cleaning your conda env and reinstalling the package (pip install -e .)

Packaging custom nodes with .comfyignore

comfy node pack and comfy node publish now read an optional .comfyignore file in the project root. The syntax matches .gitignore (implemented with PathSpec's gitwildmatch rules), so you can reuse familiar patterns to keep development-only artifacts out of your published archive.

  • Patterns are evaluated against paths relative to the directory you run the command from (usually the repo root).
  • Files required by the pack command itself (e.g. __init__.py, web/*) are still forced into the archive even if they match an ignore pattern.
  • If no .comfyignore is present the command falls back to the original behavior and zips every git-tracked file.

Example .comfyignore:

docs/
frontend/
tests/
*.psd

Commit the file alongside your node so teammates and CI pipelines produce the same trimmed package.

Adding a new command

  • Register it under comfy_cli/cmdline.py

If it's contains subcommand, create folder under comfy_cli/command/[new_command] and add the following boilerplate

comfy_cli/command/[new_command]/__init__.py

from .command import app

comfy_cli/command/[new_command]command.py

import typer

app = typer.Typer()

@app.command()
def option_a(name: str):
  """Add a new custom node"""
  print(f"Adding a new custom node: {name}")


@app.command()
def remove(name: str):
  """Remove a custom node"""
  print(f"Removing a custom node: {name}")

Important notes

  • Use typer for all command args management
  • Use rich for all console output

Develop comfy-cli and ComfyUI-Manager (cm-cli) together

ComfyUI-Manager is now installed as a pip package (via manager_requirements.txt in the ComfyUI root) rather than being git-cloned into custom_nodes/.

Making changes to both

  1. Fork your own branches of comfy-cli and ComfyUI-Manager, make changes.
  2. Live-install comfy-cli:
    • pip install -e /path/to/comfy-cli
  3. Live-install your fork of ComfyUI-Manager in editable mode:
    • pip install -e /path/to/ComfyUI-Manager
  4. This makes the cm-cli entry point available and points it at your local source.

Trying changes to both

  1. Install both packages in editable mode as described above.
  2. Go to a test dir and run:
    • comfy --here install
  3. The cm-cli command will resolve to your locally installed editable package.

Debugging both simultaneously

  1. Follow instructions above to get working install with changes.
  2. Add breakpoints directly to code: import ipdb; ipdb.set_trace()
  3. Execute relevant comfy-cli command.

Running E2E tests

E2E tests perform real comfy install, comfy launch, and comfy node operations. They are disabled by default and must be explicitly enabled.

TEST_E2E=true pytest tests/e2e/

For pre-release testing against alternate ComfyUI repositories (e.g. Manager v4):

TEST_E2E=true \
TEST_E2E_COMFY_URL="https://github.com/ltdrdata/ComfyUI.git@dr-bump-manager" \
pytest tests/e2e/ -v

See docs/TESTING-e2e.md for the full guide including environment variables, test suite details, and scenario descriptions.

Contact

If you have any questions or need further assistance, please contact the project maintainer at ???.

Happy coding!