Code Assistant

🚀 代碼助手項目文檔

代碼助手是一款功能強大的工具，它能助力開發者分析、優化和理解代碼庫。該工具支持多種AI providers，可在任務模式和服務器模式下運行，為開發者帶來便捷高效的代碼處理體驗。

🚀 快速開始

代碼助手使用前，需根據所選的AI provider配置相應的環境變量：

• ANTHROPIC_API_KEY：使用Anthropic provider時需要設置。
• OPENAI_API_KEY：使用OpenAI provider時需要設置。
• GOOGLE_API_KEY：使用Vertex provider時需要設置。
• OPENROUTER_API_KEY：使用OpenRouter provider時需要設置。
• PERPLEXITY_API_KEY：使用Perplexity search API工具時需要設置。

✨ 主要特性

• 多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]

📚 詳細文檔

未來計劃（Roadmap）

以下是代碼助手未來可能的發展重點：

• 安全性：提供更嚴格的沙箱環境，限制對項目文件的訪問。
• UI改進：提升文本輸入界面的用戶體驗，增加Markdown支持和代碼塊語法高亮功能。
• Agent改進：優化工作記憶模式和消息歷史模式，探索自動修剪冗餘信息的方法。
• 模糊匹配搜索塊：研究更高效的文件搜索算法以提高匹配成功率。

🤝 貢獻指南

歡迎任何形式的貢獻！若您想為項目貢獻力量，請隨時提交拉取請求。