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