# @deppon/deppon-cli

Deppon UI / Pro 组件与 Cursor Skills 的**离线 CLI + MCP 服务**，供 AI Agent 查询文档、API 与示例源码。

## 安装

```bash
npm install -g @deppon/deppon-cli
# 或项目内
npx @deppon/deppon-cli list
```

需要 Node.js `>=18`。

## 快速开始

```bash
deppon list                           # 所有 UI + Pro 组件
deppon list ui                        # 仅 @deppon/deppon-ui
deppon list pro                       # 仅 Pro 组件
deppon list skill                     # Cursor Skills 索引

deppon info ProTable                  # Props / API 表格
deppon doc button                     # 完整 Markdown 文档
deppon demo button basic              # 示例 Vue 源码
deppon skill deppon-pro-form          # 读取 SKILL.md

deppon design-spec                    # Pro 设计规范
deppon mcp                            # 启动 MCP（stdio）
deppon mcp --transport sse --port 3000 --host 0.0.0.0   # SSE（JoyAgent 等）
deppon setup --client cursor --mode both
```

全局参数：`--format json|text|markdown`、`--lang zh|en`、`--detail`、`-h`。

## MCP（Cursor / VS Code）

```json
{
    "mcpServers": {
        "deppon": {
            "command": "npx",
            "args": ["-y", "@deppon/deppon-cli", "mcp"]
        }
    }
}
```

## MCP SSE（JoyAgent 等仅支持 URL 的平台）

**方式一：全局安装（推荐长期部署）**

```bash
npm install -g @deppon/deppon-cli@latest
deppon mcp --transport sse --port 3000 --host 0.0.0.0
```

**方式二：npx 临时启动（无需全局安装）**

```bash
npx @deppon/deppon-cli@latest mcp --transport sse --port 3000 --host 0.0.0.0
```

> `npx` 会自动下载并运行；终端关闭后服务停止。生产环境建议全局安装并用 pm2 / systemd 等做常驻。

在 JoyAgent「注册 MCP」中填写 SSE 地址，例如：

```text
http://<内网IP>:3000/sse
```

健康检查：`GET http://<host>:3000/health`

| 参数          | 默认        | 说明                                      |
| ------------- | ----------- | ----------------------------------------- |
| `--transport` | `stdio`     | `stdio` 或 `sse`                          |
| `--port`      | `3000`      | SSE 端口                                  |
| `--host`      | `127.0.0.1` | 监听地址；JoyAgent 远程访问时用 `0.0.0.0` |

环境变量：`DEPPON_MCP_TRANSPORT`、`DEPPON_MCP_PORT`、`DEPPON_MCP_HOST`

工具：`deppon_list`、`deppon_info`、`deppon_doc`、`deppon_demo`、`deppon_skill`。

## 与 @deppon/deppon-skills 的关系

| 包                      | 作用                                              |
| ----------------------- | ------------------------------------------------- |
| `@deppon/deppon-cli`    | 组件文档 / Demo / API 查询 + MCP                  |
| `@deppon/deppon-skills` | 场景化 Cursor Skills（ProForm 页、ProTable 页等） |

推荐：`deppon setup --mode both` 后执行 `npx deppon-skills-install`。

## 维护方（monorepo）

```bash
cd packages/deppon-cli
npm run build    # build:metadata + tsc
```

`build:metadata` 从 `docs/`、`.cursor/skills/` 生成 `data/` 离线知识库。