# ChatWithRepositry

**Repository Path**: vax52/chat-with-repositry

## Basic Information

- **Project Name**: ChatWithRepositry
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-27
- **Last Updated**: 2025-08-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chat with Repository

与代码库进行对话交互的智能助手，支持通过自然语言查询代码结构、函数说明、使用示例、错误信息等。

## 功能特性

- **代码理解**：支持多种编程语言的代码解析和结构化信息提取
- **自然语言查询**：通过自然语言搜索代码库中的函数、类、模块等信息
- **函数说明**：获取函数定义、参数说明和文档注释
- **使用示例**：查找模块或库的使用方法
- **错误排查**：搜索常见错误类型的相关代码示例
- **交互式命令行**：提供交互式命令行界面进行代码探索
- **Web 界面**：提供基于 Streamlit 的可视化操作界面

## 安装与使用

### 本地运行

```bash
# 安装依赖
pip install -r requirements.txt

# 安装 CLI 工具
python setup.py install
```

### 使用 Docker

```bash
# 构建镜像
docker build -t chat-with-repo .

# 运行容器
docker run -it chat-with-repo --help
```

## CLI 命令

### 添加代码库

```bash
chat-with-repo add <repo_url> --branch <branch_name>
```

### 查询代码库

```bash
chat-with-repo query "需要查询的内容" --repo <repo_url>
```

### 解释函数

```bash
chat-with-repo explain <function_name> --repo <repo_url>
```

### 查找模块使用示例

```bash
chat-with-repo usage <module_name> --repo <repo_url>
```

### 查看所有已添加代码库

```bash
chat-with-repo list
```

### 移除代码库

```bash
chat-with-repo remove <repo_url>
```

### 进入交互模式

```bash
chat-with-repo interactive
```

## Web 界面

### 启动 Web 服务

```bash
streamlit run streamlit_app.py
```

### Web 界面功能

- 代码库管理
- 自然语言查询
- 查询历史记录
- 代码展示
- 统计信息面板
- 快速操作入口
- 设置面板

## API 文档

### 支持的编程语言

- Python
- JavaScript/TypeScript
- Go
- Java

### 查询类型

- 函数说明
- 类定义
- 模块使用
- 导入关系
- 错误示例

## 贡献指南

欢迎贡献代码和改进文档。请先阅读 CONTRIBUTING.md 文件了解贡献流程。

## 许可证

本项目采用 MIT 许可证。详情请查看 LICENSE 文件。