@zzp123/mcp-zentao 1.18.9 → 1.18.10

package/scripts/README.md

@@ -1,315 +1,315 @@
-# 剪贴板图片上传脚本
-
-提供三种方案来获取剪贴板图片并上传到禅道系统。
-
-## 📋 方案对比
-
-| 方案 | 平台 | 优点 | 缺点 |
-|-----|------|------|------|
-| Node.js | 跨平台 | 与项目集成，无需额外配置 | 需要Node环境 |
-| PowerShell | Windows | 原生支持，无需安装依赖 | 仅Windows |
-| Python | 跨平台 | 简单易用，代码清晰 | 需要Python环境 |
-
-## 🚀 快速开始
-
-### 方案1: Node.js 脚本（推荐）
-
-**优点：** 跨平台，与项目无缝集成
-
-**依赖：**
-```bash
-# 安装 clipboardy（可选，用于跨平台剪贴板支持）
-npm install -g clipboardy
-```
-
-**使用方法：**
-
-**Windows:**
-```batch
-set ZENTAO_URL=https://your-zentao-url
-set ZENTAO_USERNAME=your-username
-set ZENTAO_PASSWORD=your-password
-set ZENTAO_UID=optional-uid
-
-node scripts/upload-clipboard-image.js
-```
-
-**Mac/Linux:**
-```bash
-export ZENTAO_URL=https://your-zentao-url
-export ZENTAO_USERNAME=your-username
-export ZENTAO_PASSWORD=your-password
-export ZENTAO_UID=optional-uid
-
-node scripts/upload-clipboard-image.js
-```
-
-**特性：**
-- ✅ 自动检测操作系统
-- ✅ Windows: 使用 PowerShell 读取剪贴板
-- ✅ macOS: 使用 pngpaste (需要安装: `brew install pngpaste`)
-- ✅ Linux: 使用 xclip (需要安装: `sudo apt-get install xclip`)
-- ✅ 自动保存到 img 文件夹
-- ✅ 返回禅道文件ID和URL
-
----
-
-### 方案2: PowerShell 脚本（Windows专用）
-
-**优点：** 原生支持，无需安装额外依赖
-
-**使用方法：**
-```powershell
-.\scripts\upload-clipboard-image.ps1 `
-    -ZentaoUrl "https://your-zentao-url" `
-    -Username "your-username" `
-    -Password "your-password" `
-    -Uid "optional-uid"
-```
-
-**或者创建批处理文件 `upload.bat`：**
-```batch
-@echo off
-powershell -ExecutionPolicy Bypass -File "%~dp0scripts\upload-clipboard-image.ps1" ^
-    -ZentaoUrl "https://your-zentao-url" ^
-    -Username "your-username" ^
-    -Password "your-password"
-```
-
-**特性：**
-- ✅ Windows原生支持
-- ✅ 无需安装额外工具
-- ✅ 支持所有图片格式
-- ✅ 自动转换为PNG
-- ✅ 显示图片尺寸
-
----
-
-### 方案3: Python 脚本（跨平台）
-
-**优点：** 简单易用，代码清晰
-
-**依赖安装：**
-```bash
-pip install pillow requests
-```
-
-**使用方法：**
-
-**Windows:**
-```batch
-set ZENTAO_URL=https://your-zentao-url
-set ZENTAO_USERNAME=your-username
-set ZENTAO_PASSWORD=your-password
-set ZENTAO_UID=optional-uid
-
-python scripts/upload-clipboard-image.py
-```
-
-**Mac/Linux:**
-```bash
-export ZENTAO_URL=https://your-zentao-url
-export ZENTAO_USERNAME=your-username
-export ZENTAO_PASSWORD=your-password
-export ZENTAO_UID=optional-uid
-
-python scripts/upload-clipboard-image.py
-```
-
-**特性：**
-- ✅ 跨平台支持
-- ✅ 使用 PIL/Pillow 处理图片
-- ✅ 支持剪贴板中的图片或图片文件路径
-- ✅ 显示图片尺寸
-- ✅ 详细的错误提示
-
----
-
-## 📝 环境变量说明
-
-| 变量名 | 必需 | 说明 | 示例 |
-|--------|------|------|------|
-| ZENTAO_URL | 是 | 禅道系统URL | https://zentao.example.com |
-| ZENTAO_USERNAME | 是 | 登录用户名 | admin |
-| ZENTAO_PASSWORD | 是 | 登录密码 | your-password |
-| ZENTAO_UID | 否 | 富文本编辑器关联ID | editor-123 |
-
-## 💡 使用技巧
-
-### 1. 创建快捷命令
-
-**Windows (创建 `upload.bat`):**
-```batch
-@echo off
-REM 设置禅道配置
-set ZENTAO_URL=https://your-zentao-url
-set ZENTAO_USERNAME=your-username
-set ZENTAO_PASSWORD=your-password
-
-REM 运行上传脚本
-node "%~dp0scripts\upload-clipboard-image.js"
-pause
-```
-
-**Mac/Linux (创建 `upload.sh`):**
-```bash
-#!/bin/bash
-# 设置禅道配置
-export ZENTAO_URL=https://your-zentao-url
-export ZENTAO_USERNAME=your-username
-export ZENTAO_PASSWORD=your-password
-
-# 运行上传脚本
-node "$(dirname "$0")/scripts/upload-clipboard-image.js"
-```
-
-然后：
-```bash
-chmod +x upload.sh
-./upload.sh
-```
-
-### 2. 配置文件方式
-
-创建 `.env` 文件：
-```env
-ZENTAO_URL=https://your-zentao-url
-ZENTAO_USERNAME=your-username
-ZENTAO_PASSWORD=your-password
-ZENTAO_UID=
-```
-
-然后加载环境变量：
-```bash
-# Linux/Mac
-source .env
-
-# Windows (使用 PowerShell)
-Get-Content .env | ForEach-Object {
-    $name, $value = $_.split('=')
-    Set-Content env:\$name $value
-}
-```
-
-### 3. 快捷键绑定
-
-可以将脚本绑定到系统快捷键，实现：
-1. 截图/复制图片
-2. 按快捷键
-3. 自动上传到禅道
-
-**Windows AutoHotkey 示例：**
-```ahk
-; Ctrl+Shift+U 上传剪贴板图片
-^+u::
-Run, cmd /c "cd /d C:\path\to\project && upload.bat"
-return
-```
-
-**Mac Automator 示例：**
-1. 打开 Automator
-2. 创建"快速操作"
-3. 添加"运行Shell脚本"
-4. 输入上传命令
-5. 在系统偏好设置中设置快捷键
-
-## 🔍 故障排查
-
-### Node.js 方案
-
-**问题：** `Error: Cannot find module 'form-data'`
-```bash
-npm install
-```
-
-**问题：** macOS 提示 `pngpaste: command not found`
-```bash
-brew install pngpaste
-```
-
-**问题：** Linux 提示 `xclip: command not found`
-```bash
-# Ubuntu/Debian
-sudo apt-get install xclip
-
-# CentOS/RHEL
-sudo yum install xclip
-```
-
-### PowerShell 方案
-
-**问题：** 脚本无法运行
-```powershell
-# 临时允许脚本执行
-Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
-
-# 或使用 -ExecutionPolicy 参数
-powershell -ExecutionPolicy Bypass -File upload-clipboard-image.ps1
-```
-
-### Python 方案
-
-**问题：** `ModuleNotFoundError: No module named 'PIL'`
-```bash
-pip install pillow
-```
-
-**问题：** `ModuleNotFoundError: No module named 'requests'`
-```bash
-pip install requests
-```
-
-## 📸 完整工作流示例
-
-1. **截图或复制图片**
-   - Windows: Win+Shift+S 或 PrintScreen
-   - Mac: Cmd+Shift+Ctrl+4
-   - 或从任意应用复制图片
-
-2. **运行上传脚本**
-   ```bash
-   # 使用你选择的方案
-   node scripts/upload-clipboard-image.js
-   # 或
-   .\scripts\upload-clipboard-image.ps1 -ZentaoUrl ... -Username ... -Password ...
-   # 或
-   python scripts/upload-clipboard-image.py
-   ```
-
-3. **获取结果**
-   ```
-   ========================================
-   ✓ 上传成功！
-   ========================================
-   文件ID: 123
-   访问URL: /zentao/file-read-123.png
-   本地路径: C:\project\img\clipboard_1234567890.png
-   ========================================
-   ```
-
-4. **在禅道中使用**
-   - 复制返回的URL
-   - 在需求/Bug/任务描述中插入图片
-   - 使用 `![图片](/zentao/file-read-123.png)` 或直接粘贴URL
-
-## 🎯 高级用法
-
-### 批量上传
-
-创建一个循环脚本，持续监听剪贴板变化并自动上传。
-
-### 与富文本编辑器集成
-
-设置 `ZENTAO_UID` 环境变量，将上传的图片关联到特定的编辑器会话。
-
-### 自定义保存路径
-
-修改脚本中的 `imgDir` 变量，将图片保存到自定义位置。
-
-## 📄 许可证
-
-MIT
-
-## 🤝 贡献
-
-欢迎提交 Issue 和 Pull Request！
+# 剪贴板图片上传脚本
+
+提供三种方案来获取剪贴板图片并上传到禅道系统。
+
+## 📋 方案对比
+
+| 方案 | 平台 | 优点 | 缺点 |
+|-----|------|------|------|
+| Node.js | 跨平台 | 与项目集成，无需额外配置 | 需要Node环境 |
+| PowerShell | Windows | 原生支持，无需安装依赖 | 仅Windows |
+| Python | 跨平台 | 简单易用，代码清晰 | 需要Python环境 |
+
+## 🚀 快速开始
+
+### 方案1: Node.js 脚本（推荐）
+
+**优点：** 跨平台，与项目无缝集成
+
+**依赖：**
+```bash
+# 安装 clipboardy（可选，用于跨平台剪贴板支持）
+npm install -g clipboardy
+```
+
+**使用方法：**
+
+**Windows:**
+```batch
+set ZENTAO_URL=https://your-zentao-url
+set ZENTAO_USERNAME=your-username
+set ZENTAO_PASSWORD=your-password
+set ZENTAO_UID=optional-uid
+
+node scripts/upload-clipboard-image.js
+```
+
+**Mac/Linux:**
+```bash
+export ZENTAO_URL=https://your-zentao-url
+export ZENTAO_USERNAME=your-username
+export ZENTAO_PASSWORD=your-password
+export ZENTAO_UID=optional-uid
+
+node scripts/upload-clipboard-image.js
+```
+
+**特性：**
+- ✅ 自动检测操作系统
+- ✅ Windows: 使用 PowerShell 读取剪贴板
+- ✅ macOS: 使用 pngpaste (需要安装: `brew install pngpaste`)
+- ✅ Linux: 使用 xclip (需要安装: `sudo apt-get install xclip`)
+- ✅ 自动保存到 img 文件夹
+- ✅ 返回禅道文件ID和URL
+
+---
+
+### 方案2: PowerShell 脚本（Windows专用）
+
+**优点：** 原生支持，无需安装额外依赖
+
+**使用方法：**
+```powershell
+.\scripts\upload-clipboard-image.ps1 `
+    -ZentaoUrl "https://your-zentao-url" `
+    -Username "your-username" `
+    -Password "your-password" `
+    -Uid "optional-uid"
+```
+
+**或者创建批处理文件 `upload.bat`：**
+```batch
+@echo off
+powershell -ExecutionPolicy Bypass -File "%~dp0scripts\upload-clipboard-image.ps1" ^
+    -ZentaoUrl "https://your-zentao-url" ^
+    -Username "your-username" ^
+    -Password "your-password"
+```
+
+**特性：**
+- ✅ Windows原生支持
+- ✅ 无需安装额外工具
+- ✅ 支持所有图片格式
+- ✅ 自动转换为PNG
+- ✅ 显示图片尺寸
+
+---
+
+### 方案3: Python 脚本（跨平台）
+
+**优点：** 简单易用，代码清晰
+
+**依赖安装：**
+```bash
+pip install pillow requests
+```
+
+**使用方法：**
+
+**Windows:**
+```batch
+set ZENTAO_URL=https://your-zentao-url
+set ZENTAO_USERNAME=your-username
+set ZENTAO_PASSWORD=your-password
+set ZENTAO_UID=optional-uid
+
+python scripts/upload-clipboard-image.py
+```
+
+**Mac/Linux:**
+```bash
+export ZENTAO_URL=https://your-zentao-url
+export ZENTAO_USERNAME=your-username
+export ZENTAO_PASSWORD=your-password
+export ZENTAO_UID=optional-uid
+
+python scripts/upload-clipboard-image.py
+```
+
+**特性：**
+- ✅ 跨平台支持
+- ✅ 使用 PIL/Pillow 处理图片
+- ✅ 支持剪贴板中的图片或图片文件路径
+- ✅ 显示图片尺寸
+- ✅ 详细的错误提示
+
+---
+
+## 📝 环境变量说明
+
+| 变量名 | 必需 | 说明 | 示例 |
+|--------|------|------|------|
+| ZENTAO_URL | 是 | 禅道系统URL | https://zentao.example.com |
+| ZENTAO_USERNAME | 是 | 登录用户名 | admin |
+| ZENTAO_PASSWORD | 是 | 登录密码 | your-password |
+| ZENTAO_UID | 否 | 富文本编辑器关联ID | editor-123 |
+
+## 💡 使用技巧
+
+### 1. 创建快捷命令
+
+**Windows (创建 `upload.bat`):**
+```batch
+@echo off
+REM 设置禅道配置
+set ZENTAO_URL=https://your-zentao-url
+set ZENTAO_USERNAME=your-username
+set ZENTAO_PASSWORD=your-password
+
+REM 运行上传脚本
+node "%~dp0scripts\upload-clipboard-image.js"
+pause
+```
+
+**Mac/Linux (创建 `upload.sh`):**
+```bash
+#!/bin/bash
+# 设置禅道配置
+export ZENTAO_URL=https://your-zentao-url
+export ZENTAO_USERNAME=your-username
+export ZENTAO_PASSWORD=your-password
+
+# 运行上传脚本
+node "$(dirname "$0")/scripts/upload-clipboard-image.js"
+```
+
+然后：
+```bash
+chmod +x upload.sh
+./upload.sh
+```
+
+### 2. 配置文件方式
+
+创建 `.env` 文件：
+```env
+ZENTAO_URL=https://your-zentao-url
+ZENTAO_USERNAME=your-username
+ZENTAO_PASSWORD=your-password
+ZENTAO_UID=
+```
+
+然后加载环境变量：
+```bash
+# Linux/Mac
+source .env
+
+# Windows (使用 PowerShell)
+Get-Content .env | ForEach-Object {
+    $name, $value = $_.split('=')
+    Set-Content env:\$name $value
+}
+```
+
+### 3. 快捷键绑定
+
+可以将脚本绑定到系统快捷键，实现：
+1. 截图/复制图片
+2. 按快捷键
+3. 自动上传到禅道
+
+**Windows AutoHotkey 示例：**
+```ahk
+; Ctrl+Shift+U 上传剪贴板图片
+^+u::
+Run, cmd /c "cd /d C:\path\to\project && upload.bat"
+return
+```
+
+**Mac Automator 示例：**
+1. 打开 Automator
+2. 创建"快速操作"
+3. 添加"运行Shell脚本"
+4. 输入上传命令
+5. 在系统偏好设置中设置快捷键
+
+## 🔍 故障排查
+
+### Node.js 方案
+
+**问题：** `Error: Cannot find module 'form-data'`
+```bash
+npm install
+```
+
+**问题：** macOS 提示 `pngpaste: command not found`
+```bash
+brew install pngpaste
+```
+
+**问题：** Linux 提示 `xclip: command not found`
+```bash
+# Ubuntu/Debian
+sudo apt-get install xclip
+
+# CentOS/RHEL
+sudo yum install xclip
+```
+
+### PowerShell 方案
+
+**问题：** 脚本无法运行
+```powershell
+# 临时允许脚本执行
+Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
+
+# 或使用 -ExecutionPolicy 参数
+powershell -ExecutionPolicy Bypass -File upload-clipboard-image.ps1
+```
+
+### Python 方案
+
+**问题：** `ModuleNotFoundError: No module named 'PIL'`
+```bash
+pip install pillow
+```
+
+**问题：** `ModuleNotFoundError: No module named 'requests'`
+```bash
+pip install requests
+```
+
+## 📸 完整工作流示例
+
+1. **截图或复制图片**
+   - Windows: Win+Shift+S 或 PrintScreen
+   - Mac: Cmd+Shift+Ctrl+4
+   - 或从任意应用复制图片
+
+2. **运行上传脚本**
+   ```bash
+   # 使用你选择的方案
+   node scripts/upload-clipboard-image.js
+   # 或
+   .\scripts\upload-clipboard-image.ps1 -ZentaoUrl ... -Username ... -Password ...
+   # 或
+   python scripts/upload-clipboard-image.py
+   ```
+
+3. **获取结果**
+   ```
+   ========================================
+   ✓ 上传成功！
+   ========================================
+   文件ID: 123
+   访问URL: /zentao/file-read-123.png
+   本地路径: C:\project\img\clipboard_1234567890.png
+   ========================================
+   ```
+
+4. **在禅道中使用**
+   - 复制返回的URL
+   - 在需求/Bug/任务描述中插入图片
+   - 使用 `![图片](/zentao/file-read-123.png)` 或直接粘贴URL
+
+## 🎯 高级用法
+
+### 批量上传
+
+创建一个循环脚本，持续监听剪贴板变化并自动上传。
+
+### 与富文本编辑器集成
+
+设置 `ZENTAO_UID` 环境变量，将上传的图片关联到特定的编辑器会话。
+
+### 自定义保存路径
+
+修改脚本中的 `imgDir` 变量，将图片保存到自定义位置。
+
+## 📄 许可证
+
+MIT
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！