Navegador

navegador / getting-started / quickstart / index.html

Source Rendered

Blame History Raw 1750 lines

1
2	`<!doctype html>`
3	`<html lang="en" class="no-js">`
4	`<head>`
5
6	`<meta charset="utf-8">`
7	`<meta name="viewport" content="width=device-width,initial-scale=1">`
8
9	`<meta name="description" content="Project knowledge graph for AI coding agents — code structure, business rules, and architectural decisions in one queryable graph">`
10
11
12	`<meta name="author" content="CONFLICT LLC">`
13
14
15	`<link rel="canonical" href="https://navegador.dev/getting-started/quickstart/">`
16
17
18	`<link rel="prev" href="../installation/">`
19
20
21	`<link rel="next" href="../configuration/">`
22
23
24
25
26
27	`<link rel="icon" href="../../assets/images/favicon.png">`
28	`<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">`
29
30
31
32	`<title>Quick Start - Navegador</title>`
33
34
35
36	`<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">`
37
38
39	`<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">`
40
41
42
43
44
45
46
47
48
49
50
51
52	`<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>`
53	`<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">`
54	`<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>`
55
56
57
58	`<link rel="stylesheet" href="../../assets/_mkdocstrings.css">`
59
60	`<link rel="stylesheet" href="../../assets/css/custom.css">`
61
62	`<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>`
63
64
65
66
67
68	`</head>`
69
70
71
72
73
74
75
76
77
78	`<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">`
79
80
81	`<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">`
82	`<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">`
83	`<label class="md-overlay" for="__drawer"></label>`
84	`<div data-md-component="skip">`
85
86
87	`<a href="#quick-start" class="md-skip">`
88	`Skip to content`
89	`</a>`
90
91	`</div>`
92	`<div data-md-component="announce">`
93
94	`</div>`
95
96
97
98
99	`<header class="md-header" data-md-component="header">`
100	`<nav class="md-header__inner md-grid" aria-label="Header">`
101	`<a href="../.." title="Navegador" class="md-header__button md-logo" aria-label="Navegador" data-md-component="logo">`
102
103	`<img src="../../assets/images/conflict-logo.svg" alt="logo">`
104
105	`</a>`
106	`<label class="md-header__button md-icon" for="__drawer">`
107
108	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>`
109	`</label>`
110	`<div class="md-header__title" data-md-component="header-title">`
111	`<div class="md-header__ellipsis">`
112	`<div class="md-header__topic">`
113	`<span class="md-ellipsis">`
114	`Navegador`
115	`</span>`
116	`</div>`
117	`<div class="md-header__topic" data-md-component="header-topic">`
118	`<span class="md-ellipsis">`
119
120	`Quick Start`
121
122	`</span>`
123	`</div>`
124	`</div>`
125	`</div>`
126
127
128	`<form class="md-header__option" data-md-component="palette">`
129
130
131
132
133	`<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">`
134
135	`<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>`
136	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>`
137	`</label>`
138
139
140
141
142
143	`<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">`
144
145	`<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>`
146	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>`
147	`</label>`
148
149
150	`</form>`
151
152
153
154	<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
155
156
157
158
159
160	`<label class="md-header__button md-icon" for="__search">`
161
162	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>`
163	`</label>`
164	`<div class="md-search" data-md-component="search" role="dialog">`
165	`<label class="md-search__overlay" for="__search"></label>`
166	`<div class="md-search__inner" role="search">`
167	`<form class="md-search__form" name="search">`
168	`<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>`
169	`<label class="md-search__icon md-icon" for="__search">`
170
171	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>`
172
173	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>`
174	`</label>`
175	`<nav class="md-search__options" aria-label="Search">`
176
177	`<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">`
178
179	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>`
180	`</button>`
181	`</nav>`
182
183	`<div class="md-search__suggest" data-md-component="search-suggest"></div>`
184
185	`</form>`
186	`<div class="md-search__output">`
187	`<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>`
188	`<div class="md-search-result" data-md-component="search-result">`
189	`<div class="md-search-result__meta">`
190	`Initializing search`
191	`</div>`
192	`<ol class="md-search-result__list" role="presentation"></ol>`
193	`</div>`
194	`</div>`
195	`</div>`
196	`</div>`
197	`</div>`
198
199
200
201	`<div class="md-header__source">`
202	`<a href="https://github.com/ConflictHQ/navegador" title="Go to repository" class="md-source" data-md-component="source">`
203	`<div class="md-source__icon md-icon">`
204
205	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
206	`</div>`
207	`<div class="md-source__repository">`
208	`ConflictHQ/navegador`
209	`</div>`
210	`</a>`
211	`</div>`
212
213	`</nav>`
214
215	`</header>`
216
217	`<div class="md-container" data-md-component="container">`
218
219
220
221
222
223	`<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">`
224	`<div class="md-grid">`
225	`<ul class="md-tabs__list">`
226
227
228
229
230
231
232	`<li class="md-tabs__item">`
233	`<a href="../.." class="md-tabs__link">`
234
235
236
237
238
239	`Home`
240
241	`</a>`
242	`</li>`
243
244
245
246
247
248
249
250
251
252
253
254
255	`<li class="md-tabs__item md-tabs__item--active">`
256	`<a href="../installation/" class="md-tabs__link">`
257
258
259
260	`Getting Started`
261
262	`</a>`
263	`</li>`
264
265
266
267
268
269
270
271
272
273
274
275	`<li class="md-tabs__item">`
276	`<a href="../../guide/ingestion/" class="md-tabs__link">`
277
278
279
280	`Guide`
281
282	`</a>`
283	`</li>`
284
285
286
287
288
289
290
291
292
293
294
295	`<li class="md-tabs__item">`
296	`<a href="../../architecture/overview/" class="md-tabs__link">`
297
298
299
300	`Architecture`
301
302	`</a>`
303	`</li>`
304
305
306
307
308
309
310
311
312
313
314
315	`<li class="md-tabs__item">`
316	`<a href="../../api/sdk/" class="md-tabs__link">`
317
318
319
320	`API Reference`
321
322	`</a>`
323	`</li>`
324
325
326
327
328	`</ul>`
329	`</div>`
330	`</nav>`
331
332
333
334	`<main class="md-main" data-md-component="main">`
335	`<div class="md-main__inner md-grid">`
336
337
338
339	`<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >`
340	`<div class="md-sidebar__scrollwrap">`
341	`<div class="md-sidebar__inner">`
342
343
344
345
346
347
348	`<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">`
349	`<label class="md-nav__title" for="__drawer">`
350	`<a href="../.." title="Navegador" class="md-nav__button md-logo" aria-label="Navegador" data-md-component="logo">`
351
352	`<img src="../../assets/images/conflict-logo.svg" alt="logo">`
353
354	`</a>`
355	`Navegador`
356	`</label>`
357
358	`<div class="md-nav__source">`
359	`<a href="https://github.com/ConflictHQ/navegador" title="Go to repository" class="md-source" data-md-component="source">`
360	`<div class="md-source__icon md-icon">`
361
362	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
363	`</div>`
364	`<div class="md-source__repository">`
365	`ConflictHQ/navegador`
366	`</div>`
367	`</a>`
368	`</div>`
369
370	`<ul class="md-nav__list" data-md-scrollfix>`
371
372
373
374
375
376
377
378	`<li class="md-nav__item">`
379	`<a href="../.." class="md-nav__link">`
380
381
382
383	`<span class="md-ellipsis">`
384
385
386	`Home`
387
388
389
390	`</span>`
391
392
393
394	`</a>`
395	`</li>`
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420	`<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">`
421
422
423
424	`<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>`
425
426
427	`<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">`
428
429
430
431	`<span class="md-ellipsis">`
432
433
434	`Getting Started`
435
436
437
438	`</span>`
439
440
441
442	`<span class="md-nav__icon md-icon"></span>`
443	`</label>`
444
445	`<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">`
446	`<label class="md-nav__title" for="__nav_2">`
447	`<span class="md-nav__icon md-icon"></span>`
448
449
450	`Getting Started`
451
452
453	`</label>`
454	`<ul class="md-nav__list" data-md-scrollfix>`
455
456
457
458
459
460
461
462	`<li class="md-nav__item">`
463	`<a href="../installation/" class="md-nav__link">`
464
465
466
467	`<span class="md-ellipsis">`
468
469
470	`Installation`
471
472
473
474	`</span>`
475
476
477
478	`</a>`
479	`</li>`
480
481
482
483
484
485
486
487
488
489
490
491
492	`<li class="md-nav__item md-nav__item--active">`
493
494	`<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">`
495
496
497
498
499
500	`<label class="md-nav__link md-nav__link--active" for="__toc">`
501
502
503
504	`<span class="md-ellipsis">`
505
506
507	`Quick Start`
508
509
510
511	`</span>`
512
513
514
515	`<span class="md-nav__icon md-icon"></span>`
516	`</label>`
517
518	`<a href="./" class="md-nav__link md-nav__link--active">`
519
520
521
522	`<span class="md-ellipsis">`
523
524
525	`Quick Start`
526
527
528
529	`</span>`
530
531
532
533	`</a>`
534
535
536
537	`<nav class="md-nav md-nav--secondary" aria-label="Table of contents">`
538
539
540
541
542
543
544	`<label class="md-nav__title" for="__toc">`
545	`<span class="md-nav__icon md-icon"></span>`
546	`Table of contents`
547	`</label>`
548	`<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>`
549
550	`<li class="md-nav__item">`
551	`<a href="#step-1-install" class="md-nav__link">`
552	`<span class="md-ellipsis">`
553
554	`Step 1: Install`
555
556	`</span>`
557	`</a>`
558
559	`</li>`
560
561	`<li class="md-nav__item">`
562	`<a href="#step-2-ingest-a-repo" class="md-nav__link">`
563	`<span class="md-ellipsis">`
564
565	`Step 2: Ingest a repo`
566
567	`</span>`
568	`</a>`
569
570	`</li>`
571
572	`<li class="md-nav__item">`
573	`<a href="#step-3-query-the-graph" class="md-nav__link">`
574	`<span class="md-ellipsis">`
575
576	`Step 3: Query the graph`
577
578	`</span>`
579	`</a>`
580
581	`</li>`
582
583	`<li class="md-nav__item">`
584	`<a href="#step-4-add-business-knowledge" class="md-nav__link">`
585	`<span class="md-ellipsis">`
586
587	`Step 4: Add business knowledge`
588
589	`</span>`
590	`</a>`
591
592	`</li>`
593
594	`<li class="md-nav__item">`
595	`<a href="#step-5-wire-an-agent-hook" class="md-nav__link">`
596	`<span class="md-ellipsis">`
597
598	`Step 5: Wire an agent hook`
599
600	`</span>`
601	`</a>`
602
603	`</li>`
604
605	`<li class="md-nav__item">`
606	`<a href="#step-6-optional-sdk-quick-start" class="md-nav__link">`
607	`<span class="md-ellipsis">`
608
609	`Step 6 (optional): SDK quick start`
610
611	`</span>`
612	`</a>`
613
614	`</li>`
615
616	`<li class="md-nav__item">`
617	`<a href="#step-7-optional-code-analysis" class="md-nav__link">`
618	`<span class="md-ellipsis">`
619
620	`Step 7 (optional): Code analysis`
621
622	`</span>`
623	`</a>`
624
625	`</li>`
626
627	`</ul>`
628
629	`</nav>`
630
631	`</li>`
632
633
634
635
636
637
638
639
640
641
642	`<li class="md-nav__item">`
643	`<a href="../configuration/" class="md-nav__link">`
644
645
646
647	`<span class="md-ellipsis">`
648
649
650	`Configuration`
651
652
653
654	`</span>`
655
656
657
658	`</a>`
659	`</li>`
660
661
662
663
664	`</ul>`
665	`</nav>`
666
667	`</li>`
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687	`<li class="md-nav__item md-nav__item--nested">`
688
689
690
691
692
693	`<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >`
694
695
696	`<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">`
697
698
699
700	`<span class="md-ellipsis">`
701
702
703	`Guide`
704
705
706
707	`</span>`
708
709
710
711	`<span class="md-nav__icon md-icon"></span>`
712	`</label>`
713
714	`<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">`
715	`<label class="md-nav__title" for="__nav_3">`
716	`<span class="md-nav__icon md-icon"></span>`
717
718
719	`Guide`
720
721
722	`</label>`
723	`<ul class="md-nav__list" data-md-scrollfix>`
724
725
726
727
728
729
730
731	`<li class="md-nav__item">`
732	`<a href="../../guide/ingestion/" class="md-nav__link">`
733
734
735
736	`<span class="md-ellipsis">`
737
738
739	`Ingesting a Repo`
740
741
742
743	`</span>`
744
745
746
747	`</a>`
748	`</li>`
749
750
751
752
753
754
755
756
757
758
759	`<li class="md-nav__item">`
760	`<a href="../../guide/context-loading/" class="md-nav__link">`
761
762
763
764	`<span class="md-ellipsis">`
765
766
767	`Loading Context`
768
769
770
771	`</span>`
772
773
774
775	`</a>`
776	`</li>`
777
778
779
780
781
782
783
784
785
786
787	`<li class="md-nav__item">`
788	`<a href="../../guide/framework-enrichment/" class="md-nav__link">`
789
790
791
792	`<span class="md-ellipsis">`
793
794
795	`Framework Enrichment`
796
797
798
799	`</span>`
800
801
802
803	`</a>`
804	`</li>`
805
806
807
808
809
810
811
812
813
814
815	`<li class="md-nav__item">`
816	`<a href="../../guide/analysis/" class="md-nav__link">`
817
818
819
820	`<span class="md-ellipsis">`
821
822
823	`Structural Analysis`
824
825
826
827	`</span>`
828
829
830
831	`</a>`
832	`</li>`
833
834
835
836
837
838
839
840
841
842
843	`<li class="md-nav__item">`
844	`<a href="../../guide/intelligence/" class="md-nav__link">`
845
846
847
848	`<span class="md-ellipsis">`
849
850
851	`Intelligence Layer`
852
853
854
855	`</span>`
856
857
858
859	`</a>`
860	`</li>`
861
862
863
864
865
866
867
868
869
870
871	`<li class="md-nav__item">`
872	`<a href="../../guide/sdk/" class="md-nav__link">`
873
874
875
876	`<span class="md-ellipsis">`
877
878
879	`Python SDK`
880
881
882
883	`</span>`
884
885
886
887	`</a>`
888	`</li>`
889
890
891
892
893
894
895
896
897
898
899	`<li class="md-nav__item">`
900	`<a href="../../guide/graph-queries/" class="md-nav__link">`
901
902
903
904	`<span class="md-ellipsis">`
905
906
907	`Graph Queries`
908
909
910
911	`</span>`
912
913
914
915	`</a>`
916	`</li>`
917
918
919
920
921
922
923
924
925
926
927	`<li class="md-nav__item">`
928	`<a href="../../guide/mcp-integration/" class="md-nav__link">`
929
930
931
932	`<span class="md-ellipsis">`
933
934
935	`MCP Integration`
936
937
938
939	`</span>`
940
941
942
943	`</a>`
944	`</li>`
945
946
947
948
949
950
951
952
953
954
955	`<li class="md-nav__item">`
956	`<a href="../../guide/ci-cd/" class="md-nav__link">`
957
958
959
960	`<span class="md-ellipsis">`
961
962
963	`CI/CD`
964
965
966
967	`</span>`
968
969
970
971	`</a>`
972	`</li>`
973
974
975
976
977
978
979
980
981
982
983	`<li class="md-nav__item">`
984	`<a href="../../guide/cluster/" class="md-nav__link">`
985
986
987
988	`<span class="md-ellipsis">`
989
990
991	`Cluster Mode`
992
993
994
995	`</span>`
996
997
998
999	`</a>`
1000	`</li>`
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011	`<li class="md-nav__item">`
1012	`<a href="../../guide/agent-hooks/" class="md-nav__link">`
1013
1014
1015
1016	`<span class="md-ellipsis">`
1017
1018
1019	`Agent Hooks`
1020
1021
1022
1023	`</span>`
1024
1025
1026
1027	`</a>`
1028	`</li>`
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039	`<li class="md-nav__item">`
1040	`<a href="../../guide/planopticon/" class="md-nav__link">`
1041
1042
1043
1044	`<span class="md-ellipsis">`
1045
1046
1047	`Planopticon`
1048
1049
1050
1051	`</span>`
1052
1053
1054
1055	`</a>`
1056	`</li>`
1057
1058
1059
1060
1061	`</ul>`
1062	`</nav>`
1063
1064	`</li>`
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084	`<li class="md-nav__item md-nav__item--nested">`
1085
1086
1087
1088
1089
1090	`<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >`
1091
1092
1093	`<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">`
1094
1095
1096
1097	`<span class="md-ellipsis">`
1098
1099
1100	`Architecture`
1101
1102
1103
1104	`</span>`
1105
1106
1107
1108	`<span class="md-nav__icon md-icon"></span>`
1109	`</label>`
1110
1111	`<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">`
1112	`<label class="md-nav__title" for="__nav_4">`
1113	`<span class="md-nav__icon md-icon"></span>`
1114
1115
1116	`Architecture`
1117
1118
1119	`</label>`
1120	`<ul class="md-nav__list" data-md-scrollfix>`
1121
1122
1123
1124
1125
1126
1127
1128	`<li class="md-nav__item">`
1129	`<a href="../../architecture/overview/" class="md-nav__link">`
1130
1131
1132
1133	`<span class="md-ellipsis">`
1134
1135
1136	`Overview`
1137
1138
1139
1140	`</span>`
1141
1142
1143
1144	`</a>`
1145	`</li>`
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156	`<li class="md-nav__item">`
1157	`<a href="../../architecture/graph-schema/" class="md-nav__link">`
1158
1159
1160
1161	`<span class="md-ellipsis">`
1162
1163
1164	`Graph Schema`
1165
1166
1167
1168	`</span>`
1169
1170
1171
1172	`</a>`
1173	`</li>`
1174
1175
1176
1177
1178	`</ul>`
1179	`</nav>`
1180
1181	`</li>`
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201	`<li class="md-nav__item md-nav__item--nested">`
1202
1203
1204
1205
1206
1207	`<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >`
1208
1209
1210	`<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">`
1211
1212
1213
1214	`<span class="md-ellipsis">`
1215
1216
1217	`API Reference`
1218
1219
1220
1221	`</span>`
1222
1223
1224
1225	`<span class="md-nav__icon md-icon"></span>`
1226	`</label>`
1227
1228	`<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">`
1229	`<label class="md-nav__title" for="__nav_5">`
1230	`<span class="md-nav__icon md-icon"></span>`
1231
1232
1233	`API Reference`
1234
1235
1236	`</label>`
1237	`<ul class="md-nav__list" data-md-scrollfix>`
1238
1239
1240
1241
1242
1243
1244
1245	`<li class="md-nav__item">`
1246	`<a href="../../api/sdk/" class="md-nav__link">`
1247
1248
1249
1250	`<span class="md-ellipsis">`
1251
1252
1253	`Python SDK`
1254
1255
1256
1257	`</span>`
1258
1259
1260
1261	`</a>`
1262	`</li>`
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273	`<li class="md-nav__item">`
1274	`<a href="../../api/ingestion/" class="md-nav__link">`
1275
1276
1277
1278	`<span class="md-ellipsis">`
1279
1280
1281	`Ingestion`
1282
1283
1284
1285	`</span>`
1286
1287
1288
1289	`</a>`
1290	`</li>`
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301	`<li class="md-nav__item">`
1302	`<a href="../../api/analysis/" class="md-nav__link">`
1303
1304
1305
1306	`<span class="md-ellipsis">`
1307
1308
1309	`Analysis`
1310
1311
1312
1313	`</span>`
1314
1315
1316
1317	`</a>`
1318	`</li>`
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329	`<li class="md-nav__item">`
1330	`<a href="../../api/graph/" class="md-nav__link">`
1331
1332
1333
1334	`<span class="md-ellipsis">`
1335
1336
1337	`Graph`
1338
1339
1340
1341	`</span>`
1342
1343
1344
1345	`</a>`
1346	`</li>`
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357	`<li class="md-nav__item">`
1358	`<a href="../../api/mcp/" class="md-nav__link">`
1359
1360
1361
1362	`<span class="md-ellipsis">`
1363
1364
1365	`MCP Server`
1366
1367
1368
1369	`</span>`
1370
1371
1372
1373	`</a>`
1374	`</li>`
1375
1376
1377
1378
1379	`</ul>`
1380	`</nav>`
1381
1382	`</li>`
1383
1384
1385
1386	`</ul>`
1387	`</nav>`
1388	`</div>`
1389	`</div>`
1390	`</div>`
1391
1392
1393
1394	`<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >`
1395	`<div class="md-sidebar__scrollwrap">`
1396	`<div class="md-sidebar__inner">`
1397
1398
1399	`<nav class="md-nav md-nav--secondary" aria-label="Table of contents">`
1400
1401
1402
1403
1404
1405
1406	`<label class="md-nav__title" for="__toc">`
1407	`<span class="md-nav__icon md-icon"></span>`
1408	`Table of contents`
1409	`</label>`
1410	`<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>`
1411
1412	`<li class="md-nav__item">`
1413	`<a href="#step-1-install" class="md-nav__link">`
1414	`<span class="md-ellipsis">`
1415
1416	`Step 1: Install`
1417
1418	`</span>`
1419	`</a>`
1420
1421	`</li>`
1422
1423	`<li class="md-nav__item">`
1424	`<a href="#step-2-ingest-a-repo" class="md-nav__link">`
1425	`<span class="md-ellipsis">`
1426
1427	`Step 2: Ingest a repo`
1428
1429	`</span>`
1430	`</a>`
1431
1432	`</li>`
1433
1434	`<li class="md-nav__item">`
1435	`<a href="#step-3-query-the-graph" class="md-nav__link">`
1436	`<span class="md-ellipsis">`
1437
1438	`Step 3: Query the graph`
1439
1440	`</span>`
1441	`</a>`
1442
1443	`</li>`
1444
1445	`<li class="md-nav__item">`
1446	`<a href="#step-4-add-business-knowledge" class="md-nav__link">`
1447	`<span class="md-ellipsis">`
1448
1449	`Step 4: Add business knowledge`
1450
1451	`</span>`
1452	`</a>`
1453
1454	`</li>`
1455
1456	`<li class="md-nav__item">`
1457	`<a href="#step-5-wire-an-agent-hook" class="md-nav__link">`
1458	`<span class="md-ellipsis">`
1459
1460	`Step 5: Wire an agent hook`
1461
1462	`</span>`
1463	`</a>`
1464
1465	`</li>`
1466
1467	`<li class="md-nav__item">`
1468	`<a href="#step-6-optional-sdk-quick-start" class="md-nav__link">`
1469	`<span class="md-ellipsis">`
1470
1471	`Step 6 (optional): SDK quick start`
1472
1473	`</span>`
1474	`</a>`
1475
1476	`</li>`
1477
1478	`<li class="md-nav__item">`
1479	`<a href="#step-7-optional-code-analysis" class="md-nav__link">`
1480	`<span class="md-ellipsis">`
1481
1482	`Step 7 (optional): Code analysis`
1483
1484	`</span>`
1485	`</a>`
1486
1487	`</li>`
1488
1489	`</ul>`
1490
1491	`</nav>`
1492	`</div>`
1493	`</div>`
1494	`</div>`
1495
1496
1497
1498	`<div class="md-content" data-md-component="content">`
1499
1500	`<article class="md-content__inner md-typeset">`
1501
1502
1503
1504
1505
1506
1507
1508
1509	`<h1 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">¶</a></h1>`
1510	`<p>This guide walks from a fresh install to a fully wired agent integration in five steps.</p>`
1511	`<hr />`
1512	`<h2 id="step-1-install">Step 1: Install<a class="headerlink" href="#step-1-install" title="Permanent link">¶</a></h2>`
1513	`<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>navegador`
1514	`<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>navegador<span class="w"> </span>--version`
1515	`</code></pre></div>`
1516	`<p>Python 3.12+ is required. For additional languages (Kotlin, C#, PHP, Ruby, Swift, C, C++) install the <code>[languages]</code> extra. See <a href="../installation/">Installation</a> for all extras and Redis setup.</p>`
1517	`<hr />`
1518	`<h2 id="step-2-ingest-a-repo">Step 2: Ingest a repo<a class="headerlink" href="#step-2-ingest-a-repo" title="Permanent link">¶</a></h2>`
1519	`<p>Point navegador at any local source tree:</p>`
1520	`<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>navegador<span class="w"> </span>ingest<span class="w"> </span>./my-repo`
1521	`</code></pre></div>`
1522	`<p>On first run this builds the graph from scratch. Re-run anytime to pick up changes. Use <code>--incremental</code> to skip files that haven't changed (based on content hashing — much faster on large repos):</p>`
1523	`<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>navegador<span class="w"> </span>ingest<span class="w"> </span>./my-repo<span class="w"> </span>--incremental`
1524	`</code></pre></div>`
1525	`<p>Use <code>--watch</code> to keep the graph in sync as files change:</p>`
1526	`<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>navegador<span class="w"> </span>ingest<span class="w"> </span>./my-repo<span class="w"> </span>--watch`
1527	`</code></pre></div>`
1528	`<p>Use <code>--clear</code> to wipe and rebuild from scratch:</p>`
1529	`<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>navegador<span class="w"> </span>ingest<span class="w"> </span>./my-repo<span class="w"> </span>--clear`
1530	`</code></pre></div>`
1531	`<p>Use <code>--json</code> to get a machine-readable summary of what was indexed:</p>`
1532	`<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>navegador<span class="w"> </span>ingest<span class="w"> </span>./my-repo<span class="w"> </span>--json`
1533	`</code></pre></div>`
1534	`<p>Navegador walks the tree, parses source files in 13 languages with tree-sitter, and writes nodes and edges for: files, modules, classes, functions, methods, imports, decorators, and call relationships. Framework enrichers automatically detect and annotate Django models, FastAPI routes, React components, Rails controllers, Spring Boot beans, and more.</p>`
1535	`<hr />`
1536	`<h2 id="step-3-query-the-graph">Step 3: Query the graph<a class="headerlink" href="#step-3-query-the-graph" title="Permanent link">¶</a></h2>`
1537	`<p><strong>Explain anything by name</strong> — works for functions, classes, files, concepts, rules, and decisions:</p>`
1538	`<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>navegador<span class="w"> </span>explain<span class="w"> </span>AuthService`
1539	`<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>navegador<span class="w"> </span>explain<span class="w"> </span>validate_token`
1540	`<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>navegador<span class="w"> </span>explain<span class="w"> </span>src/payments/processor.py`
1541	`</code></pre></div>`
1542	`<p><strong>Search across code and knowledge together:</strong></p>`
1543	`<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>navegador<span class="w"> </span>search<span class="w"> </span><span class="s2">"rate limit"</span><span class="w"> </span>--all`
1544	`<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>navegador<span class="w"> </span>search<span class="w"> </span><span class="s2">"authentication"</span><span class="w"> </span>--docs<span class="w"> </span>--limit<span class="w"> </span><span class="m">10</span>`
1545	`</code></pre></div>`
1546	`<p><strong>Inspect a function</strong> (callers, callees, decorators, source):</p>`
1547	`<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>navegador<span class="w"> </span><span class="k">function</span><span class="w"> </span>validate_token`
1548	`<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>navegador<span class="w"> </span><span class="k">function</span><span class="w"> </span>validate_token<span class="w"> </span>--depth<span class="w"> </span><span class="m">2</span><span class="w"> </span>--format<span class="w"> </span>json`
1549	`</code></pre></div>`
1550	`<p><strong>Inspect a class</strong> (hierarchy, methods, references):</p>`
1551	`<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>navegador<span class="w"> </span>class<span class="w"> </span>PaymentProcessor`
1552	`<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>navegador<span class="w"> </span>class<span class="w"> </span>PaymentProcessor<span class="w"> </span>--format<span class="w"> </span>json`
1553	`</code></pre></div>`
1554	`<hr />`
1555	`<h2 id="step-4-add-business-knowledge">Step 4: Add business knowledge<a class="headerlink" href="#step-4-add-business-knowledge" title="Permanent link">¶</a></h2>`
1556	`<p>Code alone doesn't capture <em>why</em>. Add concepts, rules, and decisions and link them to code.</p>`
1557	`<p><strong>Add a concept:</strong></p>`
1558	`<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>navegador<span class="w"> </span>add<span class="w"> </span>concept<span class="w"> </span><span class="s2">"Idempotency"</span><span class="w"> </span><span class="se">\</span>`
1559	`<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span>--desc<span class="w"> </span><span class="s2">"Operations that can be retried safely without side effects"</span><span class="w"> </span><span class="se">\</span>`
1560	`<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span>--domain<span class="w"> </span>Payments`
1561	`</code></pre></div>`
1562	`<p><strong>Add a rule:</strong></p>`
1563	`<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>navegador<span class="w"> </span>add<span class="w"> </span>rule<span class="w"> </span><span class="s2">"PaymentsMustBeIdempotent"</span><span class="w"> </span><span class="se">\</span>`
1564	`<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="w"> </span>--desc<span class="w"> </span><span class="s2">"All payment endpoints must handle duplicate submissions"</span><span class="w"> </span><span class="se">\</span>`
1565	`<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="w"> </span>--domain<span class="w"> </span>Payments<span class="w"> </span><span class="se">\</span>`
1566	`<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="w"> </span>--severity<span class="w"> </span>critical<span class="w"> </span><span class="se">\</span>`
1567	`<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="w"> </span>--rationale<span class="w"> </span><span class="s2">"Card networks retry on timeout; double-charging causes chargebacks"</span>`
1568	`</code></pre></div>`
1569	`<p><strong>Annotate code with a concept or rule:</strong></p>`
1570	`<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>navegador<span class="w"> </span>annotate<span class="w"> </span>process_payment<span class="w"> </span><span class="se">\</span>`
1571	`<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span>--type<span class="w"> </span>Function<span class="w"> </span><span class="se">\</span>`
1572	`<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span>--concept<span class="w"> </span>Idempotency<span class="w"> </span><span class="se">\</span>`
1573	`<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="w"> </span>--rule<span class="w"> </span>PaymentsMustBeIdempotent`
1574	`</code></pre></div>`
1575	`<p><strong>Add a decision:</strong></p>`
1576	`<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>navegador<span class="w"> </span>add<span class="w"> </span>decision<span class="w"> </span><span class="s2">"UseStripeForPayments"</span><span class="w"> </span><span class="se">\</span>`
1577	`<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span>--desc<span class="w"> </span><span class="s2">"Stripe is the primary payment processor"</span><span class="w"> </span><span class="se">\</span>`
1578	`<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="w"> </span>--domain<span class="w"> </span>Payments<span class="w"> </span><span class="se">\</span>`
1579	`<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w"> </span>--rationale<span class="w"> </span><span class="s2">"Best fraud tooling for SaaS"</span><span class="w"> </span><span class="se">\</span>`
1580	`<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="w"> </span>--alternatives<span class="w"> </span><span class="s2">"Braintree, Adyen"</span><span class="w"> </span><span class="se">\</span>`
1581	`<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="w"> </span>--date<span class="w"> </span><span class="m">2025</span>-01-15<span class="w"> </span><span class="se">\</span>`
1582	`<a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="w"> </span>--status<span class="w"> </span>accepted`
1583	`</code></pre></div>`
1584	`<p>Now <code>navegador explain process_payment</code> returns code structure <em>and</em> the rules that govern it.</p>`
1585	`<hr />`
1586	`<h2 id="step-5-wire-an-agent-hook">Step 5: Wire an agent hook<a class="headerlink" href="#step-5-wire-an-agent-hook" title="Permanent link">¶</a></h2>`
1587	`<p>Use the bootstrap script to ingest your repo and install the hook for your AI coding assistant in one command:</p>`
1588	`<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>./bootstrap.sh<span class="w"> </span>--repo<span class="w"> </span>owner/repo<span class="w"> </span>--wiki<span class="w"> </span>--agent<span class="w"> </span>claude`
1589	`</code></pre></div>`
1590	`<p>Options:</p>`
1591	`<table>`
1592	`<thead>`
1593	`<tr>`
1594	`<th>Flag</th>`
1595	`<th>Effect</th>`
1596	`</tr>`
1597	`</thead>`
1598	`<tbody>`
1599	`<tr>`
1600	`<td><code>--repo owner/repo</code></td>`
1601	`<td>GitHub repo to clone + ingest</td>`
1602	`</tr>`
1603	`<tr>`
1604	`<td><code>--wiki</code></td>`
1605	`<td>Also ingest the GitHub wiki</td>`
1606	`</tr>`
1607	`<tr>`
1608	`<td><code>--agent claude</code></td>`
1609	`<td>Install <code>.claude/hooks/claude-hook.py</code></td>`
1610	`</tr>`
1611	`<tr>`
1612	`<td><code>--agent gemini</code></td>`
1613	`<td>Install <code>.gemini/hooks/gemini-hook.py</code></td>`
1614	`</tr>`
1615	`<tr>`
1616	`<td><code>--agent openai</code></td>`
1617	`<td>Install <code>openai-hook.py</code> + <code>openai-tools.json</code></td>`
1618	`</tr>`
1619	`</tbody>`
1620	`</table>`
1621	`<p>After bootstrap, every file the agent edits triggers a re-ingest so the graph stays in sync. See <a href="../../guide/agent-hooks/">Agent Hooks</a> for manual setup and the <code>NAVEGADOR.md</code> template.</p>`
1622	`<hr />`
1623	`<h2 id="step-6-optional-sdk-quick-start">Step 6 (optional): SDK quick start<a class="headerlink" href="#step-6-optional-sdk-quick-start" title="Permanent link">¶</a></h2>`
1624	`<p>All CLI functionality is available through the Python SDK:</p>`
1625	`<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">navegador</span><span class="w"> </span><span class="kn">import</span> <span class="n">Navegador</span>`
1626	`<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>`
1627	`<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">nav</span> <span class="o">=</span> <span class="n">Navegador</span><span class="p">(</span><span class="s2">".navegador/navegador.db"</span><span class="p">)</span>`
1628	`<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>`
1629	`<a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="c1"># ingest (incremental by default in SDK)</span>`
1630	`<a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">nav</span><span class="o">.</span><span class="n">ingest</span><span class="p">(</span><span class="s2">"./my-repo"</span><span class="p">,</span> <span class="n">incremental</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>`
1631	`<a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a>`
1632	`<a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="c1"># query</span>`
1633	`<a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a><span class="n">bundle</span> <span class="o">=</span> <span class="n">nav</span><span class="o">.</span><span class="n">explain</span><span class="p">(</span><span class="s2">"AuthService"</span><span class="p">)</span>`
1634	`<a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a><span class="nb">print</span><span class="p">(</span><span class="n">bundle</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">())</span>`
1635	`<a id="__codelineno-15-11" name="__codelineno-15-11" href="#__codelineno-15-11"></a>`
1636	`<a id="__codelineno-15-12" name="__codelineno-15-12" href="#__codelineno-15-12"></a><span class="c1"># analysis</span>`
1637	`<a id="__codelineno-15-13" name="__codelineno-15-13" href="#__codelineno-15-13"></a><span class="n">impact</span> <span class="o">=</span> <span class="n">nav</span><span class="o">.</span><span class="n">impact</span><span class="p">(</span><span class="s2">"validate_token"</span><span class="p">)</span>`
1638	`<a id="__codelineno-15-14" name="__codelineno-15-14" href="#__codelineno-15-14"></a><span class="n">churn</span> <span class="o">=</span> <span class="n">nav</span><span class="o">.</span><span class="n">churn</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">30</span><span class="p">)</span>`
1639	`<a id="__codelineno-15-15" name="__codelineno-15-15" href="#__codelineno-15-15"></a><span class="n">cycles</span> <span class="o">=</span> <span class="n">nav</span><span class="o">.</span><span class="n">cycles</span><span class="p">()</span>`
1640	`</code></pre></div>`
1641	`<p>The <code>Navegador</code> class wraps <code>GraphStore</code>, <code>ContextLoader</code>, all ingesters, and the analysis commands into one interface.</p>`
1642	`<hr />`
1643	`<h2 id="step-7-optional-code-analysis">Step 7 (optional): Code analysis<a class="headerlink" href="#step-7-optional-code-analysis" title="Permanent link">¶</a></h2>`
1644	`<p>Once the graph is populated, use the analysis commands to understand your codebase:</p>`
1645	`<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="c1"># impact of changing a function</span>`
1646	`<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>navegador<span class="w"> </span>impact<span class="w"> </span>validate_token`
1647	`<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a>`
1648	`<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="c1"># trace execution flow</span>`
1649	`<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a>navegador<span class="w"> </span>trace<span class="w"> </span>process_payment<span class="w"> </span>--depth<span class="w"> </span><span class="m">3</span>`
1650	`<a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a>`
1651	`<a id="__codelineno-16-7" name="__codelineno-16-7" href="#__codelineno-16-7"></a><span class="c1"># find dead code</span>`
1652	`<a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a>navegador<span class="w"> </span>deadcode`
1653	`<a id="__codelineno-16-9" name="__codelineno-16-9" href="#__codelineno-16-9"></a>`
1654	`<a id="__codelineno-16-10" name="__codelineno-16-10" href="#__codelineno-16-10"></a><span class="c1"># detect dependency cycles</span>`
1655	`<a id="__codelineno-16-11" name="__codelineno-16-11" href="#__codelineno-16-11"></a>navegador<span class="w"> </span>cycles`
1656	`<a id="__codelineno-16-12" name="__codelineno-16-12" href="#__codelineno-16-12"></a>`
1657	`<a id="__codelineno-16-13" name="__codelineno-16-13" href="#__codelineno-16-13"></a><span class="c1"># map tests to source files</span>`
1658	`<a id="__codelineno-16-14" name="__codelineno-16-14" href="#__codelineno-16-14"></a>navegador<span class="w"> </span>testmap`
1659	`<a id="__codelineno-16-15" name="__codelineno-16-15" href="#__codelineno-16-15"></a>`
1660	`<a id="__codelineno-16-16" name="__codelineno-16-16" href="#__codelineno-16-16"></a><span class="c1"># code churn (files that change most)</span>`
1661	`<a id="__codelineno-16-17" name="__codelineno-16-17" href="#__codelineno-16-17"></a>navegador<span class="w"> </span>churn<span class="w"> </span>--days<span class="w"> </span><span class="m">30</span>`
1662	`<a id="__codelineno-16-18" name="__codelineno-16-18" href="#__codelineno-16-18"></a>`
1663	`<a id="__codelineno-16-19" name="__codelineno-16-19" href="#__codelineno-16-19"></a><span class="c1"># diff — what changed between two refs</span>`
1664	`<a id="__codelineno-16-20" name="__codelineno-16-20" href="#__codelineno-16-20"></a>navegador<span class="w"> </span>diff<span class="w"> </span>HEAD~1<span class="w"> </span>HEAD`
1665	`</code></pre></div>`
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679	`</article>`
1680	`</div>`
1681
1682
1683	`<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>`
1684
1685	`<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>`
1686	`</div>`
1687
1688	`<button type="button" class="md-top md-icon" data-md-component="top" hidden>`
1689
1690	`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>`
1691	`Back to top`
1692	`</button>`
1693
1694	`</main>`
1695
1696	`<footer class="md-footer">`
1697
1698	`<div class="md-footer-meta md-typeset">`
1699	`<div class="md-footer-meta__inner md-grid">`
1700	`<div class="md-copyright">`
1701
1702	`<div class="md-copyright__highlight">`
1703	`Copyright © 2026 CONFLICT LLC`
1704	`</div>`
1705
1706
1707	`Made with`
1708	`<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">`
1709	`Material for MkDocs`
1710	`</a>`
1711
1712	`</div>`
1713
1714
1715	`<div class="md-social">`
1716
1717
1718
1719
1720
1721
1722
1723
1724	`<a href="https://github.com/ConflictHQ/navegador" target="_blank" rel="noopener" title="github.com" class="md-social__link">`
1725	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
1726	`</a>`
1727
1728	`</div>`
1729
1730	`</div>`
1731	`</div>`
1732	`</footer>`
1733
1734	`</div>`
1735	`<div class="md-dialog" data-md-component="dialog">`
1736	`<div class="md-dialog__inner md-typeset"></div>`
1737	`</div>`
1738
1739
1740
1741
1742
1743	<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
1744
1745
1746	`<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>`
1747
1748
1749	`</body>`
1750	`</html>`

Navegador

Keyboard Shortcuts