Code Assistant

🚀 代码助手项目文档

代码助手是一款功能强大的工具，它能助力开发者对代码库进行分析、优化以及理解。该工具支持多种AI providers，可在任务模式和服务器模式下运行，为开发者提供了多样化的使用场景。

🚀 快速开始

代码助手使用便捷，通过简单配置环境变量，就能在不同模式下发挥强大功能。下面为你详细介绍使用方法。

✨ 主要特性

• 多AI provider支持：支持Anthropic、OpenAI、Vertex AI、OpenRouter和AI Core等多种AI provider。
• 多语言模型选择：提供多种语言支持，用户可按需选择不同模型进行代码分析。
• 实用操作功能：支持文件搜索、替换和执行命令等操作。
• 会话记录与回放：可记录会话以便后续 playback，还提供 fast - playback 模式。

📦 安装指南

文档未提及安装步骤，暂不展示相关内容。

💻 使用示例

基础用法

任务模式

在任务模式下，代码助手可执行各类分析任务，以下是一些常见示例：

# 分析当前目录的代码库
code-assistant --task "解释这个代码库的目的"

# 使用OpenAI分析特定目录
code-assistant -p open-ai --path ./my-project -t "列出所有API端点" -v

# 使用Google Vertex AI进行代码复杂度分析
code-assistant -p vertex --model gemini-1.5-flash -t "分析代码复杂度"

# 使用Ollama模型查找TODO注释
code-assistant -p ollama -m codellama --task "查找所有待办事项注释"

# 使用AI Core provider进行文档编写
code-assistant -p ai-core --task "文档化公共API"

# 使用工作记忆模式查找性能瓶颈
code-assistant --task "查找性能瓶颈" --agent-mode working_memory

# 继续执行上次中断的任务
code-assistant --continue-task

# 启动图形用户界面
code-assistant --ui

# 记录会话以便 playback
code-assistant --task "优化数据库查询" --record ./recordings/db-optimization.json

# 回放记录的会话并加快速度
code-assistant --playback ./recordings/db-optimization.json --fast-playback

服务器模式

在服务器模式下，代码助手可作为Model Context Protocol (MCP) server运行：

code-assistant server [OPTIONS]

📚 详细文档

环境变量配置

使用不同的AI provider时，需要配置相应的环境变量：

🔧 技术细节

文档未提及技术实现细节，暂不展示相关内容。

📄 许可证

文档未提及许可证信息，暂不展示相关内容。

🚧 未来计划（Roadmap）

以下是一些可能的未来发展重点：

• 安全性：提供更严格的沙箱环境，限制对项目文件的访问。
• UI改进：提升文本输入界面的用户体验，增加Markdown支持和代码块语法高亮功能。
• Agent改进：优化工作记忆模式和消息历史模式，探索自动修剪冗余信息的方法。
• 模糊匹配搜索块：研究更高效的文件搜索算法以提高匹配成功率。

🤝 贡献指南

欢迎任何贡献！请随时通过提交拉取请求的方式为项目贡献力量。