https://github.com/gitstq/devmind-ai
DevMind AI - 智能开发者思维助手 | AI-powered code analysis, documentation & mindmap generator
https://github.com/gitstq/devmind-ai
Last synced: 3 days ago
JSON representation
DevMind AI - 智能开发者思维助手 | AI-powered code analysis, documentation & mindmap generator
- Host: GitHub
- URL: https://github.com/gitstq/devmind-ai
- Owner: gitstq
- License: mit
- Created: 2026-06-14T17:23:08.000Z (10 days ago)
- Default Branch: main
- Last Pushed: 2026-06-14T17:25:21.000Z (10 days ago)
- Last Synced: 2026-06-14T19:13:27.576Z (10 days ago)
- Language: Python
- Size: 31.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧠 DevMind AI
Intelligent Developer Mind Assistant —— AI-powered code analysis, smart documentation, mindmap generation & optimization tool
---
## 🎉 Introduction
DevMind AI is an intelligent assistant designed for developers:
- 🔍 **Deep Code Analysis** —— Auto-parse project structure, calculate complexity metrics
- 📝 **Smart Documentation** —— AI-generated docstrings following best practices
- 🗺️ **Mindmap Visualization** —— Convert code structure to Mermaid/Markdown mindmaps
- ⚡ **Code Optimization** —— Identify bottlenecks and suggest refactoring
### 🌟 Why DevMind AI?
| Feature | DevMind AI | Others |
|---------|-----------|--------|
| Local Execution | ✅ Fully Local | ❌ Cloud-dependent |
| Multi-language | ✅ Python/JS/Go/Java | ⚠️ Limited |
| Mindmap | ✅ Auto-generate | ❌ Not supported |
| Complexity Analysis | ✅ Built-in | ⚠️ Plugin needed |
| AI Backends | ✅ Ollama/OpenAI | ⚠️ Single backend |
---
## ✨ Core Features
### 📊 Code Analysis (`analyze`)
```bash
devmind analyze ./my-project --format html --output report.html
```
### 📝 Smart Docs (`doc`)
Supports multiple documentation styles:
- **Google Style**
- **NumPy Style**
- **reStructuredText**
```bash
devmind doc ./src/main.py --style google
```
### 🗺️ Mindmap (`mindmap`)
```bash
devmind mindmap ./src --format mermaid --output architecture.md
```
### ⚡ Optimization (`optimize`)
```bash
devmind optimize ./src/bottleneck.py --suggest
```
---
## 🚀 Quick Start
### Installation
```bash
pip install devmind-ai
```
### Initialize Config
```bash
devmind init
```
### Basic Usage
```bash
# Analyze code
devmind analyze ./my-project
# Generate docs
devmind doc ./my-project/src
# Generate mindmap
devmind mindmap ./my-project/src
```
---
## 📖 AI Backend Configuration
### Using Ollama (Recommended)
```yaml
ai:
backend: ollama
ollama:
host: http://localhost:11434
model: codellama
```
### Using OpenAI API
```yaml
ai:
backend: openai
openai:
api_key: "sk-your-api-key"
model: gpt-4
```
---
## 📄 License
[MIT License](./LICENSE)
---
Made with ❤️ by DevMind Team