Files
fno2010-cm-cli-rest/__init__.py
T
Jensen Zhang d7a15a7d5d Add comfy-cli REST API support
- Implement ComfyCliExecutor for async command execution
- Add REST API endpoints for comfy-cli:
  - Configuration management (/comfy-cli/config/*)
  - Model management (/comfy-cli/model/*)
  - Node management (/comfy-cli/node/*)
- Create API handlers: ConfigHandler, ModelHandler, NodeHandler
- Register routes in comfy_cli_routes.py
- Update main __init__.py to support dual CLI (cm-cli + comfy-cli)
- Add comprehensive documentation:
  - COMFY_CLI_API.md: Complete API reference
  - COMFY_CLI_QUICKSTART.md: Quick start guide
  - Update README.md with dual CLI support
  - Update AGENTS.md development guide
- Add comfy-cli reference documentation in docs/references/
- Remove trailing spaces from all Python and Markdown files
- Ensure all code passes syntax validation

Features:
- Async job tracking for long-running operations
- Structured JSON responses
- Comprehensive error handling
- Direct filesystem access for model listing (more reliable)
- Support for CivitAI and HuggingFace API tokens
2026-03-17 21:55:32 +08:00

97 lines
2.9 KiB
Python

"""
#BM|cm-cli-rest & comfy-cli REST: REST API for ComfyUI management
#TB|A ComfyUI custom node that exposes REST API endpoints for managing
#KK|custom nodes via cm-cli (ComfyUI-Manager CLI) and comfy-cli.
custom nodes via cm-cli (ComfyUI-Manager CLI).
Usage:
Install this in ComfyUI/custom_nodes/cm-cli-rest/
Restart ComfyUI
API endpoints available at: http://localhost:8188/cm-cli-rest/*
"""
from server import PromptServer
import logging
from .cm_cli import CMCLIExecutor
from .comfy_cli import ComfyCliExecutor
from .api.routes import setup_routes
from .comfy_cli_routes import setup_comfy_cli_routes
from .api.routes import setup_routes
logger = logging.getLogger(__name__)
# Initialize cm-cli executor
executor = CMCLIExecutor()
# Initialize comfy-cli executor
comfy_executor = ComfyCliExecutor()
# Auto-detects cm-cli.py from ComfyUI-Manager installation
executor = CMCLIExecutor()
# Register cm-cli REST API routes
setup_routes(PromptServer.instance.app, executor)
# Register comfy-cli REST API routes
setup_comfy_cli_routes(PromptServer.instance.app, comfy_executor)
# This integrates our REST API into ComfyUI's aiohttp server
setup_routes(PromptServer.instance.app, executor)
logger.info("cm-cli-rest & comfy-cli REST initialized - APIs available at /cm-cli-rest/* and /comfy-cli/*")
# Optional: ComfyUI workflow node for triggering API calls
# This allows using the API from within ComfyUI workflows
class CMCLIRestNode:
"""
ComfyUI node for triggering cm-cli REST API calls.
This is optional - the REST API works independently.
"""
@classmethod
def INPUT_TYPES(cls):
return {
"required": {
"endpoint": (["health", "list_nodes", "update_all"], {
"default": "health"
}),
"trigger": ("BOOLEAN", {"default": False}),
},
"optional": {
"node_name": ("STRING", {"default": ""}),
}
}
RETURN_TYPES = ("STRING", "BOOLEAN")
RETURN_NAMES = ("response", "success")
CATEGORY = "utils/cm-cli-rest"
FUNCTION = "execute"
def execute(self, endpoint: str, trigger: bool, node_name: str = ""):
"""
Execute API call (synchronous, for simple endpoints only).
Note: For complex operations (install, update), use the REST API directly.
This node is mainly for health checks and simple queries.
"""
if not trigger:
return ("", False)
# For actual implementation, you would make HTTP requests to the API
# This is a placeholder - in practice, use the REST API directly
return (f"Use REST API at /cm-cli-rest/{endpoint}", True)
# Node registration (optional - the REST API is the main feature)
NODE_CLASS_MAPPINGS = {
"CMCLIRest": CMCLIRestNode,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"CMCLIRest": "cm-cli REST API",
}
__all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS"]