Code Embeddings

🚀 代碼知識工具

代碼知識工具是一個專門為代碼倉庫打造的知識管理系統。它藉助先進的向量嵌入技術，實現對代碼庫知識的高效維護與查詢，為開發者提供便捷的代碼知識管理體驗。

🚀 快速開始

構建與安裝

1. 構建包

首先，生成發行文件：

# 克隆倉庫
git clone https://github.com/yourusername/code-knowledge-tool.git
cd code-knowledge-tool

# 創建並激活虛擬環境
python -m venv venv
source venv/bin/activate

# 安裝構建工具
python -m pip install --upgrade pip build

# 構建包
python -m build

這將在 dist/ 目錄下生成兩個文件：

• code_knowledge_tool-0.1.0-py3-none-any.whl（用於安裝的輪文件）
• code_knowledge_tool-0.1.0.tar.gz（源發行版）

2. 安裝包

先決條件

1. 確保 Ollama 已安裝並運行：

# 如果尚未安裝，請先安裝 Ollama
curl https://ollama.ai/install.sh | sh

# 啟動 Ollama 服務
ollama serve

2. 安裝包：

• 方案 1：從輪文件安裝（推薦用於使用）

# 進入構建包的目錄
cd /path/to/code-knowledge-tool

# 使用輪文件進行安裝
pip install dist/code_knowledge_tool-0.1.0-py3-none-any.whl

• 方案 2：以開發模式安裝（推薦用於開發） 此方案適合如果你想要修改工具或參與其開發：

# 假設你已經在 code-knowledge-tool 目錄下，並且已激活虛擬環境

# 以開發模式安裝，包含開發依賴項
pip install -e ".[dev]"

與 RooCode/Cline 的集成

1. 將 MCP 配置複製到你的設置中：

• 對於 Cline（VSCode）

# 打開設置文件
open ~/Library/Application\ Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

添加以下配置：

{
  "mcpServers": {
    "code_knowledge": {
      "command": "python",
      "args": ["-m", "code_knowledge_tool.mcp_tool"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

• 對於 RooCode

# 打開設置文件
open ~/Library/Application\ Support/RooCode/settings/mcp_config.json

添加以下配置：

{
  "mcpServers": {
    "code_knowledge": {
      "command": "python",
      "args": ["-m", "code_knowledge_tool.mcp_tool"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

✨ 主要特性

作為記憶銀行和 RAG 上下文提供者

該工具可作為代碼倉庫的記憶銀行，幫助你以向量嵌入形式存儲代碼知識，並支持通過相似性搜索來查詢這些知識。這對於代碼補全、理解代碼上下文以及開發輔助非常有用。

📦 安裝指南

安裝測試依賴

如果你需要進行更深入的測試或驗證工具的功能，可以安裝以下測試依賴：

pip install -r requirements-test.txt

運行測試

運行以下命令來執行單元測試和集成測試：

pytest tests/

📚 詳細文檔

未來發展

如果希望將此工具發佈到 PyPI（Python 包索引），你需要：

1. 在 PyPI 註冊一個賬戶。
2. 安裝 twine：pip install twine
3. 使用以下命令上傳發行版：

twine upload dist/*

但目前，建議使用本地構建和安裝方法。

📄 許可證

MIT License