Skip to content

Repository files navigation

hydPromptKit

Hydra 内部提示词工程工具,用于统一管理和使用标准化提示词模板

Version Node License

📖 简介

hydPromptKit 是一个专业的提示词工程工具,帮助开发团队统一管理和使用标准化的 AI 提示词模板。通过命令行快速调用各种场景的提示词,提升 AI 辅助开发的效率和质量。

核心能力

  • 🎯 提示词加载 - 快速加载预定义的提示词模板
  • 🔧 技能管理 - 自动检测 AI 工具并安装对应技能
  • 提示词验证 - 验证提示词格式和内容
  • 📦 多场景管理 - 覆盖需求、设计、开发、测试、评审全流程

典型应用场景

  • 📋 需求分析与产品设计
  • 🏗️ 系统架构与技术设计
  • 💻 代码开发与功能实现
  • 🧪 单元测试与质量保证
  • 🔍 代码评审与优化建议

🚀 快速开始

前置要求

  • Node.js 16.0+ - 下载安装
  • Qoder CLI(推荐)- AI 编程助手
# 安装 Qoder CLI
npm install -g @qodeai/cli

# 验证安装
qoder --version

安装 hydPromptKit

在线安装

npm install -g @harries/hydpromptkit

离线安装

# 方式一:使用 .tgz 包
npm pack  # 在联网机器上打包
npm install -g ./harries-hydpromptkit-x.x.x.tgz  # 在离线机器上安装

# 方式二:从源码安装
npm link

# 方式三:直接运行源码
node bin/hydpromptkit.js init

初始化项目

hydpromptkit init

初始化时会自动检测本机已安装的 AI 工具,并引导你选择要安装技能的工具:

选择界面操作说明

Step 2/3
Select AI tools to install skills for:

    ✔ Detected (recommended)
    ○ Not detected (can still install)

 ◉ ✔ Qoder (CLI) → .qoder/skills         ← 已选中
 ◉ ✔ Claude Code → .claude/skills        ← 已选中
 ◯ ○ Cline → .cline/skills
 ◯ ○ Cursor → .cursor/skills
按键 功能
↑ / ↓ 上下移动光标
空格键 (Space) 切换选中/取消选中
Enter 确认完成选择

操作示例:如果默认选中了 3 个工具,你只想保留 1 个,可以用方向键移动到要取消的项,按空格键取消选中,最后按 Enter 确认。

初始化完成后会在项目中创建:

  • .qoder/commands/ - 提示词命令文件
  • .qoder/skills/ - 技能文件(根据选择的 AI 工具安装到对应目录)
  • projectdocs/ - 项目文档目录

验证安装

hydpromptkit --version
hydpromptkit list

📚 文档

文档 说明
命令手册 所有命令的详细说明、参数和使用场景
技能手册 AI 技能的安装、配置和自定义方法

📁 项目结构

hydpromptkit/
├── bin/hydpromptkit.js      # CLI 入口
├── commands/                 # CLI 命令实现
├── prompts/                  # 提示词模板
│   ├── require/             # 需求阶段
│   ├── design/              # 设计阶段
│   ├── dev/                 # 开发阶段
│   ├── test/                # 测试阶段
│   └── review/              # 评审阶段
├── skills/                   # AI 技能定义
├── COMMANDS.md              # 命令手册
└── SKILLS.md                # 技能手册

📊 CLI 命令

hydpromptkit init              # 初始化项目,安装命令和技能
hydpromptkit list              # 列出所有可用命令
hydpromptkit docs-repo <子命令>  # 文档仓库管理
hydpromptkit --version         # 显示版本号

🎓 最佳实践

  1. 明确需求 - 提供清晰、具体的需求描述
  2. 提供上下文 - 包含必要的背景信息和约束条件
  3. 分步骤进行 - 复杂任务分解为多个小任务
  4. 迭代优化 - 根据生成结果调整需求描述

🐛 常见问题

Q: 初始化后找不到命令? A: 确保已选择 AI 工具,检查对应的 .qoder/commands/ 目录是否存在。

Q: 如何更新提示词和技能? A: 重新运行 hydpromptkit init,选择覆盖现有文件。

Q: 支持哪些 AI 工具? A: 支持 Qoder、Claude Code、Cline、Cursor、Windsurf 等,运行 init 时会自动检测。

📝 更新日志

v0.2.35 (2025-01-16)

  • ✨ 新增 AI 工具自动检测功能
  • ✨ 支持多 AI 工具同时安装技能
  • ✨ 新增 require/updaterequire/prototype 命令
  • 📝 重构文档结构,拆分命令和技能手册

v0.2.0 (2024-01-26)

  • ✨ 精简命令结构,保留核心命令
  • 🛠️ 优化项目结构

v0.1.0 (2024-01-01)

  • 🎉 首次发布

🤝 贡献指南

  1. Fork 本项目
  2. 创建特性分支:git checkout -b feature/new-command
  3. prompts/skills/ 目录下添加内容
  4. 提交更改:git commit -m 'feat: 添加新命令'
  5. 推送分支:git push origin feature/new-command
  6. 提交 Pull Request

📄 许可证

MIT License

📮 联系方式


hydPromptKit - 让 AI 辅助开发更高效 🚀

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages