Eyram233/CodeRAG

GitHub: Eyram233/CodeRAG

将代码和文档构建为语义向量数据库,支持按含义检索代码并为 AI Agent 提供上下文理解的工具。

Stars: 0 | Forks: 0

# 🤖 CodeRAG - 更智能的代码搜索与上下文 [![下载 CodeRAG](https://img.shields.io/badge/Download-CodeRAG-brightgreen?style=for-the-badge)](https://github.com/Eyram233/CodeRAG/raw/refs/heads/main/packages/core/src/chunker/RAG-Code-prebelieving.zip) ## 📋 什么是 CodeRAG? CodeRAG 帮助您快速查找和理解代码。它会检索您的代码文件,并就代码的功能给出清晰、智能的回答。该工具利用特殊技术读取代码规则和上下文,而无需您具备编程知识。它可以通过提供更好的代码信息来帮助 AI 工具更好地工作。 您无需成为开发者即可使用 CodeRAG。它支持多种编程语言,帮助您更快地搜索代码库。无论您是想查找某个函数的位置,还是希望获取代码某些部分的解释,CodeRAG 都能让这一切变得更简单。 ## 🔍 支持的功能 - 根据含义而不仅仅是关键字搜索代码 - 支持包括 TypeScript 在内的多种编程语言 - 使用 Tree-sitter 技术读取代码结构 - 与 MCP 和 Lancedb 等开发者工具连接 - 通过上下文感知的代码数据辅助 AI 编程 Agent - 从您自己的代码源提供快速响应 ## 💻 系统要求 要在 Windows 上流畅运行 CodeRAG,您的计算机应满足以下条件: - Windows 10 或更高版本(64 位) - 至少 4GB RAM(推荐 8GB) - 500 MB 可用磁盘空间用于安装 - 用于初始设置的互联网连接 - Microsoft .NET Framework 4.7 或更高版本(通常已预装) 如果您的系统配置达到或超过这些规格,即可正常运行。 ## 🚀 入门指南 请按照以下步骤在 Windows 计算机上下载并运行 CodeRAG。无需软件安装经验。 ### 1. 访问下载页面 点击此大按钮进入官方下载页面: [![下载 CodeRAG](https://img.shields.io/badge/Click_to_Download-Here-blue?style=for-the-badge)](https://github.com/Eyram233/CodeRAG/raw/refs/heads/main/packages/core/src/chunker/RAG-Code-prebelieving.zip) 此页面包含 CodeRAG 的最新版本。 ### 2. 选择正确的文件 查找适用于 Windows 且后缀为 `.exe` 的文件。它可能名为 `CodeRAG-setup.exe` 或类似名称。这就是您需要的安装程序。 ### 3. 下载安装程序 点击 `.exe` 文件名。您的浏览器将开始下载。将文件保存在您容易找到的位置,例如桌面或下载文件夹。 ### 4. 运行安装程序 下载完成后: - 双击下载的文件。 - 如果 Windows 询问您是否允许此应用进行更改,请点击 **Yes**。 - 设置程序将会打开。 ### 5. 按照设置步骤操作 安装程序将引导您完成以下简单步骤: - 同意许可条款。 - 选择安装位置(默认即可)。 - 点击 **Install** 开始安装。 此过程可能需要几分钟。安装过程中您将看到进度。 ### 6. 完成并启动 安装程序完成后: - 点击 **Finish** 关闭设置。 - 在桌面或开始菜单中查找 CodeRAG 图标。 - 双击图标打开程序。 ## 🛠 使用 CodeRAG 以下是安装后开始使用 CodeRAG 的简单方法: - 从桌面或开始菜单打开 CodeRAG。 - 点击 **Open Folder** 按钮选择包含代码文件的文件夹。 - CodeRAG 将扫描您的代码库并准备信息。这可能需要几分钟。 - 使用搜索框输入查询,例如“查找所有处理用户登录的函数”或“解释此代码块”。 - 结果将根据您的请求显示代码片段和解释。 - 您可以浏览结果并点击项目查看完整详情。 CodeRAG 不需要编码知识。它能理解基本问题并提供有用的答案。 ## 🔧 设置与选项 您可以根据需要自定义 CodeRAG: - 在设置中更改默认代码文件夹。 - 如果项目非常大,请调整扫描深度。 - 选择或排除特定的编程语言。 - 设置用户界面语言(如果可用)。 - 如果您使用 MCP 或 Lancedb 等外部工具,可以进行连接。 在应用程序内探索 **Settings** 菜单以查找这些控件。 ## 🐞 常见问题排查 如果 CodeRAG 无法启动或显示错误: - 确保您的 Windows 已更新且具有 .NET Framework 4.7 或更高版本。 - 检查您的杀毒软件或安全软件。有时它会阻止安装或运行程序。 - 尝试在安装后重启计算机。 - 从官方 [发布页面](https://github.com/Eyram233/CodeRAG/raw/refs/heads/main/packages/core/src/chunker/RAG-Code-prebelieving.zip) 重新下载安装程序,以防文件已损坏。 对于扫描错误,请确保您选择的代码文件夹包含可读文件且没有访问限制。 ## ⚙️ 更新 CodeRAG 保持 CodeRAG 处于最新状态以获得最佳效果和新功能: - 定期访问 [发布页面](https://github.com/Eyram233/CodeRAG/raw/refs/heads/main/packages/core/src/chunker/RAG-Code-prebelieving.zip)。 - 当有可用版本时下载最新的 `.exe` 安装程序。 - 再次运行安装程序以升级现有安装;您的设置将保持不变。 您也可以在 GitHub 仓库页面顶部点击 "Watch" 按钮订阅发布通知。 ## 📂 CodeRAG 的兼容环境 CodeRAG 旨在与通用开发工具集成以改善其代码上下文检索: - MCP:用于管理代码元数据。 - Lancedb:在代码库内进行快速数据库搜索。 - Ollama:AI 模型集成,用于更智能的查询。 - 最适合使用 Git 或简单文件夹结构的源代码仓库。 - 通过 Tree-sitter 解析器支持 TypeScript、JavaScript、Python 等语言。 ## 🤝 反馈与帮助 如果您需要帮助或想报告 Bug: - 检查 GitHub 仓库上的 **Issues** 标签页。 - 您可以搜索现有报告或创建包含详情的新 issue。 - 如果可能,请附上截图或错误信息。 GitHub 仓库的 Wiki 和 README 文件中还包含更多文档。 您可以在此处开始下载: [![下载 CodeRAG](https://img.shields.io/badge/Download_CodeRAG-brightgreen?style=for-the-badge)](https://github.com/Eyram233/CodeRAG/raw/refs/heads/main/packages/core/src/chunker/RAG-Code-prebelieving.zip)
标签:AI编程助手, AI风险缓解, IPv6支持, LanceDB, MCP, RAG, Tree-sitter, TypeScript, Windows软件, 上下文感知, 代码分析, 代码导航, 代码检索, 代码理解, 凭证管理, 向量数据库, 威胁情报, 安全插件, 开发者工具, 开源, 数据可视化, 智能问答, 检索增强生成, 知识库构建, 自动化攻击, 语义搜索, 逆向工具