indxr 0.2.0

Fast codebase indexer for AI agents
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

# Dependency Graph

indxr can generate dependency graphs that visualize relationships between files or symbols. Output as DOT (Graphviz), Mermaid, or JSON.

## Usage

```bash
indxr --graph <FORMAT> [OPTIONS]
```

Where `<FORMAT>` is one of: `dot`, `mermaid`, `json`.

## Graph Levels

### File Level (default)

Shows file-to-file import relationships — which files depend on which other files.

```bash
indxr --graph dot
indxr --graph mermaid
```

### Symbol Level

Shows symbol-to-symbol relationships — trait implementations, method calls, type references.

```bash
indxr --graph dot --graph-level symbol
indxr --graph mermaid --graph-level symbol
```

## Scoping

Use `--filter-path` to scope the graph to a subdirectory. Only files/symbols within the scope become root nodes, but their dependencies outside the scope are still included.

```bash
# Graph centered on the parser module
indxr --graph dot --filter-path src/parser

# Graph centered on the MCP module
indxr --graph mermaid --filter-path src/mcp
```

## Depth Limiting

Use `--graph-depth` to limit how many hops from the scoped files are included:

```bash
# Only direct dependencies (1 hop)
indxr --graph dot --filter-path src/mcp --graph-depth 1

# Up to 2 hops
indxr --graph dot --filter-path src/mcp --graph-depth 2
```

Without `--graph-depth`, all reachable nodes are included.

## Output Formats

### DOT (Graphviz)

```bash
indxr --graph dot -o deps.dot
```

Render with Graphviz:

```bash
dot -Tpng deps.dot -o deps.png
dot -Tsvg deps.dot -o deps.svg
```

### Mermaid

```bash
indxr --graph mermaid -o deps.mmd
```

Mermaid diagrams render directly in GitHub Markdown, GitLab, and many documentation tools.

### JSON

```bash
indxr --graph json -o deps.json
```

Structured output with `nodes` and `edges` arrays for programmatic consumption.

## Examples

### Full project file dependency graph

```bash
indxr --graph dot -o deps.dot
dot -Tsvg deps.dot -o deps.svg
```

### Module-scoped Mermaid diagram

```bash
indxr --graph mermaid --filter-path src/parser
```

### Symbol-level graph for a specific module

```bash
indxr --graph dot --graph-level symbol --filter-path src/model
```

### JSON graph for analysis tooling

```bash
indxr --graph json -o deps.json
```

## Combining with Other Options

The `--graph` flag replaces normal index output. Other flags that affect it:

- `--filter-path` — scope the graph root
- `--graph-level` — choose file or symbol granularity
- `--graph-depth` — limit edge hops
- `-o, --output` — write to file instead of stdout
- `-q, --quiet` — suppress progress output