# gitlab-code-helper

**Repository Path**: cuixkmj/gitlab-code-helper

## Basic Information

- **Project Name**: gitlab-code-helper
- **Description**: GitLab-Code-Helper是一款专为企业私有化部署设计的代码智能分析工具。它通过 LangChain4j框架整合了 DeepSeek-R1的推理能力与 RAG (Retrieval-Augmented Generation)技术，能够深度理解你的 GitLab 代码库，并提供代码审查、逻辑解释、Bug 定位及重构建议。
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master-clean
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-22
- **Last Updated**: 2025-12-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

🤖 GitLab-Code-Advisor: 基于 DeepSeek-R1 的私有代码库智能助手
---

**GitLab-Code-Advisor** 是一款专为企业私有化部署设计的代码智能分析工具。它通过 **LangChain4j** 框架整合了 **DeepSeek-R1** 的推理能力与 **RAG (Retrieval-Augmented Generation)** 技术，能够深度理解你的 GitLab 代码库，并提供代码审查、逻辑解释、Bug 定位及重构建议。

---

## ✨ 核心特性

* **🔍 深度代码感知**：自动拉取 GitLab 项目全量文件树，利用向量嵌入 (Embeddings) 实现语义化代码检索。
* **🧠 DeepSeek-R1 驱动**：支持显示 AI 的思考过程 (Thought Process)，让代码逻辑推演过程透明可见。
* **📂 多项目多分支隔离**：支持按 Project ID 和 Branch 分别构建索引，互不干扰，支持快速切换。
* **⚡ 流式实时响应**：基于 SSE (Server-Sent Events) 技术，实现像 ChatGPT 一样丝滑的字符流输出。
* **🛠 企业级私有部署**：完美支持私有化 GitLab 实例，代码数据不出内网，安全可靠。
* **🎨 现代 UI 交互**：内置精心设计的高颜值 Web 界面，支持 Markdown 渲染及语法高亮。

---

## 🚀 快速开始

### 1. 前置要求

* Java 17 或更高版本
* Maven 3.8+
* DeepSeek API Key 或私有部署的 OpenAI 兼容接口
* GitLab Personal Access Token (需要 `read_api` 权限)

### 2. 配置项目

在 `src/main/resources/application.yml` 中配置你的 API 密钥：

```yaml
deepseek:
  api-key: your-api-key-here
  base-url: https://api.deepseek.com # 或你的私有部署地址

gitlab:
  default-url: http://your-gitlab-url.com
```

### 3. 运行项目

```bash
mvn clean install
mvn spring-boot:run
```

访问 [http://localhost:8080](http://localhost:8080) 即可开始使用。

---

## 🛠 技术栈

* **Backend**: Spring Boot 3, Spring WebFlux (SSE support)
* **LLM Framework**: [LangChain4j](https://github.com/langchain4j/langchain4j)
* **Vector Store**: In-memory with file persistence (Local JSON)
* **Frontend**: Vue 3, Tailwind CSS, Markdown-it, Highlight.js

---

## 📸 界面预览
| ![输入图片说明](src/main/resources/static/image.png) |
| ![输入图片说明](src/main/resources/static/image2.png) |

---

## 🧩 路线图 (Roadmap)

* [ ] 支持集成 PostgreSQL/Milvus 等专业向量数据库
* [ ] 增加代码变更 (Diff) 自动 Review 模式
* [ ] 支持本地模型运行 (通过 Ollama)
* [ ] 增加一键复制代码块功能

---

## 🤝 贡献指南

我们非常欢迎各种形式的贡献！

1. Fork 本项目
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的修改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启一个 Pull Request

---

## 📄 开源协议

本项目采用 [Apache 2.0](LICENSE) 协议开源。

---

## 💡 建议添加的文件

为了让你的仓库看起来更专业，建议同时创建以下文件：

1. **LICENSE**: 放入 Apache 2.0 的全文。
2. **CONTRIBUTING.md**: 详细说明如何提交代码和 Issue。
3. **.gitignore**: 确保不要把你的 API Key、`.json` 向量索引文件、`.idea` 或 `target` 目录提交上去。

---