OpenClaw Skill · HivulseAI
在 OpenClaw 中
一键生成技术文档
通过 HivulseAI Skill，在 OpenClaw 对话中直接上传代码目录，自动生成需求规格说明书、系统设计文档、测试报告等 13 种专业技术文档。
触发关键词
在 OpenClaw 对话中输入以下任意关键词，即可自动触发 HivulseAI Skill：
生成技术文档
创建文档
文档生成
hivulseAI
上传代码生成文档
需求规格说明书
系统设计文档
支持的文档类型
| 编号 | 文档名称 | 描述 | 分类 |
|---|---|---|---|
| 19 | 用户需求说明书 | 用户需求分析文档 | 需求 |
| 2 | 需求规格说明书 | 详细需求规格 | 需求 |
| 4 | 系统概要设计说明 | 系统架构设计 | 设计 |
| 5 | 系统详细设计说明 | 详细设计文档 | 设计 |
| 8 | 软件单元测试计划 | 单元测试计划 | 测试 |
| 9 | 软件单元测试用例 | 单元测试用例 | 测试 |
| 10 | 软件单元测试报告 | 单元测试报告 | 测试 |
| 1 | 系统测试计划 | 系统测试计划 | 测试 |
| 12 | 系统测试用例 | 系统测试用例 | 测试 |
| 15 | 系统测试报告 | 系统测试报告 | 测试 |
| 13 | 网络安全漏洞自评报告 | 安全评估报告 | 安全 |
| 20 | 软件用户测试用例 | 用户测试用例 | 测试 |
| 21 | 软件用户测试报告 | 用户测试报告 | 测试 |
参数说明
项目路径
要生成文档的代码项目本地目录，需有读取权限
/Users/project/myapp
文档类型
文档类型编号，参见上方文档类型列表（1–21）
2（需求规格说明书）
任务名称
可选。为本次文档任务设置一个便于识别的名称
项目需求分析
API 配置
API Key 通过本地配置文件管理，无需每次传入环境变量。配置文件位于：
~/.hivulseai/config.json
json
{
"api_key": "your-api-key-here",
"last_used_directory": ""
}
安全提示：请勿将 config.json 提交到 Git 仓库，建议将
~/.hivulseai/ 目录加入 .gitignore。
文件过滤规则
上传时系统会自动忽略以下目录和文件类型，无需手动排除：
node_modules/
venv/
.git/
__pycache__/
.idea/
.vscode/
*.pyc
*.log
API 调用流程
阶段 1 — 文件上传
遍历项目目录，逐个上传代码文件。第一个文件不带 branch_id，后续文件携带第一次响应中返回的 branch_id。
endpoint
POST /api/v1/repo/upload/file/ # 首文件：不带 branch_id # 后续文件：带 branch_id（来自首文件响应）
阶段 2 — 状态检查
轮询上传状态，确认所有文件处理完成后再进入下一阶段。
endpoint
POST /api/v1/repo/upload/status/ # 参数：uuid（使用 default_branch_id）
阶段 3 — 文档生成
提交文档生成任务，传入任务名称、文档模板编号、branch_id 及 repo_id。
endpoint
POST /api/v1/template_wiki/ # 参数：task_name, template_base_id, # branch_id, repo_id, is_advanced
注意事项
API 密钥安全：确保 HIVULSE_API_KEY 或 config.json 中的密钥正确设置，不要泄露给第三方。
网络连接：上传阶段需要稳定的网络，确保可以访问 cloud.hivulse.com API 服务。
文件权限：确保对目标代码目录具有完整的读取权限，否则文件可能被跳过。
文件大小：单个文件有大小限制，超大文件会被自动跳过。建议上传前先清理编译产物。
故障排除
"API密钥未设置"
检查
HIVULSE_API_KEY 环境变量，或手动编辑 ~/.hivulseai/config.json"目录不存在"
确认输入的项目路径正确，使用绝对路径，避免带有特殊字符
"上传失败"
检查网络连接是否正常，以及 Hivulse API 服务是否可访问
"文档类型不支持"
检查文档类型编号是否在支持列表中（1、2、4、5、8–10、12、13、15、19–21）
还没有 Hivulse 账号？注册即可免费使用
免费注册，立即体验