{"skill":{"slug":"hivulse-openclaw-skill","displayName":"Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档","summary":"hivulse蜂巢 AI 是一款面向软件开发的自动化技术文档生成工具，通过指定目录代码一键生成多种规范化技术文档。目前已支持的文档类型包括：用户需求说明书、需求规格说明书、系统概要设计说明、系统详细设计说明等10几种报告。申请API Key请访问 www.hivulse.com","description":"---\nname: hivulseAI\ndescription: hivulse蜂巢 AI 是一款面向软件开发的自动化技术文档生成工具，通过指定目录代码一键生成多种规范化技术文档。目前已支持的文档类型包括：用户需求说明书、需求规格说明书、系统概要设计说明、系统详细设计说明等10几种报告。申请API Key请访问 www.hivulse.com\n\nmetadata:\n  {\n    \"openclaw\": {\n      \"emoji\": \"📄\",\n      \"requires\": {\n        \"env\": [\"HIVULSE_API_KEY\"]\n      },\n      \"primaryEnv\": \"HIVULSE_API_KEY\"\n    }\n  }\nuser-invocable: true\n---\n\n# hivulseAI - 自动化技术文档生成工具\n\n通过API接口将指定目录的文件上传并生成各种技术文档的完整自动化工具。\n\n## 🚀 快速开始\n\n### 环境变量设置\n```bash\nexport HIVULSE_API_KEY=\"your-api-key-here\"\n```\n\n## 📋 支持的文档类型\n\n| 编号 | 文档类型 | 描述 |\n|------|----------|------|\n| 19 | 用户需求说明书 | 用户需求分析文档 |\n| 2 | 需求规格说明书 | 详细需求规格 |\n| 4 | 系统概要设计说明 | 系统架构设计 |\n| 5 | 系统详细设计说明 | 详细设计文档 |\n| 8 | 软件单元测试计划 | 单元测试计划 |\n| 9 | 软件单元测试用例 | 单元测试用例 |\n| 10 | 软件单元测试报告 | 单元测试报告 |\n| 1 | 系统测试计划 | 系统测试计划 |\n| 12 | 系统测试用例 | 系统测试用例 |\n| 15 | 系统测试报告 | 系统测试报告 |\n| 13 | 网络安全漏洞自评报告 | 安全评估报告 |\n| 20 | 软件用户测试用例 | 用户测试用例 |\n| 21 | 软件用户测试报告 | 用户测试报告 |\n\n\n## 🎯 触发关键词\n\n在OpenClaw会话中，当用户提到以下关键词时会自动触发此技能：\n- \"生成技术文档\"\n- \"创建文档\"\n- \"文档生成\"\n- \"hivulseAI\"\n- \"上传代码生成文档\"\n- \"需求规格说明书\"\n- \"系统设计文档\"\n\n## 🔧 OpenClaw技能调用方式\n\n### 方式1：直接触发\n在对话中直接使用触发关键词，例如：\n- \"帮我生成技术文档\"\n- \"使用hivulseAI生成需求规格说明书\"\n- \"为这个项目创建系统设计文档\"\n\n## 📋 参数说明\n\n| 参数 | 说明 | 示例 |\n|------|------|------|\n| 项目路径 | 要生成文档的代码项目目录 | `/Users/project/myapp` |\n| 文档类型 | 文档类型编号（2-21） | `2`（需求规格说明书） |\n| 任务名称 | 可选，文档任务名称 | `\"项目需求分析\"` |\n\n## 🌐 API配置\n- **API密钥**：通过配置文件设置，无需环境变量\n\n### 配置文件位置：\n`~/.hivulseai/config.json`\n\n### 手动编辑配置：\n```json\n{\n  \"api_key\": \"your-api-key-here\",\n  \"last_used_directory\": \"\"\n}\n```\n\n## 📁 文件过滤规则\n\n系统会自动过滤以下目录和文件：\n- `node_modules` - Node.js依赖目录\n- `venv` - Python虚拟环境\n- `.git` - Git版本控制\n- `__pycache__` - Python缓存\n- `.idea` - IDE配置\n- `.vscode` - VS Code配置\n- `*.pyc` - Python编译文件\n- `*.log` - 日志文件\n\n## 🔄 API调用流程\n\n### 1. 文件上传阶段\n```bash\nPOST /api/v1/repo/upload/file/\n- 第一个文件：不带branch_id\n- 后续文件：带branch_id（从第一个文件响应中获取）\n```\n\n### 2. 状态检查阶段\n```bash\nPOST /api/v1/repo/upload/status/\n- 参数：uuid（使用default_branch_id）\n```\n\n### 3. 文档生成阶段\n```bash\nPOST /api/v1/template_wiki/\n- 参数：task_name, template_base_id, branch_id, repo_id, is_advanced\n```\n\n## ⚠️ 注意事项\n\n1. **API密钥安全**：确保`HIVULSE_API_KEY`环境变量正确设置\n2. **网络连接**：确保可以访问指定的API地址\n3. **文件权限**：确保对目标目录有读取权限\n4. **文件大小**：注意单个文件大小限制\n5. **备份重要文件**：建议先备份重要代码\n\n## 🛠️ 故障排除\n\n### 常见错误\n- \"API密钥未设置\" → 检查`HIVULSE_API_KEY`环境变量\n- \"目录不存在\" → 检查路径是否正确\n- \"上传失败\" → 检查网络连接和API服务状态\n- \"文档类型不支持\" → 检查文档类型编号\n\n## 📞 支持\n\n如有问题，请检查：\n1. API服务是否正常运行\n2. 环境变量是否正确设置\n3. 网络连接是否正常\n4. 文件路径和权限是否正确\n","tags":{"latest":"0.1.4"},"stats":{"comments":1,"downloads":815,"installsAllTime":31,"installsCurrent":0,"stars":1,"versions":5},"createdAt":1773046211170,"updatedAt":1778996873752},"latestVersion":{"version":"0.1.4","createdAt":1773371407761,"changelog":"- Internal code updates made to hivulseAI.py.\n- No visible user-facing changes in functionality or documentation.\n- Version updated to 0.1.4 for maintenance and compatibility.","license":"MIT-0"},"metadata":{"setup":[{"key":"HIVULSE_API_KEY","required":true}],"os":null,"systems":null},"owner":{"handle":"mojo-bo-coder","userId":"s17dd0jxk3byeqzcvc7am80zss83h551","displayName":"Bo Cao","image":"https://avatars.githubusercontent.com/u/15248746?v=4"},"moderation":{"isSuspicious":false,"isMalwareBlocked":false,"verdict":"clean","reasonCodes":["review.llm_review"],"summary":"Review: review.llm_review","engineVersion":"v2.4.24","updatedAt":1780089863900}}