Coding Assistant

基本能力

产品定位

Coding Assistant 是一个本地 AI 配对编程助手，旨在帮助开发者更高效地理解和改进代码。

核心功能

• 读取本地项目文件夹中的代码，提供上下文感知的帮助、解释和建议。
• 支持多种 LLM 提供商（如 Google、MistralAI、Ollama）。
• 提供用户友好的 Streamlit 界面，方便开发者进行交互。
• 支持聊天会话，可以记住当前聊天的上下文。
• 提供文件结构查看、代码内容读取、函数解释等功能。

适用场景

• 代码理解和解释：帮助开发者快速理解陌生代码库。
• 代码改进建议：提供代码优化和错误处理的建议。
• 项目结构查看：快速查看项目的文件结构。
• 代码内容读取：直接读取指定文件的内容。

工具列表

• tree 命令：用于获取项目文件夹的树状结构。
• cat 命令：用于读取文件内容。
• LLM 模型：用于提供代码解释和建议。

常见问题解答

• 如何更改 LLM 提供商？ 在 api/utils.py 文件中修改 load_llm 函数，取消注释所需的提供商。
• 如何设置 API 密钥？ 在 .env 文件中添加相应的 API 密钥。
• 如何查看日志？ 日志文件分别为 mcp_server.log、fastapi_api.log 和 streamlit_ui.log。

使用教程

使用依赖

• Python: 版本 3.11 或更高。
• tree 命令:
• Linux (Debian/Ubuntu): sudo apt update && sudo apt install tree
• macOS (使用 Homebrew): brew install tree

安装教程

1. 克隆仓库: bash git clone https://github.com/Bessouat40/coding-assistant cd coding-assistant
2. 安装 Python 依赖: bash pip install -r requirements.txt
3. 配置 .env 文件: bash cp .env.example .env 编辑 .env 文件，添加 API 密钥。

调试方式

1. 运行应用: bash chmod +x launch_assistant.sh ./launch_assistant.sh
2. 访问 UI: 打开浏览器，访问 http://localhost:8501。
3. 设置项目目录: 在侧边栏中输入项目的绝对路径，点击 "Set Directory"。
4. 开始聊天: 使用底部的聊天输入框提问。
5. 查看日志: 日志文件分别为 mcp_server.log、fastapi_api.log 和 streamlit_ui.log。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。