code-index

一个自托管的语义代码搜索平台,支持按含义而非文本搜索代码。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:code-index。
它的用途是:一个自托管的语义代码搜索平台,支持按含义而非文本搜索代码。
完整的 Skill 内容见:https://321skill.com/skills/code-index/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“帮我搜索一下项目中所有处理用户身份验证的中间件代码。”,AI代理会调用cix技能,执行语义搜索,返回包含相关代码片段、文件路径和行号的精确结果,而不是一堆无关的文件列表。或者,在终端直接输入`cix symbols "UserService" --kind class`,快速查找项目中名为UserService的类定义。

介绍

code-index(cix)是一个自托管的语义代码搜索平台,旨在解决传统文本搜索(如grep)在大型项目中因命名模糊、结果噪声大、AI代理消耗过多Token而效率低下的问题。它通过Go服务器、Web仪表板、CLI工具和AI代理技能,将代码库索引到向量存储中,支持混合BM25和密集嵌入搜索,让用户能通过自然语言描述找到相关代码片段。

使用方式多样:可通过CLI命令(如cix search "authentication middleware")在终端或AI代理中直接搜索;也可通过浏览器访问本地仪表板(http://localhost:21847/dashboard)进行可视化管理和搜索;还支持文件监听、多仓库工作空间分组以及GitHub Webhook自动重新索引。

该工具非常适合需要高效浏览和理解大型、复杂代码库的开发者团队,尤其是全栈开发、后端开发、智能体开发以及项目经理等角色,能显著提升代码复用和问题排查效率。

需要注意的是,升级服务器版本后,由于解析/分块/嵌入管道可能发生变化,建议对项目进行重新索引以保证搜索一致性。此外,它主要面向代码搜索场景,不适合作为通用的文档或知识库搜索工具。

核心特点

与同类代码搜索工具相比,code-index的核心区别在于其“混合搜索”能力:结合了传统的BM25全文检索与现代的语义向量检索(使用专为代码优化的CodeRankEmbed模型),既能理解搜索意图,又能保持关键词匹配的精确性。此外,它原生集成了AI代理技能和CLI,可直接被开发助手调用,并提供了开箱即用的Web仪表板进行多仓库工作空间管理。

注意事项

不适合作为通用的文档、图片或非代码文本内容的语义搜索工具。

常见问题

code-index 和 grep 有什么区别?

grep是纯文本匹配,需要知道准确关键词;code-index支持语义搜索,可以用自然语言描述功能来查找代码,并能跨文件理解代码含义。

是否需要联网使用?

默认使用本地llama.cpp进行嵌入计算,可完全离线部署;也支持可选的外部嵌入API(如Voyage AI)。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/code-index/raw/index.md 读取 code-index 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。