Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 2.74 KB

DEV_README.md

File metadata and controls

110 lines (73 loc) · 2.74 KB
Raw

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 local

pip install -e .

  1. Set ENVIRONMENT variable to DEV.

export ENVIRONMENT=dev

  1. Test script running

comfy --help

  1. Use pre commit hook

pre-commit install

Debug

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"
}

Make 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 .)

Add 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}")

Guide

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

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

Make changes to both

  1. Fork your own branches of comfy-cli and ComfyUI-Manager, make changes
  2. Be sure to commit any changes to ComfyUI-Manager to a new branch, and push to remote

Try out changes to both

  1. clone the changed branch of comfy-cli, then live install comfy-cli:
  • pip install -e comfy-cli
  1. Go to a test dir and run:
  • comfy --here install --manager-url=<path-or-url-to-fork-of-ComfyUI-Manager>
  1. Run:
  • cd ComfyUI/custom_nodes/ComfyUI-Manager/ && git checkout <changed-branch> && cd -
  1. Further changes can be pulled into these copies of the comfy-cli and ComfyUI-Manager repos

Debug 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

Contact

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

Happy coding!