indxr (Bahdotsh)

indxr

用于AI代理的快速代码库索引器和知识维基。

  

indxr为AI代理提供了一个持久的、自我更新的wiki，该wiki由快速的结构索引支持，可以查看您的代码库。架构决策、模块责任、故障模式——通常存在于人们脑海中的东西——被写下来并保持最新状态。

______________________________________________________________________

特性

• 代码库知识维基 --具有架构页面、模块概述、故障模式记录、矛盾跟踪和知识复合的持久wiki。代理查询它，从中学习，并写回它
• 9个wiki MCP工具 — wiki_generate, wiki_search, wiki_read, wiki_contribute, wiki_update, wiki_compound, wiki_suggest_contribution, wiki_record_failure, wiki_status
• 自我更新 --wiki通过以下方式自动与代码更改保持同步 indxr serve --watch --wiki-auto-update
• 26工具MCP服务器 （3个复合默认值+23个粒度过孔 --all-tools)--符号查找、文件摘要、调用者跟踪、签名搜索、复杂性热点、类型流跟踪、工作区支持
• 27种语言 --树型AST解析8种语言，正则表达式提取19种以上
• 令牌感知 --渐进式截断以适应上下文窗口
• Git结构差异 --声明级别差异(+ 补充， - 远离的， ~ 更改）针对任何git ref或GitHub PR
• 依赖图 --文件和符号依赖关系可视化为DOT、Mermaid或JSON
• 文件监视 --编辑时通过以下方式不断重新索引 indxr watch 或 indxr serve --watch
• Monrepo/工作空间支持 --Cargo、npm、Go工作空间； --member 针对特定成员
• 一个命令代理设置 — indxr init 配置克劳德代码、游标、Windsurf、Codex CLI
• 增量缓存 --mtime+xxh3内容哈希
• 复杂性热点 --每个函数的圈复杂度、嵌套深度、参数计数；代码库健康报告
• 可组合过滤器 --路径、种类、符号名称、可见性、语言

安装

cargo install indxr --features wiki

这将在完整的wiki系统中安装indxr。对于其他运输：

cargo install indxr --features wiki,http   # + Streamable HTTP transport

或者从源代码构建：

git clone https://github.com/bahdotsh/indxr.git
cd indxr && cargo build --release --features wiki

您也可以在没有wiki功能的情况下安装(cargo install indxr)如果你只需要结构索引。

用法

# Wiki — the core workflow
indxr wiki generate                          # generate codebase knowledge wiki
indxr wiki update                            # update wiki after code changes
indxr wiki status                            # check wiki health
indxr wiki compound notes.txt                # compound knowledge from file

# MCP server — live queries + wiki tools for AI agents
indxr serve ./my-project --watch --wiki-auto-update  # recommended: full setup
indxr serve ./my-project                     # start MCP server (structural only)
indxr serve ./my-project --watch             # MCP server with auto-reindex

# Structural indexing
indxr                                        # index cwd → stdout
indxr ./my-project -o INDEX.md               # index project → file
indxr -f json -l rust,python -o index.json   # JSON, filter by language

# Setup
indxr init                                   # set up all agent configs
indxr members                                # list workspace members (monorepo)

代码库知识Wiki

结构索引告诉代理代码库中存在的内容。维基告诉他们为什么。架构决策、模块职责、故障模式——当有人离开团队时，这些东西通常会丢失。

indxr wiki generate                          # generate wiki from scratch
indxr wiki update                            # update after code changes
indxr wiki status                            # check wiki health
indxr wiki compound notes.txt                # compound knowledge from file
echo "synthesis" | indxr wiki compound -     # compound from stdin

Wiki页面存储在 .indxr/wiki/ 作为带有YAML frontmatter的Markdown。页面类型： architecture, module, entity, topic.页面支持 [[page-id]] 交叉引用、矛盾跟踪和故障模式记录。

代理商如何使用wiki

1. 生成： wiki_generate → 代理从结构上下文中规划页面，编写每个通路 wiki_contribute
2. 查询： wiki_search 在阅读源代码之前了解模块和设计决策
3. 学习： wiki_compound 在跨页面分析后保留综合见解
4. 记录失败： wiki_record_failure 所以未来的特工不会再犯错误
5. 更新： wiki_update 识别代码更改后的过时页面，代理通过以下方式重写 wiki_contribute

Wiki MCP工具（9个工具）

wiki_generate 始终列出；一旦wiki存在，剩下的8个工具就会出现。Wiki工具支持矛盾跟踪和故障模式记录。

自动更新wiki

MCP服务器自动使wiki与您的代码保持同步：

indxr serve --watch --wiki-auto-update

源文件更改时触发wiki页面更新。集 ANTHROPIC_API_KEY, OPENAI_API_KEY，或使用 --exec 用于自定义LLM后端。

看 Wiki文档 有关页面结构、LLM配置和磁盘布局的完整详细信息。

代理设置

indxr init                    # set up for all agents
indxr init --claude           # Claude Code only
indxr init --cursor           # Cursor only
indxr init --windsurf         # Windsurf only
indxr init --codex            # OpenAI Codex CLI only
indxr init --global           # install globally for all projects
indxr init --global --cursor  # global Cursor only
indxr init --no-rtk           # skip RTK hook setup

代理并不总是选择MCP工具而不是自己读取文件。 indxr init 设置PreToolUse拦截钩子 Read/Bash 用于教授探索工作流程的调用和指令文件。

MCP服务器

JSON-RPC 2.0通过标准输入/标准输出（或可流式HTTP） --features http).默认列出3个复合工具； --all-tools 全部暴露26。当Wiki存在时，Wiki工具（9）可用。

默认工具（3种组合）

粒度工具（23--需要 --all-tools)

即使未列出，粒度工具也始终可调用-- --all-tools 仅控制它们是否出现在 tools/list.

当Wiki存在时，Wiki工具（9）也可用。看 Wiki部分.

在工作空间模式下，工具获得 member param到范围查询。列表工具支持 compact 模式。看 MCP服务器文档 了解详情。

输出

默认格式为Markdown signatures 细节级别：

# Codebase Index: my-project

> Generated: 2025-03-23 | Files: 42 | Lines: 8,234
> Languages: Rust (28), Python (10), TypeScript (4)

## Directory Structure
src/
  main.rs
  parser/
    mod.rs
    rust.rs

## src/main.rs

**Language:** Rust | **Size:** 1.2 KB | **Lines:** 45

**Declarations:**
`pub fn main() -> Result`
`pub struct App`

过滤

indxr --filter-path src/parser              # subtree
indxr --kind function --public-only         # public functions only
indxr --symbol "parse"                      # symbol name search
indxr -l rust,python                        # language filter
indxr --filter-path src/model --kind struct --public-only  # combine

过滤器组成。 --kind 接受： function, struct, class, trait, enum, interface, module, method, constant, impl, type, namespace, macro.

Git结构差异

indxr --since main
indxr --since v1.0.0
indxr --since HEAD~5
indxr diff --pr 42                           # diff against a GitHub PR's base branch

## Modified Files

### src/parser/mod.rs
+ `pub fn new_parser() -> Parser`
- `fn old_helper()`
~ `fn process(x: i32)` → `fn process(x: i32, y: i32)`

标记： + 补充， - 远离的， ~ 签名已更改。

复杂性热点

indxr --hotspots                             # top 30 most complex functions
indxr --hotspots --filter-path src/parser    # scoped to a directory

显示圈复杂度、最大嵌套深度、参数计数、体线和每个函数的复合得分。树保姆只解析语言。

MCP工具： get_hotspots, get_health, get_type_flow.

依赖图

indxr --graph dot                            # file-level DOT graph
indxr --graph mermaid                        # file-level Mermaid diagram
indxr --graph json                           # JSON graph
indxr --graph dot --graph-level symbol       # symbol-level graph
indxr --graph mermaid --filter-path src/mcp  # scoped to a directory
indxr --graph dot --graph-depth 2            # limit to 2 hops

代币预算

indxr --max-tokens 4000

截断顺序：文档注释→ 私人声明→ 孩子→ 最不重要的文件。首先保留目录树和公共API曲面。

语言

8个树保姆（全AST）+19个正则表达式（结构提取）：

检测是按文件扩展名进行的。详细信息： docs/languages.md

演出

通过人造丝进行并行解析。通过mtime+xxh3进行增量缓存。

文档

贡献

欢迎投稿——欢迎打开问题或提交PR。

许可证

麻省理工学院