目录
- 概述
- 核心概念映射
- 数据结构设计
- 核心功能实现
- 技术架构
- 使用示例
- 最佳实践
概述
PromptHub CLI是一个为AI提示设计的版本控制系统，借鉴了Git的核心思想和设计模式。该项目实现了类似Git的版本控制功能，包括分支管理、版本历史追踪、差异比较、谱系管理等，专门针对AI提示的特性和需求进行了优化。
设计理念
- Git风格操作：使用与Git相似的命令和概念，降低学习成本
- 轻量级存储：基于文件系统的存储，无需数据库依赖
- 协作友好：支持远程存储和团队协作
- AI原生：针对AI提示的特性进行优化，支持模型执行和响应存储
主要特性
- 版本历史管理
- 分支和变体管理
- 谱系追踪
- 差异比较
- 远程存储支持（S3、GitHub、REST API）
- CI/CD集成
- A/B测试支持
核心概念映射
PromptHub将Git的核心概念映射到AI提示管理中：
| Git概念 | PromptHub概念 | 说明 |
|---|---|---|
| Commit | Prompt版本 | 每个保存的提示都是一个版本 |
| Branch | 分支 | 用于隔离不同的提示变体 |
| Fork | Fork | 从现有提示创建变体 |
| Parent Commit | Parent Prompt | 提示的父版本 |
| git log | Lineage | 显示提示的完整谱系 |
| git diff | diff | 比较两个提示版本 |
| git checkout | restore | 恢复到指定版本 |
| git remote | remote | 远程存储配置 |
数据结构设计
1. 提示数据模型
每个提示版本存储为一个独立的JSON文件，包含以下结构：
{"id":"abc123",// 唯一标识符"prompt":"Your prompt text",// 提示文本"response":"Model response",// AI模型响应（可选）"model":"gpt-4",// 使用的AI模型"created_at":"2024-02-20T12:34:56.789Z",// 创建时间戳"parent_id":null,// 父提示ID（类似git的parent commit）"branch":"main",// 所属分支"metadata":{// 元数据"executed":true,// 是否已执行"source":"cli",// 来源（cli/file/api）"metrics":{// 性能指标"tokens":150,"latency":2500,"cost":0.03},"test_results":[],// A/B测试结果"ci":{// CI/CD信息"pipeline":"prompt-validation","run_id":"ci123","status":"passed"}}}2. 标签索引
标签存储在独立的tags.json文件中，实现快速标签查询：
{"base":["abc123","def456"],"variant":["ghi789","jkl012"],"production":["abc123"]}3. 配置文件
配置使用YAML格式存储在.prompthub/config.yml：
version:"1.0.0"provider:OPENAIdefault_model:gpt-4max_tokens:2000storage:type:filepath:.prompthub/promptsremote:type:githubrepo:owner/repodisplay:color:trueformat:table核心功能实现
1. 版本保存
实现原理
保存提示时，系统会：
- 生成唯一ID
- 可选地执行AI模型获取响应
- 保存为独立的JSON文件
- 更新标签索引
- 检查并提示过时的变体
核心代码
exportasyncfunctionsavePrompt(options){constid=generateId();letresponse=null;// 执行AI模型（可选）if(options.execute!==false){constopenai=initializeOpenAI();constcompletion=awaitopenai.chat.completions.create({model:options.model||'gpt-3.5-turbo',messages:[{role:'user',content:promptText}],});response=completion.choices[0].message.content;}// 保存提示awaitstore.savePrompt(id,promptText,response,options.model,tags,{executed:options.execute!==false&&response!==null,source:options.file?'file':'cli',},options.parentId);// 传递父ID建立版本关系// 检查过时提示if(!options.skipOutdatedCheck){constoutdated=awaitstore.checkOutdated();if(outdated.length>0){console.log('⚠️ Outdated prompts detected:');}}}存储实现
asyncsavePrompt(id,prompt,response,model,tags=[],metadata={},parentId=null)
