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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
use clap::{Parser, Subcommand};
#[derive(Debug, Parser)]
#[command(
name = "rust-relations-explorer",
version,
about = "Rust Knowledge Graph System",
long_about = "Parse Rust projects into a knowledge graph and run queries. File discovery respects .gitignore and .ignore with parent traversal. Global git excludes are disabled for determinism. Use --no-ignore to bypass ignore rules."
)]
pub struct Cli {
#[command(subcommand)]
pub command: Commands,
}
#[derive(Debug, Subcommand)]
pub enum Commands {
/// Build the knowledge graph from a source directory
Build {
/// Path to the Rust project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(
long,
default_value_t = false,
help = "Include files even if matched by .gitignore/.ignore. Global git excludes are always disabled for determinism."
)]
no_ignore: bool,
/// Ignore cache when building (do not reuse cached files)
#[arg(long, default_value_t = false)]
no_cache: bool,
/// Rebuild cache from scratch (clears previous cache)
#[arg(long, default_value_t = false)]
rebuild: bool,
/// Output JSON file path
#[arg(long)]
json: Option<String>,
/// Output DOT file path
#[arg(long)]
dot: Option<String>,
/// Output SVG file path
#[arg(long)]
svg: Option<String>,
/// DOT: enable/disable hierarchical clusters (default: on)
#[arg(long, value_parser = ["on", "off"], default_value = "on")]
dot_clusters: String,
/// DOT: include legend (default: on)
#[arg(long, value_parser = ["on", "off"], default_value = "on")]
dot_legend: String,
/// DOT: theme (light or dark)
#[arg(long, value_parser = ["light", "dark"], default_value = "light")]
dot_theme: String,
/// DOT: rank direction (LR or TB)
#[arg(long, value_parser = ["LR", "TB"], default_value = "LR")]
dot_rankdir: String,
/// DOT: edge splines style (curved, ortho, polyline)
#[arg(long, value_parser = ["curved", "ortho", "polyline"], default_value = "curved")]
dot_splines: String,
/// DOT: rounded node corners (on/off)
#[arg(long, value_parser = ["on", "off"], default_value = "on")]
dot_rounded: String,
/// SVG: add interactive enhancements (on/off)
#[arg(long, value_parser = ["on", "off"], default_value = "on")]
svg_interactive: String,
/// Save built graph to JSON file path
#[arg(long)]
save: Option<String>,
},
/// Run queries over the knowledge graph
Query {
#[command(subcommand)]
query: QueryCommands,
},
}
#[derive(Debug, Subcommand)]
pub enum QueryCommands {
/// List files connected to the given file via relationships
ConnectedFiles {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(
long,
default_value_t = false,
help = "Include files even if matched by .gitignore/.ignore. Global git excludes are always disabled for determinism."
)]
no_ignore: bool,
/// The file to analyze (absolute or relative)
#[arg(long)]
file: String,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// Show a single item's definition and relations by ItemId
ItemInfo {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// ItemId (e.g., fn:createIcons:6)
#[arg(long, value_name = "ID")]
item_id: String,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Include code snippet of the item's definition
#[arg(long, default_value_t = true)]
show_code: bool,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// List files that call or are called by a given function name
FunctionUsage {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Function name to analyze
#[arg(long)]
function: String,
/// Direction: callers or callees
#[arg(long, value_parser = ["callers", "callees"], default_value = "callers")]
direction: String,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// Detect cycles between files
Cycles {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// Compute shortest path between two files
Path {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Source file path
#[arg(long)]
from: String,
/// Destination file path
#[arg(long)]
to: String,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// List top-N hub files by degree centrality
Hubs {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Metric: in, out, total
#[arg(long, value_parser = ["in", "out", "total"], default_value = "total")]
metric: String,
/// Top N results
#[arg(long, default_value_t = 10)]
top: usize,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// List top-N modules (directories) by degree centrality
ModuleCentrality {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Metric: in, out, total
#[arg(long, value_parser = ["in", "out", "total"], default_value = "total")]
metric: String,
/// Top N results
#[arg(long, default_value_t = 10)]
top: usize,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// List types implementing a trait
TraitImpls {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Trait name (e.g., Display)
#[arg(long, value_name = "NAME")]
r#trait: String,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
/// List items with no inbound usage edges (potentially dead code)
UnreferencedItems {
/// Path to project root (directory containing src/)
#[arg(short, long, default_value = ".")]
path: String,
/// Path to a TOML configuration file
#[arg(long)]
config: Option<String>,
/// Bypass ignore rules (.gitignore/.ignore) when discovering files
#[arg(long, default_value_t = false)]
no_ignore: bool,
/// Include public items as well (by default public items are excluded)
#[arg(long, default_value_t = false)]
include_public: bool,
/// Regex to exclude paths (e.g., 'tests|benches|examples')
#[arg(long)]
exclude: Option<String>,
/// Optional path to a prebuilt graph JSON (skips rebuild)
#[arg(long)]
graph: Option<String>,
/// Output format: text or json
#[arg(long, value_parser = ["text", "json"], default_value = "text")]
format: String,
},
}
#[must_use]
pub fn parse() -> Cli {
Cli::parse()
}