jarvis-intelligence/jarvis-index

一次索引。数据不出本机。你的仓库留在原处，jarvis index 将其转换为磁盘上的本地索引，你的 agent 直接查询该索引——全部在你的机器上完成。

面向编码 agent 的本地优先代码智能。 使用 SCIP 和
Zoekt 为你的自有仓库建立索引，然后让 agent 提出结构化问题——谁调用了这个？、这个在哪里定义的？——
而不是靠 grep 猜测。

插件发布
许可证
平台

一切都在你的机器上运行。没有代码离开本机，没有遥测，无需账户。

本仓库是公开分发界面：Homebrew tap 和 formula、可选的语言工具安装器、插件、二进制发布产物，以及 issue 跟踪器。它不包含源代码——参见为什么存在这个仓库。

你将获得

十个 MCP 工具，暴露给任何 MCP 客户端：

| | 工具 | 回答的问题 |
|---|---|---|
| 导航 | goToDefinition | X 在哪里定义？ |
| | findReferences | X 被使用的所有位置 |
| | callHierarchy | 谁调用了 X，以及 X 调用了什么 |
| | typeHierarchy | X 的父类型/子类型 |
| | documentSymbols | 文件中的每个符号 |
| 搜索 | searchCode | 跨已索引仓库的词法搜索（Zoekt） |
| | semanticSearch | 为兼容性而注册；在 Homebrew 发行版中不可用 |
| 范围 | blastRadius | 还有哪些已索引仓库依赖此包 |
| | indexRepo | 为本地 git 仓库构建索引，并立即返回以供轮询 |
| | getIndexStatus | 此仓库是否已索引，索引是否过期？ |

此外还有随插件提供的三个 agent 技能：jarvis-setup（入门引导）、
jarvis-use（引导 agent 优先使用结构化查询而非 grep），以及 jarvis-issues
（提交格式规范的 bug 报告）。

完整签名和返回结构：plugin/skills/jarvis-use/references/tool-roster.md。

快速开始

1. 安装独立二进制文件和 MCP 服务器
brew install jarvis-intelligence/jarvis/jarvis

2. 验证
jarvis --version                    # 预期输出：jarvis 0.11.0

3. 为仓库建立索引（slug 默认为目录名）
jarvis index /path/to/your/repo

4. 验证
jarvis status                 # 预期输出：indexed

然后安装下面的插件以注册 jarvis-server 并安装 agent 技能。

作为插件安装

该插件捆绑了 MCP 注册和全部三个技能，因此无需手动执行 mcp add。

| 客户端 | 方式 |
|---|---|
| Claude Code | /plugin marketplace add jarvis-intelligence/jarvis-index/plugin install jarvis@jarvis |
| Codex CLI | codex plugin marketplace add https://github.com/jarvis-intelligence/jarvis-index --ref maincodex plugin add jarvis |
| Cursor | 仪表盘 → 插件 → 添加市场 → 从仓库导入 (Teams/Enterprise)或克隆后执行 ln -s "$PWD/jarvis-index/plugin" ~/.cursor/plugins/local/jarvis |
| 其他 MCP 客户端 | 将其指向 stdio 命令 jarvis-server |

该插件会启动通过 Homebrew 安装的 jarvis-server。如有需要，之后可使用 setup 技能的 --only 命令安装可选的特定语言 SCIP 工具。

详细信息、Homebrew 限制和隐私说明：plugin/README.md。

要求

- macOS 或 Linux，且已安装 Homebrew/Linuxbrew。 不支持 Windows。
- 通过 brew install jarvis-intelligence/jarvis/jarvis 安装的 jarvis 0.11.0。
- 仅当你要索引 Java/Kotlin 仓库时，才需要 java 位于 PATH 中。

语言支持

每个索引仅支持一种语言——多语言仓库只会索引其占比最高的语言。

| 语言 | 索引器 | 说明 |
|---|---|---|
| TypeScript / JavaScript | scip-typescript | |
| Python | scip-python | |
| Swift | scip-swift | 仅限 macOS arm64；如果 Xcode 项目有多个 scheme，请传入 --scheme |
| Java / Kotlin | scip-java | Android/Gradle 项目以及偏离固定 Kotlin 版本的仓库会以仅搜索模式发布——词法搜索可用，SCIP 导航不可用，并且 Homebrew 发行版中不提供 semanticSearch |

为什么会有这个仓库

jarvis 的开发仓库是私有的，而 GitHub 只会向拥有该仓库的查看者提供原始文件和发布资产。对私有仓库的 setup.sh 执行未认证的 curl 会返回 404——而每个真实用户都会遇到这种情况。因此，所有面向用户的安装路径都放在这里，公开提供：

- 可选的语言工具安装器，任何人都可以获取
- Homebrew tap 和 formula
- Claude Code / Codex / Cursor 插件
- scip 和 zoekt 二进制文件，作为 GitHub 发布资产
- 问题跟踪器

仓库布局

setup.sh              可选的语言工具安装器 — 从开发仓库同步而来，请勿在此编辑
plugin/               插件：技能、MCP 配置、资产 — 事实来源，可直接编辑
.claude-plugin/       Claude Code 市场清单
.codex-plugin/        Codex CLI 插件清单
.cursor-plugin/       Cursor 市场清单
docs/                 本仓库的维护者文档

编辑此仓库

| 路径 | 规则 |
|---|---|
| setup.sh | 切勿在此编辑。 可选的语言工具安装器会从开发仓库自动发布，并会在下一次发布时被覆盖。请在上游修复。 |
| 其他所有内容 | 事实来源是这里——可直接编辑。 |

plugin/ 下的任何更改都必须将全部三个插件清单中的 version 提升为相同的值，否则不会触达任何人：plugin/.claude-plugin/plugin.json，
plugin/.cursor-plugin/plugin.json、.codex-plugin/plugin.json。插件 0.11.1 版本独立于 Homebrew jarvis CLI。

完整约定：docs/code-standards.md。

文档

概览 ·
架构 ·
代码库摘要 ·
标准 ·
发布 ·
路线图

链接

- 问题 / 功能请求：
- 变更日志：
- 许可证： MIT