Comfy-Org/ComfyUI_frontend
1
0
Fork 0
mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-01-26 19:09:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
88df6627f09a8df0de4cccf101e7b77bba8c0ee9
ComfyUI_frontend/docs/extensions
History
snomiao 49f373c46f [chore] Replace npx with pnpx across the codebase (#5329) 
## Summary
- Migrated all `npx` commands to `pnpx` to align with the pnpm ecosystem
- Updated all occurrences across the codebase for consistency

## Changes
- **Package.json scripts**: Updated test:browser, preinstall, and
collect-i18n scripts
- **GitHub Actions workflows**: Updated all workflow files that use npx
(test-ui, i18n, update-manager-types, etc.)
- **Documentation**: Updated browser_tests/README.md and
docs/extensions/development.md
- **Husky pre-commit hook**: Updated lint-staged and tsx commands
- **MCP configuration**: Updated .mcp.json to use pnpx

## Test Plan
- [ ] CI tests pass
- [ ] Local development commands work with pnpx
- [ ] GitHub Actions workflows execute successfully

🤖 Generated with Claude Code

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-5329-chore-Replace-npx-with-pnpx-across-the-codebase-2646d73d36508127bd43d14b8364aeb1)
by [Unito](https://www.unito.io)
2025-09-26 10:06:41 -07:00
..
core.md
docs: Clarify extension terminology and dev server limitations (#5042)
2025-08-18 13:43:51 -07:00
development.md
[chore] Replace npx with pnpx across the codebase (#5329)
2025-09-26 10:06:41 -07:00
README.md
docs: Clarify extension terminology and dev server limitations (#5042)
2025-08-18 13:43:51 -07:00

README.md

ComfyUI Extensions Documentation

Overview

Extensions are the primary way to add functionality to ComfyUI. They can be custom nodes, custom nodes that render widgets (UIs made with javascript), ComfyUI shell UI enhancements, and more. This documentation covers everything you need to know about understanding, using, and developing extensions.

Documentation Structure

  • Development Guide - How to develop extensions, including:

    • Extension architecture and terminology
    • How extensions load (backend vs frontend)
    • Why extensions don't work in dev server
    • Development workarounds and best practices

  • Core Extensions Reference - Detailed reference for core extensions:

    • Complete list of all core extensions
    • Extension architecture principles
    • Hook execution sequence
    • Best practices for extension development

Quick Links

Key Concepts

  • Extension: Umbrella term for any code that extends ComfyUI
  • Custom Nodes: Python backend nodes (a type of extension)
  • JavaScript Extensions: Frontend UI enhancements
  • Core Extensions: Built-in extensions bundled with ComfyUI

Common Tasks

External Resources

Need Help?