congmao-cli 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,128 @@
-# cm-cli
-cli
+```
+ ██████╗ ███╗   ███╗     ██████╗ ██╗     ██╗
+██╔════╝ ████╗ ████║    ██╔════╝ ██║     ██║
+██║      ██╔████╔██║    ██║      ██║     ██║
+██║      ██║╚██╔╝██║    ██║      ██║     ██║
+╚██████╗ ██║ ╚═╝ ██║    ╚██████╗ ███████╗██║
+ ╚═════╝ ╚═╝     ╚═╝     ╚═════╝ ╚══════╝╚═╝
+```
+
+<p>
+  <a href="https://www.npmjs.com/package/congmao-cli"><img src="https://img.shields.io/npm/v/congmao-cli.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
+</p>
+
+# CM CLI
+
+> 丛茂科技项目脚手架工具，快速创建项目
+
+## 📦 安装
+
+### 全局安装
+
+```bash
+npm install -g congmao-cli
+```
+
+安装完成后，可以使用 `cm` 命令。
+
+### 验证安装
+
+```bash
+cm --version
+```
+
+## 🚀 快速开始
+
+### 创建项目
+
+```bash
+cm create
+```
+
+## 📖 命令说明
+
+### `cm create`
+
+创建新项目，支持交互式选择项目类型和配置。
+
+**支持的项目类型：**
+
+| 类型         | 模板      | 说明                   |
+| ------------ | --------- | ---------------------- |
+| 移动端       | Uni-app   | 适用于移动端应用开发   |
+| 小程序       | Uni-app   | 适用于小程序开发       |
+| 后台管理系统 | Vue2/Vue3 | 适用于后台管理系统开发 |
+
+**示例：**
+
+```bash
+# 交互式创建项目
+cm create
+
+# 创建后的项目结构
+my-project/
+├── src/
+├── package.json
+└── ...
+```
+
+### `cm mcp`
+
+启动 MCP (Model Context Protocol) 服务器，用于集成到 AI Agent 应用。
+
+**选项：**
+
+- `--config-only`: 仅显示配置信息
+
+**使用示例：**
+
+```bash
+# 启动 MCP 服务器并显示配置信息
+cm mcp
+```
+
+**MCP 服务器功能：**
+
+1. **create-project** - 快速创建项目
+
+   - 支持移动端、小程序、后台管理系统
+   - 可配置 Vue 版本和 ESLint
+
+2. **show-project-tree** - 查看项目结构树
+
+   - 显示项目目录结构
+   - 可配置最大深度和忽略模式
+
+## 🔧 MCP 服务器集成
+
+**配置示例：**
+
+```json
+{
+  "mcpServers": {
+    "cm-cli": {
+      "command": "node",
+      "args": ["/path/to/cm-cli/src/mcp/src/index.js"]
+    }
+  }
+}
+```
+
+详细配置指南请查看 [MCP 配置文档](./src/mcp/CURSOR_SETUP.md)
+
+## 📝 许可证
+
+MPL
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📞 联系方式
+
+- GitHub: [aZeroDoubleSeven/cm-cli](https://github.com/aZeroDoubleSeven/cm-cli)
+- Issues: [提交问题](https://github.com/aZeroDoubleSeven/cm-cli/issues)
+
+---
+
+**Made with ❤️ by 丛茂科技前端开发团队**

package/bin/index.js

@@ -13,7 +13,7 @@ program.command("create").description("创建初始化项目").action(create);
 
 program
   .command("mcp")
-  .description("启动 MCP stdio 服务器并显示配置信息（用于 Cursor）")
+  .description("启动 MCP stdio 服务器并显示配置信息（用于集成MCP的AI Agent应用）")
   .option("--config-only", "仅显示配置信息，不启动服务器", false)
   .action(mcp);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "congmao-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "cli",
   "type": "module",
   "main": "index.js",
@@ -24,7 +24,7 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MPL",
   "bugs": {
     "url": "https://github.com/aZeroDoubleSeven/cm-cli/issues"
   },

package/src/commands/mcp.js

@@ -97,7 +97,7 @@ async function startMCPServer() {
 
   try {
     // 启动 stdio 服务器（用于 Cursor）
-    console.log(chalk.green("🚀 正在启动 MCP stdio 服务器（用于 Cursor）...\n"));
+    console.log(chalk.green("🚀 正在启动 MCP stdio 服务器..."));
     
     const { spawn } = await import("child_process");
     const stdioProcess = spawn("node", [mcpServerPath], {
@@ -110,8 +110,7 @@ async function startMCPServer() {
       process.exit(1);
     });
 
-    console.log(chalk.green(`✅ MCP stdio 服务器已启动（用于 Cursor）`));
-    console.log(chalk.gray(`   按 Ctrl+C 停止服务器\n`));
+    console.log(chalk.green(`✅ MCP stdio 服务器已启动!`));
 
     // 处理退出信号
     process.on("SIGINT", () => {
@@ -147,7 +146,7 @@ export default async function mcp(options = {}) {
 
   // 如果只是查看配置，不启动服务器
   if (options.configOnly) {
-    console.log(chalk.gray("💡 提示: 使用 'cm mcp' 可以启动 MCP stdio 服务器（用于 Cursor）\n"));
+    console.log(chalk.gray("💡 提示: 使用 'cm mcp' 可以启动 MCP stdio 服务器"));
     return;
   }
 

package/src/mcp/CURSOR_SETUP.md

@@ -1,259 +0,0 @@
-# 在 Cursor 中使用 CM CLI MCP 服务器
-
-本指南将帮助你在 Cursor 中配置和使用 CM CLI MCP 服务器。
-
-## 🚀 快速开始
-
-1. **安装依赖（首次使用必需）**
-   ```bash
-   cd src/mcp
-   pnpm install
-   ```
-   这会安装 MCP SDK 等必要的依赖包。
-
-2. **获取配置信息**
-   ```bash
-   pnpm run get-config
-   ```
-   这会显示你需要的配置信息。
-
-2. **在 Cursor 中配置**
-   - 打开设置 (`Ctrl+,` 或 `Cmd+,`)
-   - 搜索 "MCP"
-   - 添加显示的配置
-
-3. **重启 Cursor**
-
-4. **开始使用**
-   在 Cursor 的 AI 聊天中，你可以说：
-   - "请创建一个 Vue2 后台管理系统项目"
-   - "请查看当前项目的结构树"
-
-## 前置要求
-
-1. 确保已安装 Node.js (v18 或更高版本)
-2. 确保已安装 pnpm：`npm install -g pnpm`
-3. **重要**: 首次使用前必须安装项目依赖：
-   ```bash
-   cd src/mcp
-   pnpm install
-   ```
-   如果遇到依赖问题，可以使用 `pnpm install --force` 强制重新安装。
-
-## 配置步骤
-
-### 方法 1: 通过 Cursor 设置配置（推荐）
-
-1. **打开 Cursor 设置**
-   - 按 `Ctrl+,` (Windows/Linux) 或 `Cmd+,` (Mac) 打开设置
-   - 或者点击左下角齿轮图标 → Settings
-
-2. **找到 MCP 设置**
-   - 在设置搜索框中输入 "MCP" 或 "Model Context Protocol"
-   - 找到 MCP 服务器配置选项
-
-3. **添加 MCP 服务器配置**
-   
-   运行以下命令获取配置：
-   ```bash
-   cm mcp --config-only
-   ```
-   
-   或者手动添加以下内容（JSON 格式）：
-
-   ```json
-   {
-     "mcpServers": {
-       "cm-cli": {
-         "command": "node",
-         "args": [
-           "/path/to/cm-cli/src/mcp/src/index.js"
-         ]
-       }
-     }
-   }
-   ```
-
-   **重要**: 
-   - Cursor 使用 **stdio 传输**，必须使用 `command` + `args` 格式
-   - 请将路径替换为你的实际项目路径
-   - 不需要指定端口，stdio 传输不依赖端口
-
-### 方法 2: 通过配置文件
-
-1. **找到 Cursor 配置文件位置**
-   - Windows: `%APPDATA%\Cursor\User\globalStorage\cursor.mcp\settings.json`
-   - macOS: `~/Library/Application Support/Cursor/User/globalStorage/cursor.mcp/settings.json`
-   - Linux: `~/.config/Cursor/User/globalStorage/cursor.mcp/settings.json`
-
-2. **编辑配置文件**
-
-   如果文件不存在，创建它。添加以下内容：
-
-   ```json
-   {
-     "mcpServers": {
-       "cm-cli": {
-         "command": "node",
-         "args": [
-           "/absolute/path/to/cm-cli/src/mcp/src/index.js"
-         ]
-       }
-     }
-   }
-   ```
-
-3. **重启 Cursor**
-
-   保存配置文件后，重启 Cursor 使配置生效。
-
-## 验证配置
-
-配置完成后，你可以通过以下方式验证：
-
-1. **在 Cursor 中询问 AI**
-   - 打开 Cursor 的 AI 聊天面板
-   - 输入：`请使用 create-project 工具创建一个 Vue2 项目`
-   - 如果配置正确，AI 应该能够调用 MCP 工具
-
-2. **查看可用工具**
-   - 询问 AI：`列出可用的 MCP 工具`
-   - 应该能看到 `create-project` 和 `show-project-tree` 两个工具
-
-## 使用示例
-
-### 示例 1: 创建项目
-
-在 Cursor 的 AI 聊天中，你可以这样请求：
-
-```
-请使用 create-project 工具创建一个名为 "my-admin-app" 的后台管理系统项目，
-使用 Vue2，并配置 ESLint。
-```
-
-AI 会自动调用 MCP 工具并创建项目。
-
-### 示例 2: 查看项目结构
-
-```
-请使用 show-project-tree 工具查看当前项目的结构树，最大深度为 2。
-```
-
-### 示例 3: 创建移动端项目
-
-```
-请创建一个名为 "my-mobile-app" 的移动端项目（Uni-app），不配置 ESLint。
-```
-
-## 路径配置说明
-
-### Windows 路径示例
-```json
-{
-  "args": [
-    "D:\\files\\test\\cli\\cm-cli\\src\\mcp\\src\\index.js"
-  ]
-}
-```
-
-### macOS/Linux 路径示例
-```json
-{
-  "args": [
-    "/Users/username/projects/cm-cli/src/mcp/src/index.js"
-  ]
-}
-```
-
-### 使用相对路径（如果可能）
-
-某些情况下，Cursor 可能支持相对路径，但建议使用绝对路径以确保可靠性。
-
-## 故障排除
-
-### 问题 1: MCP 服务器无法启动
-
-**解决方案**:
-1. 检查 Node.js 是否正确安装：`node --version`
-2. 检查路径是否正确（使用绝对路径）
-3. 检查依赖是否已安装：`cd src/mcp && pnpm install`
-
-### 问题 2: AI 无法识别工具
-
-**解决方案**:
-1. 重启 Cursor
-2. 检查配置文件格式是否正确（JSON 格式）
-3. 查看 Cursor 的开发者工具（如果有）查看错误信息
-
-### 问题 3: 工具执行失败
-
-**解决方案**:
-1. 确保项目路径存在且可访问
-2. 检查文件权限
-3. 查看控制台错误信息
-
-## 高级配置
-
-### 使用环境变量
-
-如果需要设置环境变量，可以在配置中添加：
-
-```json
-{
-  "mcpServers": {
-    "cm-cli": {
-      "command": "node",
-      "args": [
-        "/path/to/cm-cli/src/mcp/src/index.js"
-      ],
-      "env": {
-        "NODE_ENV": "production"
-      }
-    }
-  }
-}
-```
-
-### 使用 npm/pnpm 脚本
-
-如果你想通过 npm 脚本运行，可以创建一个启动脚本：
-
-在 `src/mcp/package.json` 中添加：
-
-```json
-{
-  "scripts": {
-    "start": "node src/index.js"
-  }
-}
-```
-
-然后在 Cursor 配置中使用：
-
-```json
-{
-  "mcpServers": {
-    "cm-cli": {
-      "command": "pnpm",
-      "args": ["--dir", "/path/to/cm-cli/src/mcp", "start"]
-    }
-  }
-}
-```
-
-## 测试 MCP 服务器
-
-在配置之前，你可以先手动测试 MCP 服务器是否正常工作：
-
-```bash
-cd src/mcp
-node src/index.js
-```
-
-如果服务器正常启动，你应该看到类似 "CM CLI MCP 服务器已启动" 的消息。
-
-## 更多信息
-
-- 查看 [README.md](./README.md) 了解工具详细说明
-- 查看 [test-mcp.js](./test-mcp.js) 了解如何测试
-

package/src/mcp/README.md

@@ -1,134 +0,0 @@
-# CM CLI MCP 服务器
-
-CM CLI 的 Model Context Protocol (MCP) 服务器，为 AI 助手提供快速创建项目和查看项目结构的能力。
-
-## 功能
-
-### 1. 快速创建项目 (`create-project`)
-
-支持创建以下类型的项目：
-- **移动端** (mobile): 使用 Uni-app 模板
-- **小程序** (miniprogram): 使用 Uni-app 模板
-- **后台管理系统** (admin): 使用 Vue2 或 Vue3 模板
-
-#### 参数
-
-- `projectName` (必需): 项目名称，只能包含小写字母、数字和连字符
-- `projectType` (必需): 项目类型，可选值：`mobile`、`miniprogram`、`admin`
-- `vueVersion` (可选): Vue 版本，当 `projectType` 为 `admin` 时必需，可选值：`Vue2`、`Vue3`
-- `needESLint` (可选): 是否配置 ESLint，默认为 `true`
-- `targetPath` (可选): 目标路径，默认为当前工作目录
-
-#### 示例
-
-```json
-{
-  "projectName": "my-admin-project",
-  "projectType": "admin",
-  "vueVersion": "Vue2",
-  "needESLint": true
-}
-```
-
-### 2. 查看项目结构树 (`show-project-tree`)
-
-显示指定项目的目录结构树。
-
-#### 参数
-
-- `projectPath` (必需): 项目路径，可以是相对路径或绝对路径
-- `maxDepth` (可选): 最大深度，默认为 `3`
-- `ignorePatterns` (可选): 忽略的目录模式，默认为 `["node_modules", ".git", "dist", "build"]`
-
-#### 示例
-
-```json
-{
-  "projectPath": "./my-project",
-  "maxDepth": 2,
-  "ignorePatterns": ["node_modules", ".git"]
-}
-```
-
-## 使用方法
-
-### 安装依赖（首次使用必需）
-
-```bash
-cd src/mcp
-pnpm install
-```
-
-### 作为 MCP 服务器运行
-
-```bash
-cd src/mcp
-node src/index.js
-```
-
-### 在 Cursor 中配置
-
-**详细配置指南请查看 [CURSOR_SETUP.md](./CURSOR_SETUP.md)**
-
-快速配置步骤：
-
-1. 打开 Cursor 设置（`Ctrl+,` 或 `Cmd+,`）
-2. 搜索 "MCP" 或 "Model Context Protocol"
-3. 添加以下配置（替换为你的实际路径）：
-
-```json
-{
-  "mcpServers": {
-    "cm-cli": {
-      "command": "node",
-      "args": [
-        "/absolute/path/to/cm-cli/src/mcp/src/index.js"
-      ]
-    }
-  }
-}
-```
-
-4. 重启 Cursor
-
-### 在 Claude Desktop 中配置
-
-在 Claude Desktop 的配置文件中添加：
-
-```json
-{
-  "mcpServers": {
-    "cm-cli": {
-      "command": "node",
-      "args": ["/path/to/cm-cli/src/mcp/src/index.js"]
-    }
-  }
-}
-```
-
-## 测试
-
-运行测试脚本：
-
-```bash
-cd src/mcp
-node test-mcp.js
-```
-
-## 使用示例
-
-详细的使用示例请查看 [USAGE_EXAMPLES.md](./USAGE_EXAMPLES.md)
-
-## 项目结构
-
-```
-src/mcp/
-├── src/
-│   ├── index.js      # MCP 服务器主文件
-│   ├── handlers.js   # 工具处理逻辑
-│   └── schemas.js    # 输入验证
-├── package.json
-├── README.md
-└── test-mcp.js      # 测试脚本
-```
-

package/src/mcp/USAGE_EXAMPLES.md

@@ -1,181 +0,0 @@
-# create-project 工具使用示例
-
-## 工具说明
-
-`create-project` 是 CM CLI MCP 服务器提供的工具，用于快速创建项目。
-
-## 支持的项目类型
-
-1. **移动端 (mobile)**: 使用 Uni-app 模板
-2. **小程序 (miniprogram)**: 使用 Uni-app 模板
-3. **后台管理系统 (admin)**: 使用 Vue2 或 Vue3 模板
-
-## 参数说明
-
-| 参数 | 类型 | 必需 | 说明 |
-|------|------|------|------|
-| `projectName` | string | ✅ | 项目名称，只能包含小写字母、数字和连字符 |
-| `projectType` | string | ✅ | 项目类型：`mobile`、`miniprogram`、`admin` |
-| `vueVersion` | string | ⚠️ | Vue 版本：`Vue2` 或 `Vue3`（仅当 `projectType` 为 `admin` 时必需） |
-| `needESLint` | boolean | ❌ | 是否配置 ESLint，默认为 `true` |
-| `targetPath` | string | ❌ | 目标路径，默认为当前工作目录 |
-
-## 使用示例
-
-### 示例 1: 创建 Vue2 后台管理系统
-
-```json
-{
-  "projectName": "my-admin-app",
-  "projectType": "admin",
-  "vueVersion": "Vue2",
-  "needESLint": true
-}
-```
-
-**在 Cursor 中使用**:
-```
-请使用 create-project 工具创建一个名为 "my-admin-app" 的后台管理系统项目，
-使用 Vue2，并配置 ESLint。
-```
-
-### 示例 2: 创建 Vue3 后台管理系统（不配置 ESLint）
-
-```json
-{
-  "projectName": "my-vue3-app",
-  "projectType": "admin",
-  "vueVersion": "Vue3",
-  "needESLint": false
-}
-```
-
-**在 Cursor 中使用**:
-```
-请创建一个名为 "my-vue3-app" 的 Vue3 后台管理系统项目，不配置 ESLint。
-```
-
-### 示例 3: 创建移动端项目
-
-```json
-{
-  "projectName": "my-mobile-app",
-  "projectType": "mobile",
-  "needESLint": true
-}
-```
-
-**在 Cursor 中使用**:
-```
-请创建一个名为 "my-mobile-app" 的移动端项目。
-```
-
-### 示例 4: 创建小程序项目
-
-```json
-{
-  "projectName": "my-miniprogram",
-  "projectType": "miniprogram",
-  "needESLint": false
-}
-```
-
-**在 Cursor 中使用**:
-```
-请创建一个名为 "my-miniprogram" 的小程序项目，不配置 ESLint。
-```
-
-### 示例 5: 指定目标路径
-
-```json
-{
-  "projectName": "my-project",
-  "projectType": "admin",
-  "vueVersion": "Vue2",
-  "targetPath": "/path/to/projects"
-}
-```
-
-## 返回结果
-
-成功创建项目后，会返回：
-
-```json
-{
-  "success": true,
-  "message": "项目创建成功！\n\ncd my-project\npnpm install\npnpm run lint\npnpm run dev",
-  "projectPath": "/absolute/path/to/my-project",
-  "templateName": "Vue2",
-  "startCommands": "cd my-project\npnpm install\npnpm run lint\npnpm run dev"
-}
-```
-
-## 错误处理
-
-### 错误 1: 项目名称格式不正确
-
-```json
-{
-  "success": false,
-  "error": "项目名称只能包含小写字母、数字和连字符"
-}
-```
-
-**解决方案**: 确保项目名称只包含小写字母、数字和连字符（如：`my-project-123`）
-
-### 错误 2: 后台管理系统缺少 Vue 版本
-
-```json
-{
-  "success": false,
-  "error": "后台管理系统需要指定Vue版本"
-}
-```
-
-**解决方案**: 当 `projectType` 为 `admin` 时，必须提供 `vueVersion` 参数
-
-### 错误 3: 目录已存在
-
-```json
-{
-  "success": false,
-  "error": "目录已存在: /path/to/project"
-}
-```
-
-**解决方案**: 选择不同的项目名称或删除已存在的目录
-
-### 错误 4: 模板不存在
-
-```json
-{
-  "success": false,
-  "error": "模板不存在: /path/to/template"
-}
-```
-
-**解决方案**: 检查模板目录是否存在，或联系管理员
-
-## 常见问题
-
-### Q: 项目名称可以使用大写字母吗？
-A: 不可以。项目名称只能包含小写字母、数字和连字符。
-
-### Q: 可以在已存在的目录中创建项目吗？
-A: 不可以。目标目录必须不存在，否则会返回错误。
-
-### Q: ESLint 配置是必需的吗？
-A: 不是。可以通过设置 `needESLint: false` 来跳过 ESLint 配置。
-
-### Q: 创建的项目在哪里？
-A: 默认在当前工作目录下创建。可以通过 `targetPath` 参数指定其他路径。
-
-## 下一步
-
-项目创建成功后，按照返回的启动命令操作：
-
-1. 进入项目目录：`cd project-name`
-2. 安装依赖：`pnpm install`
-3. （如果配置了 ESLint）运行代码检查：`pnpm run lint`
-4. 启动开发服务器：`pnpm run dev` 或 `pnpm run dev:h5`
-