article
README
🚀 Claude Crew 团队工具集
Claude Crew 是一套辅助开发的工具集,能有效提升开发者的工作效率,保障代码质量。它集成了多个功能模块,助力开发者更高效地开展项目管理与代码审查工作。
🚀 快速开始
- 初始化项目:
npx claude-crew@latest setup
- 启动 MCP 服务:
npx claude-crew@latest serve-mcp
- 创建 snippet(可选):
npx claude-crew@latest create-snippet
✨ 主要特性
- 代码搜索工具:
claude-crew-search:支持通过关键字或标识符搜索代码。
- 文档检索模块:
find-relevant-documents:依据查询语句,检索相关项目文档。find-relevant-resources:根据实际需求,查找相关的开发资源。
- TypeScript 支持:集成 TypeScript 语言支持,默认读取
tsconfig.json文件配置。 - RAG 集成:提供与 OpenAI 的 RAG(检索增强生成)集成,支持多种文档格式的分析和处理。
📦 安装指南
要安装 Claude Crew,请按照以下步骤操作:
- 使用 npm 安装:
npm install claude-crew@latest
- 初始化项目:
npx claude-crew@latest setup
- 配置项目(可选):
- 编辑
claude-crew.config.js文件,根据需要进行配置。
- 编辑
💻 使用示例
配置文件示例
// claude-crew.config.js
module.exports = {
projectName: 'your-project-name',
memoryBankPath: '.claude-crew/memory-bank.md',
tools: [
{ name: 'typescript', config: { tsConfigFilePath: './tsconfig.json' } },
{ name: 'rag', config: {
provider: {
type: 'openai',
apiKey: 'your-openai-api-key',
model: 'text-embedding-ada-002'
}
} }
]
}
🤝 贡献指南
欢迎社区贡献!您可以通过以下方式参与:
- 报告问题:在 Issues 中提交 bug 或功能需求。
- 代码贡献:通过 Pull Request 提交改进。
更多详细信息,请参考 CONTRIBUTE.md 文件。
📄 许可证
该项目遵循 MIT License 协议,具体内容请参阅 LICENSE 文件。
Scan to join WeChat group