Especificaciones

El archivo pyproject.toml contiene dos secciones principales para los nodos personalizados de ComfyUI: [project] y [tool.comfy]. A continuación encontrarás las especificaciones de cada sección.

Sección [project]

name (requerido)

El id del nodo identifica de forma única al nodo personalizado y se usará en las URL del registry. Los usuarios pueden instalar el nodo haciendo referencia a este nombre:

comfy node install <node-id>

Requisitos:

Debe tener menos de 100 caracteres
Solo puede contener caracteres alfanuméricos, guiones, guiones bajos y puntos
No puede tener caracteres especiales consecutivos
No puede comenzar con un número ni con un carácter especial
La comparación no distingue mayúsculas de minúsculas

Buenas prácticas:

Usa un nombre corto y descriptivo
No incluyas “ComfyUI” en el nombre
Hazlo fácil de recordar y de escribir

Ejemplos:

name = "image-processor"      # ✅ Good: Simple and clear
name = "super-resolution"     # ✅ Good: Describes functionality
name = "ComfyUI-enhancer"    # ❌ Bad: Includes ComfyUI
name = "123-tool"            # ❌ Bad: Starts with number

Consulta la documentación oficial de python para obtener más detalles.

version (requerido)

Usa versionado semántico con un número de versión de tres dígitos X.Y.Z:

X (MAJOR): Cambios incompatibles
Y (MINOR): Funciones nuevas (compatibles con versiones anteriores)
Z (PATCH): Correcciones de errores

Ejemplos:

version = "1.0.0"    # Initial release
version = "1.1.0"    # Added new features
version = "1.1.1"    # Bug fix
version = "2.0.0"    # Breaking changes

license (opcional)

Especifica la licencia de tu nodo personalizado. Puedes especificarla de dos maneras:

Referencia a un archivo:

license = { file = "LICENSE" }     # ✅ Points to LICENSE file
license = { file = "LICENSE.txt" } # ✅ Points to LICENSE.txt
license = "LICENSE"                # ❌ Incorrect format

Nombre de la licencia:

license = { text = "MIT License" }  # ✅ Correct format
license = { text = "Apache-2.0" }   # ✅ Correct format
license = "MIT LICENSE"             # ❌ Incorrect format

Licencias comunes: MIT, GPL, Apache

description (recomendado)

Una descripción breve de lo que hace tu nodo personalizado.

description = "A super resolution node for enhancing image quality"

repository (requerido)

Enlaces a recursos relacionados:

[project.urls]
Repository = "https://github.com/username/repository"

urls (recomendado)

Enlaces a recursos relacionados:

[project.urls]
Documentation = "https://github.com/username/repository/wiki"
"Bug Tracker" = "https://github.com/username/repository/issues"

requires-python (recomendado)

Especifica las versiones de Python que admite tu nodo:

requires-python = ">=3.8"        # Python 3.8 or higher
requires-python = ">=3.8,<3.11"  # Python 3.8 up to (but not including) 3.11

Compatibilidad de versiones del frontend (opcional)

Si tu nodo tiene requisitos específicos sobre qué versiones del frontend de ComfyUI admite, puedes especificarlo con la dependencia comfyui-frontend-package. Este paquete se publica en PyPI. Por ejemplo, usa este campo cuando:

Tu nodo personalizado usa API del frontend que se introdujeron en una versión específica
Has identificado incompatibilidades entre tu nodo y ciertas versiones del frontend
Tu nodo requiere funciones de UI específicas que solo están disponibles en versiones más recientes del frontend

[project]
dependencies = [
    "comfyui-frontend-package>=1.20.0"       # Requires frontend 1.20.0 or newer
    "comfyui-frontend-package<=1.21.6"       # Restricts to frontend versions up to 1.21.6
    "comfyui-frontend-package>=1.19,<1.22"   # Works with frontend 1.19 to 1.21.x
    "comfyui-frontend-package~=1.20.0"       # Compatible with 1.20.x but not 1.21.0
    "comfyui-frontend-package!=1.21.3"       # Works with any version except 1.21.3
]

classifiers (recomendado)

Usa los clasificadores para especificar la compatibilidad con el sistema operativo y los aceleradores GPU. Esta información ayuda a los usuarios a encontrar el nodo adecuado para su sistema.

[project]
classifiers = [
    # For OS-independent nodes (works on all operating systems)
    "Operating System :: OS Independent",

    # OR for OS-specific nodes, specify the supported systems:
    "Operating System :: Microsoft :: Windows",  # Windows specific
    "Operating System :: POSIX :: Linux",  # Linux specific
    "Operating System :: MacOS",  # macOS specific
    
    # GPU Accelerator support
    "Environment :: GPU :: NVIDIA CUDA",    # NVIDIA CUDA support
    "Environment :: GPU :: AMD ROCm",       # AMD ROCm support
    "Environment :: GPU :: Intel Arc",      # Intel Arc support
    "Environment :: NPU :: Huawei Ascend",  # Huawei Ascend support
    "Environment :: GPU :: Apple Metal",    # Apple Metal support
]

Sección [tool.comfy]

PublisherId (requerido)

Tu identificador único de editor, que normalmente coincide con tu nombre de usuario de GitHub. Ejemplos:

PublisherId = "john-doe"        # ✅ Coincide con el nombre de usuario de GitHub
PublisherId = "image-wizard"    # ✅ Identificador único

DisplayName (opcional)

Un nombre fácil de leer y reconocer para tu nodo personalizado.

DisplayName = "Super Resolution Node"

Icon (opcional)

URL al icono de tu nodo personalizado que se mostrará en ComfyUI Registry y ComfyUI-Manager. Requisitos:

Tipos de archivo: SVG, PNG, JPG o GIF
Resolución máxima: 400px × 400px
La relación de aspecto debe ser cuadrada

Icon = "https://raw.githubusercontent.com/username/repo/main/icon.png"

URL a una imagen de banner más grande que se mostrará en ComfyUI Registry y ComfyUI-Manager. Requisitos:

Tipos de archivo: SVG, PNG, JPG o GIF
Relación de aspecto: 21:9

Banner = "https://raw.githubusercontent.com/username/repo/main/banner.png"

requires-comfyui (opcional)

Especifica con qué versión de ComfyUI es compatible tu nodo. Esto ayuda a los usuarios a asegurarse de que tienen instalada la versión correcta de ComfyUI. Operadores admitidos: <, >, <=, >=, ~=, <>, != y rangos

requires-comfyui = ">=1.0.0"        # ComfyUI 1.0.0 o superior
requires-comfyui = ">=1.0.0,<2.0.0"  # ComfyUI 1.0.0 hasta 2.0.0 (sin incluirlo)
requires-comfyui = "~=1.0.0"         # Versión compatible: 1.0.0 o posterior, pero no la versión 2.0.0
requires-comfyui = "!=1.2.3"         # Cualquier versión excepto 1.2.3
requires-comfyui = ">0.1.3,<1.0.0"   # Mayor que 0.1.3 y menor que 1.0.0

includes (opcional)

Indica si quieres forzar la inclusión de determinadas carpetas concretas. En algunas situaciones, como los nodos personalizados en proyectos de frontend, la carpeta de salida final empaquetada puede estar incluida en .gitignore. En esos casos, necesitamos forzar su inclusión para poder usar el registro.

includes = ['dist']

Para excluir archivos del paquete publicado (lo inverso de includes), consulta .comfyignore en la página de publicación.

Ejemplo completo

[project]
name = "super-resolution-node"
version = "1.0.0"
description = "Enhance image quality using advanced super resolution techniques"
license = { file = "LICENSE" }
requires-python = ">=3.8"
dependencies = [
    "comfyui-frontend-package<=1.21.6"  # Frontend version compatibility
]
classifiers = [
    "Operating System :: OS Independent"  # Works on all operating systems
]
dynamic = ["dependencies"]

[tool.setuptools.dynamic]
dependencies = {file = ["requirements.txt"]}

[project.urls]
Repository = "https://github.com/username/super-resolution-node"
Documentation = "https://github.com/username/super-resolution-node/wiki"
"Bug Tracker" = "https://github.com/username/super-resolution-node/issues"

[tool.comfy]
PublisherId = "image-wizard"
DisplayName = "Super Resolution Node"
Icon = "https://raw.githubusercontent.com/username/super-resolution-node/main/icon.png"
Banner = "https://raw.githubusercontent.com/username/super-resolution-node/main/banner.png"
requires-comfyui = ">=1.0.0"  # ComfyUI version compatibility

Desarrollar con Comfy

Desplegar ComfyUI

Comfy CLI

Specifications

Nodos personalizados

pyproject.toml

Especificaciones

Sección [project]

name (requerido)

version (requerido)

license (opcional)

description (recomendado)

repository (requerido)

urls (recomendado)

requires-python (recomendado)

Compatibilidad de versiones del frontend (opcional)

classifiers (recomendado)

Sección [tool.comfy]

PublisherId (requerido)

DisplayName (opcional)

Icon (opcional)

Banner (opcional)

requires-comfyui (opcional)

includes (opcional)

Ejemplo completo