使用说明
🚀 AI开发工具包模板
一个完整的、可重用的模板,用于具有本地RAG、MCP集成和可视化服务管理的AI增强开发环境。
🎯 所得
此模板提供了 生产就绪的人工智能开发生态系统 您可以在几分钟内部署到任何项目:
核心组件
- 🧠 本地RAG系统 -2600+文档语义搜索
- 🤖 MCP服务器 -AI代理集成协议
- 📁 文件管理器 -文件上传/组织
- 🎛️ 控制面板 -可视化服务管理
- ⚙️ 应用程序控制脚本 -命令行编排
主要特点
- ✅ 零外部依赖 -完全离线工作
- ✅ 项目不可知 -适应任何代码库
- ✅ AI就绪 -立即与编码助手集成
- ✅ 专业用户界面 -企业级控制接口
- ✅ 一个命令设置 -自动化部署脚本
🚀 快速开始
选项1:使用GitHub模板
# Create new repo from template
gh repo create my-ai-project --template hartou/ai-dev-toolkit-template
# Deploy to existing project
cd my-existing-project
curl -sSL https://raw.githubusercontent.com/hartou/ai-dev-toolkit-template/main/scripts/deploy.sh | bash
选项2:NPM包
# Install globally
npm install -g ai-dev-toolkit
# Deploy to any project
cd my-project
ai-dev-toolkit init
ai-dev-toolkit start
选项3:手动设置
# Clone template
git clone https://github.com/hartou/ai-dev-toolkit-template.git
cd ai-dev-toolkit-template
# Configure and deploy
./scripts/setup.sh
./scripts/deploy.sh /path/to/target/project
📁 模板结构
ai-dev-toolkit-template/
├── 📦 core/ # Core reusable components
│ ├── rag-system/ # RAG engine + database
│ ├── mcp-server/ # Model Context Protocol server
│ ├── file-manager/ # Documentation management
│ ├── control-panel/ # Service orchestration UI
│ └── shared/ # Common utilities
├── 🔧 scripts/ # Automation and deployment
│ ├── deploy.sh # Deploy to existing project
│ ├── setup.sh # Initial configuration
│ ├── app-control.sh # Service management
│ └── templates/ # Configuration templates
├── 📋 configs/ # Default configurations
│ ├── package.template.json # NPM dependencies
│ ├── docker-compose.yml # Container deployment
│ └── .env.template # Environment variables
├── 📚 docs/ # Documentation and guides
└── 🧪 examples/ # Integration examples
⚙️ 配置
项目适应
该工具包会自动适应您的项目结构:
# Auto-detect project type
./scripts/detect-project.sh
# Configure for specific frameworks
ai-dev-toolkit configure --framework react
ai-dev-toolkit configure --framework nextjs
ai-dev-toolkit configure --framework python
自定义文档
# Index your project documentation
ai-dev-toolkit index --source ./docs
ai-dev-toolkit index --source ./README.md
ai-dev-toolkit index --include "*.md,*.rst,*.txt"
服务端口
# Customize service ports
export RAG_PORT=4001
export MCP_PORT=4002
export FILE_MANAGER_PORT=4003
export CONTROL_PANEL_PORT=4004
🎛️ 服务管理
部署后,管理您的AI开发环境:
# Start all services
./ai-control.sh start
# Individual service management
./ai-control.sh rag start
./ai-control.sh mcp start
./ai-control.sh panel start
# Web interfaces
open http://localhost:4001 # RAG Search
open http://localhost:4003 # File Manager
open http://localhost:4004 # Control Panel
🔌 集成示例
VS代码集成
{
"settings": {
"ai-dev-toolkit.ragEndpoint": "http://localhost:4001",
"ai-dev-toolkit.mcpServer": "http://localhost:4002"
}
}
AI助手集成
// Use the MCP server in your AI workflow
import { MCPClient } from '@modelcontextprotocol/sdk'
const mcp = new MCPClient('stdio', {
command: 'node',
args: ['./ai-dev-toolkit/mcp-server/index.js']
})
CI/CD集成
# GitHub Actions
- name: Setup AI Dev Toolkit
run: |
curl -sSL https://get.ai-dev-toolkit.com | bash
ai-dev-toolkit start --headless
- name: AI-Enhanced Testing
run: |
ai-dev-toolkit query "test patterns for React components"
npm test
📊 性能规格
- 🚀 设置时间:<2分钟
- 💾 内存使用:总计<200MB
- 🔍 搜索速度:每次查询小于100ms
- 📄 文件容量:10000多份文件
- ⚡ 冷启动:<5秒
🏗️ 建筑
微服务设计
每个组件独立运行,可以单独部署:
graph TB
A[Control Panel :4004] --> B[RAG System :4001]
A --> C[MCP Server :4002]
A --> D[File Manager :4003]
B --> E[SQLite Database]
C --> E
D --> F[Documentation Store]
G[AI Agents] --> C
H[Developers] --> A
数据流
- 文档 → 文件管理器→ RAG索引器→ SQLite数据库
- AI查询 → MCP服务器→ RAG发动机→ 语义搜索结果
- 人工查询 → 网络界面→ RAG API→ 搜索结果
- 管理 → 控制面板→ 服务脚本→ 系统状态
🎪 用例
个人开发者
- 个人项目知识库
- 人工智能辅助编码环境
- 文档驱动开发
开发团队
- 共享知识库
- 团队入职加速
- 协同人工智能开发
组织
- 企业人工智能开发平台
- 标准化开发环境
- 知识管理系统
开源项目
- 贡献者入职培训
- 文档可访问性
- AI驱动的问题解决
🔄 更新策略
保持您的工具包最新:
# Update to latest version
ai-dev-toolkit update
# Update specific components
ai-dev-toolkit update rag
ai-dev-toolkit update mcp
# Backup before updates
ai-dev-toolkit backup
ai-dev-toolkit restore backup-20241109.zip
🎯 路线图
V2.0功能 (即将推出)
- 🔌 插件系统 -自定义集成
- 🌐 多语言支持 -Python、Java、Go
- 📱 移动接口 -响应式设计
- 🔒 认证 -多用户支持
- ☁️ 云部署 -Kubernetes清单
V3.0愿景
- 🤖 AI代码生成 -与RAG知识相结合
- 📊 分析仪表板 -使用洞察和优化
- 🔄 实时协作 -实时文档共享
- 🎨 自定义主题 -品牌和个性化
📝 贡献
帮助改进工具包:
# Development setup
git clone https://github.com/hartou/ai-dev-toolkit-template.git
cd ai-dev-toolkit-template
./scripts/dev-setup.sh
# Run tests
npm test
# Submit improvements
git checkout -b feature/my-improvement
git commit -m "Add awesome feature"
git push origin feature/my-improvement
📄 许可证
MIT许可证-在个人和商业项目中自由使用。
🙋 支持
在2分钟内将任何项目转换为人工智能增强的开发环境。 🚀
