Starter template for ComfyUI custom nodes with a TypeScript frontend and optional Python node code. Example use: ComfyUI Node Organizer

Use it for:

• frontend-only extensions
• Python-backed custom nodes
• nodepacks that ship both

1. Create a repo from this template.
2. Clone it locally.
3. Link or symlink it into ComfyUI's custom_nodes/ directory.
4. Replace the template placeholders before you publish anything.

PowerShell example:

New-Item -ItemType SymbolicLink `
  -Path C:\path\to\ComfyUI\custom_nodes\comfyui-my-node `
  -Target C:\path\to\your\repo

macOS / Linux example:

ln -s /path/to/your/repo /path/to/ComfyUI/custom_nodes/comfyui-my-node

Install dependencies:

pnpm install
uv sync --locked --group dev

Frontend commands:

pnpm dev
pnpm typecheck
pnpm test
pnpm build

Python tests:

uv run pytest tests/python -q

Reload the ComfyUI browser tab after frontend changes. Restart the ComfyUI server after Python changes.

If your nodepack includes Python code, start with these files:

• tests/python/test_entrypoint_smoke.py checks that __init__.py imports cleanly and exposes the expected entrypoint symbols.
• tests/python/fixtures/example_node.py and tests/python/test_example_node_pattern.py show a small unit-test pattern for backend node logic.

If you are shipping a frontend-only extension, keep the smoke test anyway. It still catches broken entrypoint changes in CI.

GitHub CI runs:

• uv sync --locked --group dev
• uv run pytest tests/python -q
• pnpm typecheck
• pnpm test
• pnpm build

The publish workflow runs the same checks, bumps the version, regenerates uv.lock, tags the release, and then publishes to the ComfyUI registry.

1. Make sure the metadata and branding are no longer template defaults.
2. Confirm pnpm test, pnpm build, and uv run pytest tests/python -q pass locally.
3. Add the REGISTRY_ACCESS_TOKEN repository secret.
4. Run the Publish to Comfy registry workflow in GitHub Actions.
5. Choose the version bump type.

Update these files before release:

• package.json
• pyproject.toml
• src/constants.ts
• src/index.ts
• LICENSE
• assets/icon.svg

• Replace the default icon in assets/icon.svg
• Replace the placeholder homepage URL in src/index.ts
• Replace the placeholder settings prefix in src/constants.ts
• Replace package metadata in package.json and pyproject.toml
• Replace Your Name in LICENSE
• Re-read the rendered README once with your real project name

MIT