Claude Crew

🚀 Claude Crew

Claude Crew is a toolkit for auxiliary development, aiming to enhance developers' work efficiency and code quality. It integrates multiple functional modules to assist developers in more efficient project management and code review.

🚀 Quick Start

1. Initialize the project:

   npx claude-crew@latest setup
   

2. Start the MCP service:

   npx claude-crew@latest serve-mcp
   

3. Create a snippet (optional):

   npx claude-crew@latest create-snippet
   

✨ Features

1. Code Search Tool:

   • claude-crew-search: Search for code by keywords or identifiers.

2. Document Retrieval Module:

   • find-relevant-documents: Retrieve relevant project documents based on query statements.
   • find-relevant-resources: Find relevant development resources according to requirements.

3. TypeScript Support:

   • Integrate TypeScript language support and read the tsconfig.json file configuration by default.

4. RAG Integration:

   • Provide integration with OpenAI's RAG (Retrieval Augmented Generation), supporting the analysis and processing of multiple document formats.

📦 Installation

To install Claude Crew, follow these steps:

1. Install using npm:

   npm install claude-crew@latest
   

2. Initialize the project:

   npx claude-crew@latest setup
   

3. Configure the project (optional):

   • Edit the claude-crew.config.js file and configure it as needed.

Configuration File Example

// 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'
      }
    } }
  ]
}

🤝 Contribution Guidelines

Community contributions are welcome! You can participate in the following ways:

1. Report issues: Submit bugs or feature requests in the Issues section.
2. Code contributions: Submit improvements via Pull Requests.

For more detailed information, please refer to the CONTRIBUTE.md file.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific details.