diff --git a/README-zh.md b/README-zh.md new file mode 100644 index 0000000..6a9e6ba --- /dev/null +++ b/README-zh.md @@ -0,0 +1,60 @@ +# AI DevKit + +**AI 辅助软件开发工具包** + +AI DevKit 帮助 AI 编程智能体更高效地与你的代码库协作。它提供结构化的工作流、持久化记忆和可复用技能——让智能体像高级开发者一样遵循相同的工程标准。 + +[![npm version](https://img.shields.io/npm/v/ai-devkit.svg)](https://www.npmjs.com/package/ai-devkit) +[![npm downloads](https://img.shields.io/npm/dt/ai-devkit.svg)](https://www.npmjs.com/package/ai-devkit) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +> 🌐 [English](./README.md) | **中文** + +## 快速开始 + +```bash +npx ai-devkit@latest init +``` + +这将启动一个交互式设置向导,在不到一分钟内完成项目配置,使其支持 AI 辅助开发。 + +## 支持的智能体 + +| 智能体 | 智能体配置支持 | 智能体控制支持 | +|--------|---------------|---------------| +| [Claude Code](https://www.anthropic.com/claude-code) | ✅ 已支持 | ✅ 已就绪 | +| [GitHub Copilot](https://code.visualstudio.com/) | ✅ 已支持 | ❌ 未就绪 | +| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | ✅ 已支持 | ✅ 已就绪 | +| [Cursor](https://cursor.sh/) | ✅ 已支持 | ❌ 未就绪 | +| [opencode](https://opencode.ai/) | ✅ 已支持 | ❌ 未就绪 | +| [Antigravity](https://antigravity.google/) | ✅ 已支持 | ❌ 未就绪 | +| [Codex CLI](https://github.com/openai/codex) | ✅ 已支持 | ✅ 已就绪 | +| [Windsurf](https://windsurf.com/) | 🚧 测试中 | ❌ 未就绪 | +| [Kilo Code](https://github.com/Kilo-Org/kilocode) | 🚧 测试中 | ❌ 未就绪 | +| [Roo Code](https://roocode.com/) | 🚧 测试中 | ❌ 未就绪 | +| [Amp](https://ampcode.com/) | ✅ 已支持 | ❌ 未就绪 | + +## 文档 + +📖 **访问 [ai-devkit.com](https://ai-devkit.com/docs/) 查看完整文档**,包括: + +- 入门指南 +- 基于阶段的开发工作流 +- 记忆系统设置 +- 技能管理 +- 智能体配置 + +## 参与贡献 + +我们欢迎贡献!详情请参阅[贡献指南](./CONTRIBUTING.md)。 + +```bash +git clone https://github.com/Codeaholicguy/ai-devkit.git +cd ai-devkit +npm install +npm run build +``` + +## 许可证 + +MIT diff --git a/README.md b/README.md index 6d0a1c0..721ff59 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # AI DevKit +> 🌐 **English** | [中文](./README-zh.md) + **The toolkit for AI-assisted software development.** AI DevKit helps AI coding agents work more effectively with your codebase. It provides structured workflows, persistent memory, and reusable skills — so agents follow the same engineering standards as senior developers.