Code Assistant

Code Assistant

site icon
2025.04.17 33
Rust代码辅助开发工具开发效率
Code Assistant 是一个基于 Rust 构建的 CLI 工具,旨在协助完成与代码相关的任务。它具备自主探索代码库、读写文件、管理内存、文件摘要生成、交互式通信等功能,并可作为 Model Context Protocol (MCP) 服务器运行,为运行在 MCP 客户端中的大型语言模型 (LLM) 提供工具和资源。
View on GitHub

Overview

基本能力

产品定位

Code Assistant 是一个专为开发者设计的代码辅助工具,旨在提高代码理解和开发的效率。

核心功能

  • 自主探索代码库:智能探索代码库并构建项目结构的工作记忆。
  • 读写文件:读取文件内容并根据需要修改文件。
  • 工作记忆管理:高效处理文件内容,能够加载和卸载文件到内存。
  • 文件摘要生成:创建和存储文件摘要,便于快速参考和更好地理解代码库。
  • 交互式通信:能够向用户提问并获取响应,以支持更好的决策。
  • MCP 服务器模式:可作为 Model Context Protocol 服务器运行,为 MCP 客户端中的 LLM 提供工具和资源。

适用场景

  • 代码库的快速理解和文档生成。
  • 代码优化和重构。
  • 自动化代码审查。
  • 与 LLM 结合进行智能代码辅助。

工具列表

  • Agent Mode:默认模式,用于执行特定任务,如代码分析、文档生成等。
  • Server Mode:作为 MCP 服务器运行,为 LLM 提供工具和资源。

常见问题解答

  • 如何配置 MCP 服务器? 在 Claude Desktop 应用设置中编辑 claude_desktop_config.json 文件,添加 code-assistant 的路径和参数。
  • 如何记录和回放会话? 使用 --record--playback 选项记录和回放 API 响应。

使用教程

使用依赖

确保已安装 Rust

安装教程

# 克隆仓库
git clone https://github.com/stippi/code-assistant

# 进入项目目录
cd code-assistant

# 构建项目
cargo build --release

# 二进制文件位于 target/release/code-assistant

调试方式

# 使用默认模式分析当前目录代码
code-assistant --task "Explain the purpose of this codebase"

# 使用 OpenAI 分析特定目录并启用详细日志
code-assistant -p open-ai --path ./my-project -t "List all API endpoints" -v

# 启动服务器模式
code-assistant server -v

许可证

该项目遵循 GPL-3.0 开源许可条款,请参阅 GPL-3.0 了解完整条款。