-
First install
cookiecutter
:# pipx is strongly recommended pipx install cookiecutter # if pipx is not an option, you can install cookiecutter in your Python user directory. python -m pip install --user cookiecutter
-
Run
cookiecutter
with this template:# if you installed cookiecutter with pipx pipx run cookiecutter gh:comfy-org/cookiecutter-comfy-extension # if you installed cookiecutter with pip cookiecutter gh:comfy-org/cookiecutter-comfy-extension # initialize git repo in your new project cd <your-project-name> git init
The resulting ComfyUI node extension project will automatically come with a few neat features:
- Support for Ruff linter and various recommended rules
- A pre-commit hook for the Ruff linter
- An optional
web
directory if your extension will include custom javascript- If selected,
web
will also be added to the project'sMANIFEST.in
to ensure that any non-python code inweb
will also be correctly installed
- If selected,
- Testing via PyTest (check the
tests/
directory) - A Github Action that will automatically run any tests as part of Pull Requests made against your project
- A Github Action to publish to the Comfy Registry