← Back to Skills Marketplace
96
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install hivulse-generate-tech-docs
Description
hivulse蜂巢 AI 是一款面向软件开发的自动化技术文档生成工具，通过指定目录代码一键生成多种规范化技术文档。目前已支持的文档类型包括：用户需求说明书、需求规格说明书、系统概要设计说明、系统详细设计说明等10几种报告。申请API Key请访问 www.hivulse.com
README (SKILL.md)
hivulseAI - 自动化技术文档生成工具
通过API接口将指定目录的文件上传并生成各种技术文档的完整自动化工具。
🚀 快速开始
环境变量设置
export HIVULSE_API_KEY="your-api-key-here"
📋 支持的文档类型
| 编号 | 文档类型 | 描述 |
|---|---|---|
| 19 | 用户需求说明书 | 用户需求分析文档 |
| 2 | 需求规格说明书 | 详细需求规格 |
| 4 | 系统概要设计说明 | 系统架构设计 |
| 5 | 系统详细设计说明 | 详细设计文档 |
| 8 | 软件单元测试计划 | 单元测试计划 |
| 9 | 软件单元测试用例 | 单元测试用例 |
| 10 | 软件单元测试报告 | 单元测试报告 |
| 1 | 系统测试计划 | 系统测试计划 |
| 12 | 系统测试用例 | 系统测试用例 |
| 15 | 系统测试报告 | 系统测试报告 |
| 13 | 网络安全漏洞自评报告 | 安全评估报告 |
| 20 | 软件用户测试用例 | 用户测试用例 |
| 21 | 软件用户测试报告 | 用户测试报告 |
🎯 触发关键词
在OpenClaw会话中，当用户提到以下关键词时会自动触发此技能：
- "生成技术文档"
- "创建文档"
- "文档生成"
- "hivulseAI"
- "上传代码生成文档"
- "需求规格说明书"
- "系统设计文档"
🔧 OpenClaw技能调用方式
方式1：直接触发
在对话中直接使用触发关键词，例如：
- "帮我生成技术文档"
- "使用hivulseAI生成需求规格说明书"
- "为这个项目创建系统设计文档"
执行方式
通过Python脚本执行
python3 hivulseAI.py \x3C目录路径> \x3C文档类型编号> [--task-name "任务名称"]
📋 参数说明
| 参数 | 说明 | 示例 |
|---|---|---|
| 项目路径 | 要生成文档的代码项目目录 | /Users/project/myapp |
| 文档类型 | 文档类型编号（2-21） | 2（需求规格说明书） |
| 任务名称 | 可选，文档任务名称 | "项目需求分析" |
🌐 API配置
- API密钥：通过配置文件设置，无需环境变量
配置文件位置：
~/.hivulseai/config.json
手动编辑配置：
{
"api_key": "your-api-key-here",
"last_used_directory": ""
}
📁 文件过滤规则
系统会自动过滤以下目录和文件：
node_modules- Node.js依赖目录venv- Python虚拟环境.git- Git版本控制__pycache__- Python缓存.idea- IDE配置.vscode- VS Code配置*.pyc- Python编译文件*.log- 日志文件
🔄 API调用流程
1. 文件上传阶段
POST /api/v1/claw/upload/file/
- 第一个文件：不带branch_id
- 后续文件：带branch_id（从第一个文件响应中获取default_branch_id）
2. 状态检查阶段
POST /api/v1/claw/upload/status/
- 参数：uuid（使用default_branch_id）
3. 文档生成阶段
POST /api/v1/claw/template_wiki/
- 参数：task_name, template_base_id, branch_id, repo_id, is_advanced
⚠️ 注意事项
- API密钥安全：确保
HIVULSE_API_KEY环境变量正确设置 - 网络连接：确保可以访问指定的API地址
- 文件权限：确保对目标目录有读取权限
- 文件大小：注意单个文件大小限制
- 备份重要文件：建议先备份重要代码
🛠️ 故障排除
常见错误
- "API密钥未设置" → 检查
HIVULSE_API_KEY环境变量 - "目录不存在" → 检查路径是否正确
- "上传失败" → 检查网络连接和API服务状态
- "文档类型不支持" → 检查文档类型编号
📞 支持
如有问题，请检查：
- API服务是否正常运行
- 环境变量是否正确设置
- 网络连接是否正常
- 文件路径和权限是否正确
Usage Guidance
Key things to consider before installing/using:
- The skill will upload the contents of the directory you point it at (excluding a short list). Review your project for secrets (API keys, .env, config files, private keys) that could be uploaded; remove or exclude them before running.
- The code stores your HIVULSE_API_KEY in plaintext at ~/.hivulseai/config.json and prints a trimmed version in logs — if you prefer not to persist keys to disk, do not use the on-disk config and supply the key via a secure mechanism you control.
- There are contradictory instructions and endpoints: SKILL.md/config.py refer to localhost:8001 while the main code uses https://cloud.hivulse.com. Confirm which endpoint the skill will actually contact and only use trusted endpoints.
- One function references a hardcoded path (/Users/superlk/.openclaw/openclaw.json). This is unusual; check the code and consider removing or modifying that line so it only checks the current user's OpenClaw config (e.g., Path.home()).
- If you will run this in an environment with sensitive or proprietary code, audit the files to be uploaded or run the tool in a controlled environment where uploads are safe.
- If you decide to proceed, consider: (1) use a minimal-scope API key for hivulse, (2) rotate the key after use if you have concerns, and (3) review network traffic/endpoints the tool communicates with (e.g., via a proxy) to ensure it matches the expected service.
Capability Analysis
Type: OpenClaw Skill
Name: hivulse-generate-tech-docs
Version: 1.0.0
The skill's primary function is to upload the entire contents of a local directory (source code) to an external API (cloud.hivulse.com) for document generation, which poses a significant data exfiltration risk. Most notably, hivulseAI.py contains a hardcoded absolute path to a specific user's directory (/Users/superlk/.openclaw/openclaw.json) and attempts to programmatically parse the global OpenClaw configuration file using regex to extract API keys. While these behaviors are linked to the tool's stated purpose, the combination of mass source code upload and intrusive access to the agent's global configuration file is highly risky.
Capability Assessment
Purpose & Capability
The code matches the stated purpose: it scans a directory, filters common folders, uploads files, checks status, and requests document generation. Required credential (HIVULSE_API_KEY) is consistent with a cloud API. However there are odd/inconsistent details: the SKILL.md and config.py mention a fixed localhost API address (http://localhost:8001) while the main class uses 'https://cloud.hivulse.com'. Also one method tries to read an OpenClaw config at a hardcoded path (/Users/superlk/.openclaw/openclaw.json) — that specific hardcoded absolute path is unexpected and not explained by the description.
Instruction Scope
SKILL.md instructs uploading an entire project directory to the service, which is consistent with the code. But SKILL.md contains contradictory guidance about how to configure the API key (it both shows exporting HIVULSE_API_KEY and later says "通过配置文件设置，无需环境变量"). The runtime code will read/writes a local config (~/.hivulseai/config.json), read OpenClaw config files, and may print partial key material in logs. The tool will upload all files except a short exclude list — this can unintentionally upload secrets (API keys, .env, config files) present in a project. The skill also attempts to access OpenClaw configuration files, including a suspicious hardcoded absolute path, which is scope creep beyond just reading an expected per-user OpenClaw config location.
Install Mechanism
There is no external installer; code is provided in the bundle and there is no download-from-net during install. This is lower risk than remote installers. Dependencies are minimal (requests, pathlib2) declared in requirements.txt. No suspicious remote install URLs or archive extraction.
Credentials
The skill requests a single credential (HIVULSE_API_KEY), which is appropriate for a cloud API. But it persists the API key in plaintext at ~/.hivulseai/config.json and prints a partial key to stdout in some places — this increases attack surface if the machine is shared or logs are stored. The code also attempts to read OpenClaw config files (expected), but one routine uses a hardcoded path to another user's home (/Users/superlk/.openclaw/openclaw.json) which is unexpected and disproportionate.
Persistence & Privilege
always:false and the skill does not request system-wide privileges. It creates and writes its own config directory ~/.hivulseai and config.json to persist API keys and last-used directory. Persisting the API key locally is functional but may be undesirable for users who prefer secrets only in secure vaults or environment variables. The skill does not attempt to modify other skills or global agent settings.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install hivulse-generate-tech-docs - After installation, invoke the skill by name or use
/hivulse-generate-tech-docs - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- API接口路径由 `/api/v1/repo/upload/file/` 等变更为 `/api/v1/claw/upload/file/` 等新路径
- 文件上传、状态检查和文档生成的接口参数说明得到简化和更新
- 增加了通过 Python 脚本命令直接执行的方式说明
- 元数据格式小幅调整，修正了YAML缩进和书写风格
- 其余文档内容和使用说明保持一致
Metadata
Frequently Asked Questions
What is Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档?
hivulse蜂巢 AI 是一款面向软件开发的自动化技术文档生成工具，通过指定目录代码一键生成多种规范化技术文档。目前已支持的文档类型包括：用户需求说明书、需求规格说明书、系统概要设计说明、系统详细设计说明等10几种报告。申请API Key请访问 www.hivulse.com. It is an AI Agent Skill for Claude Code / OpenClaw, with 96 downloads so far.
How do I install Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档?
Run "/install hivulse-generate-tech-docs" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档 free?
Yes, Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档 is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档 support?
Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档 is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Hivulse蜂巢AI-Gen-Tech Docs 自动生成技术文档?
It is built and maintained by Bo Cao (@mojo-bo-coder); the current version is v1.0.0.
More Skills