xerj

环境要求

• Linux / macOS / Windows（x86-64 或 arm64）
• 能访问 https://xerj.org 下载安装脚本
• 系统有 curl（Linux/macOS）或 PowerShell（Windows）
• 本地 9200 端口可用（XERJ 通过该端口提供 Elasticsearch API）

安装与启动步骤

1. 1Linux/macOS 安装

   官方一键安装脚本，下载单个静态二进制，无需 JVM 和其他依赖。安装器会打印 xerj 落地路径，必要时自行加入 PATH。

   curl -fsSL https://xerj.org/get | sh

   复制

2. 2Windows 安装

   Windows 用户改用 PowerShell 安装脚本，效果与 curl 方式一致，安装完成后同样确认 xerj 是否在 PATH 中。

   irm https://xerj.org/get.ps1 | iex

   复制

3. 3启动 XERJ 服务

   以本地模式后台启动服务，数据写入 ./data 目录。启动后等待 http://localhost:9200 能响应再进行下一步。

   xerj --insecure --data-dir ./data &

   复制

4. 4接入编辑器与智能体

   一条命令把 XERJ 接入 Claude Code / Cursor（配置 MCP 与 skill），让编码智能体直接调用本地检索能力。

   xerj init

   复制

5. 5索引项目目录

   自动索引指定文件夹（代码、文档、日志、PDF 等）。README 示例为 ~/my-project，请替换成你自己的项目路径。

   xerj autoindex ~/my-project

   复制

6. 6执行搜索验证

   用自然语言查询已索引数据，返回带排序的片段和 file:line 定位信息，确认索引与检索链路正常。

   xerj search "how do we rotate the WAL segment"

   复制

关键配置

如何确认成功

等待 http://localhost:9200 返回响应，随后 xerj search 能返回带 file:line 的排序结果片段即表示可用。

常见问题

注意事项

• README 中未给出从源码构建的具体命令，如需自行编译请查阅官方文档。
• --insecure 为 README 示例中的本地运行方式，生产环境请自行评估安全配置。
• 首次索引耗时取决于目录大小，建议先用小项目验证流程。
• 可参考官网 https://xerj.org/llms.txt 获取适合交给 AI 智能体执行的安装提示词。