-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
1946 lines (1737 loc) · 78.6 KB
/
Copy pathindex.html
File metadata and controls
1946 lines (1737 loc) · 78.6 KB
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>doora — Documentation(Maps)</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Instrument+Serif:ital@0;1&family=DM+Mono:wght@400;500&family=Syne:wght@400;500;600;700&display=swap" rel="stylesheet">
<style>
*,*::before,*::after{box-sizing:border-box;margin:0;padding:0}
:root{
--ink:#0d0d0d;
--ink-2:#3a3a3a;
--ink-3:#6b6b6b;
--ink-4:#9a9a9a;
--paper:#fafaf7;
--paper-2:#f2f2ed;
--paper-3:#e8e8e1;
--accent:#1a3a2a;
--accent-2:#2d6b4a;
--accent-light:#d4ede0;
--accent-pale:#eef7f2;
--mono:#1e1e1e;
--code-bg:#f0f0eb;
--rule:#d0d0c8;
--warn:#7a4a00;
--warn-bg:#fff8ec;
--serif:'Instrument Serif',Georgia,serif;
--sans:'Syne',sans-serif;
--mono-font:'DM Mono',monospace;
--sidebar:260px;
--content:720px;
}
html{scroll-behavior:smooth;font-size:16px}
body{
background:var(--paper);
color:var(--ink);
font-family:var(--sans);
font-weight:400;
line-height:1.7;
display:flex;
min-height:100vh;
}
/* ── Sidebar ── */
#sidebar{
width:var(--sidebar);
min-height:100vh;
background:var(--paper-2);
border-right:1px solid var(--rule);
position:sticky;
top:0;
height:100vh;
overflow-y:auto;
flex-shrink:0;
padding:0 0 3rem 0;
}
.sidebar-logo{
padding:1.75rem 1.5rem 1.25rem;
border-bottom:1px solid var(--rule);
margin-bottom:0.75rem;
}
.sidebar-logo .brand{
font-family:var(--mono-font);
font-size:1.1rem;
font-weight:500;
color:var(--accent);
letter-spacing:-0.01em;
}
.sidebar-logo .tagline{
font-size:0.72rem;
color:var(--ink-3);
margin-top:0.2rem;
letter-spacing:0.04em;
text-transform:uppercase;
}
.nav-section{
padding:0.5rem 1.5rem 0.25rem;
font-size:0.67rem;
font-weight:600;
color:var(--ink-4);
letter-spacing:0.1em;
text-transform:uppercase;
margin-top:0.75rem;
}
.nav-link{
display:block;
padding:0.3rem 1.5rem 0.3rem 1.75rem;
font-size:0.82rem;
color:var(--ink-2);
text-decoration:none;
transition:all 0.15s;
border-left:2px solid transparent;
margin-left:-2px;
}
.nav-link:hover{color:var(--accent);background:var(--accent-pale)}
.nav-link.active{color:var(--accent);border-left-color:var(--accent-2);background:var(--accent-pale);font-weight:500}
.nav-sub{
padding-left:2.5rem;
font-size:0.77rem;
color:var(--ink-3);
}
/* ── Main content ── */
#main{
flex:1;
max-width:calc(var(--content) + 8rem);
margin:0 auto;
padding:3rem 4rem 6rem;
}
/* ── Hero ── */
.hero{
padding:3.5rem 0 3rem;
border-bottom:1px solid var(--rule);
margin-bottom:3rem;
}
.hero-eyebrow{
font-size:0.72rem;
font-weight:600;
letter-spacing:0.12em;
text-transform:uppercase;
color:var(--accent-2);
margin-bottom:1rem;
}
.hero h1{
font-family:var(--serif);
font-size:3.2rem;
font-weight:400;
line-height:1.15;
color:var(--ink);
letter-spacing:-0.02em;
margin-bottom:1.25rem;
}
.hero h1 em{color:var(--accent-2);font-style:italic}
.hero-desc{
font-size:1.1rem;
color:var(--ink-2);
max-width:580px;
line-height:1.75;
margin-bottom:1.75rem;
}
.hero-badges{display:flex;gap:0.5rem;flex-wrap:wrap;margin-bottom:2rem}
.badge{
font-family:var(--mono-font);
font-size:0.72rem;
font-weight:500;
padding:0.25rem 0.6rem;
border-radius:3px;
border:1px solid var(--rule);
color:var(--ink-2);
background:var(--paper);
}
.badge.green{border-color:#a8d5b8;color:var(--accent);background:var(--accent-pale)}
.badge.mono{background:var(--mono);color:#e0e0e0;border-color:var(--mono)}
.hero-install{
background:var(--mono);
color:#e8e8e8;
font-family:var(--mono-font);
font-size:0.85rem;
padding:0.9rem 1.25rem;
border-radius:6px;
display:inline-flex;
align-items:center;
gap:0.75rem;
}
.hero-install .prompt{color:#888;user-select:none}
/* ── Section headings ── */
.section{margin-bottom:3.5rem}
h2{
font-family:var(--serif);
font-size:1.9rem;
font-weight:400;
color:var(--ink);
letter-spacing:-0.015em;
margin-bottom:0.5rem;
padding-top:0.5rem;
}
h2 .num{
font-family:var(--mono-font);
font-size:0.85rem;
color:var(--accent-2);
margin-right:0.5rem;
font-weight:500;
}
h3{
font-size:1rem;
font-weight:600;
color:var(--ink);
margin:1.75rem 0 0.6rem;
letter-spacing:0.01em;
}
h4{
font-size:0.9rem;
font-weight:600;
color:var(--ink-2);
margin:1.25rem 0 0.4rem;
text-transform:uppercase;
letter-spacing:0.05em;
}
.section-intro{
font-size:0.95rem;
color:var(--ink-2);
margin-bottom:1.5rem;
line-height:1.8;
max-width:640px;
border-bottom:1px solid var(--rule);
padding-bottom:1.25rem;
}
p{margin-bottom:1rem;font-size:0.95rem;color:var(--ink-2);line-height:1.8}
li{font-size:0.95rem;color:var(--ink-2);line-height:1.8;margin-bottom:0.3rem}
ul,ol{padding-left:1.5rem;margin-bottom:1rem}
strong{font-weight:600;color:var(--ink)}
/* ── Code blocks ── */
pre{
background:var(--code-bg);
border:1px solid var(--rule);
border-radius:6px;
padding:1.1rem 1.25rem;
overflow-x:auto;
margin:1rem 0 1.25rem;
font-family:var(--mono-font);
font-size:0.82rem;
line-height:1.6;
color:var(--mono);
}
code{
font-family:var(--mono-font);
font-size:0.82em;
background:var(--code-bg);
border:1px solid var(--rule);
border-radius:3px;
padding:0.1em 0.35em;
color:var(--mono);
}
pre code{background:none;border:none;padding:0;font-size:1em}
.comment{color:#6b7280}
.keyword{color:#065f46}
.string{color:#78350f}
.fn-name{color:#1e40af}
.type{color:#7c3aed}
/* ── Tables ── */
table{
width:100%;
border-collapse:collapse;
font-size:0.88rem;
margin:1rem 0 1.5rem;
}
th{
background:var(--paper-2);
font-weight:600;
font-size:0.78rem;
text-transform:uppercase;
letter-spacing:0.06em;
color:var(--ink-3);
padding:0.6rem 0.9rem;
border:1px solid var(--rule);
text-align:left;
}
td{
padding:0.55rem 0.9rem;
border:1px solid var(--rule);
color:var(--ink-2);
vertical-align:top;
}
tr:nth-child(even) td{background:var(--paper-2)}
/* ── Callouts ── */
.callout{
border-left:3px solid var(--accent-2);
background:var(--accent-pale);
padding:0.9rem 1.1rem;
border-radius:0 6px 6px 0;
margin:1.25rem 0;
}
.callout.warn{
border-left-color:#b45309;
background:var(--warn-bg);
}
.callout p{margin:0;font-size:0.88rem}
.callout-title{font-weight:600;font-size:0.78rem;letter-spacing:0.06em;text-transform:uppercase;margin-bottom:0.3rem;color:var(--accent)}
.callout.warn .callout-title{color:var(--warn)}
/* ── Pipeline diagram ── */
.pipeline{
display:flex;
align-items:center;
gap:0;
margin:1.5rem 0;
overflow-x:auto;
padding:1rem 0;
}
.pipe-step{
background:var(--paper-2);
border:1px solid var(--rule);
border-radius:6px;
padding:0.6rem 0.9rem;
font-size:0.78rem;
font-weight:600;
color:var(--ink);
white-space:nowrap;
text-align:center;
min-width:100px;
}
.pipe-step .step-sub{font-weight:400;color:var(--ink-3);font-size:0.7rem;display:block;margin-top:0.1rem}
.pipe-arrow{
color:var(--ink-4);
font-size:0.9rem;
padding:0 0.3rem;
flex-shrink:0;
}
.pipe-step.highlight{
background:var(--accent-pale);
border-color:var(--accent-2);
color:var(--accent);
}
/* ── Feature grid ── */
.feature-grid{
display:grid;
grid-template-columns:repeat(auto-fit,minmax(200px,1fr));
gap:1rem;
margin:1.25rem 0;
}
.feature-card{
background:var(--paper);
border:1px solid var(--rule);
border-radius:8px;
padding:1.1rem 1.1rem 1rem;
}
.feature-card .icon{
font-size:1.3rem;
margin-bottom:0.6rem;
display:block;
}
.feature-card h4{
font-size:0.85rem;
font-weight:600;
color:var(--ink);
margin:0 0 0.4rem;
text-transform:none;
letter-spacing:0;
}
.feature-card p{font-size:0.82rem;color:var(--ink-3);margin:0;line-height:1.6}
/* ── CLI reference ── */
.cli-block{
background:var(--mono);
border-radius:6px;
overflow:hidden;
margin:1rem 0;
}
.cli-header{
background:#1a1a1a;
padding:0.5rem 1rem;
font-family:var(--mono-font);
font-size:0.72rem;
color:#666;
letter-spacing:0.05em;
}
.cli-body{
padding:1rem 1.25rem;
font-family:var(--mono-font);
font-size:0.82rem;
line-height:1.9;
color:#d4d4d4;
}
.cli-body .cmd{color:#86efac}
.cli-body .flag{color:#93c5fd}
.cli-body .val{color:#fcd34d}
.cli-body .cmt{color:#6b7280}
.cli-body .out{color:#d4d4d4}
/* ── Arg table ── */
.arg-table{width:100%;border-collapse:collapse;font-size:0.85rem;margin:1rem 0}
.arg-table th{background:var(--paper-2);padding:0.5rem 0.75rem;border:1px solid var(--rule);font-size:0.73rem;font-weight:600;text-transform:uppercase;letter-spacing:0.06em;color:var(--ink-3)}
.arg-table td{padding:0.6rem 0.75rem;border:1px solid var(--rule);vertical-align:top}
.arg-table tr:nth-child(even) td{background:var(--paper-2)}
.arg-flag{font-family:var(--mono-font);font-size:0.8rem;white-space:nowrap;font-weight:500}
.arg-type{font-family:var(--mono-font);font-size:0.78rem;color:var(--accent-2)}
.arg-default{font-family:var(--mono-font);font-size:0.78rem;color:var(--ink-3)}
.arg-desc{font-size:0.85rem;color:var(--ink-2)}
/* ── Query example cards ── */
.query-card{
border:1px solid var(--rule);
border-radius:8px;
overflow:hidden;
margin:1rem 0;
}
.query-card-header{
background:var(--paper-2);
padding:0.6rem 1rem;
font-size:0.8rem;
font-weight:600;
color:var(--ink);
border-bottom:1px solid var(--rule);
display:flex;
align-items:center;
gap:0.5rem;
}
.query-card-header .lang-badge{
font-family:var(--mono-font);
font-size:0.68rem;
padding:0.15rem 0.45rem;
background:var(--accent-pale);
color:var(--accent);
border-radius:3px;
border:1px solid var(--accent-light);
}
.query-card pre{margin:0;border:none;border-radius:0;background:var(--code-bg);border-top:none}
.query-card .query-desc{
padding:0.6rem 1rem;
font-size:0.82rem;
color:var(--ink-3);
border-top:1px solid var(--rule);
background:var(--paper);
}
/* ── Architecture box ── */
.arch-diagram{
border:1px solid var(--rule);
border-radius:8px;
overflow:hidden;
margin:1.5rem 0;
}
.arch-header{
background:var(--paper-2);
padding:0.6rem 1rem;
font-size:0.78rem;
font-weight:600;
color:var(--ink-3);
letter-spacing:0.05em;
text-transform:uppercase;
border-bottom:1px solid var(--rule);
}
.arch-body{
font-family:var(--mono-font);
font-size:0.8rem;
padding:1.25rem 1.5rem;
line-height:1.85;
background:var(--paper);
color:var(--ink-2);
}
.arch-body .box{color:var(--accent-2);font-weight:500}
.arch-body .arrow{color:var(--ink-4)}
.arch-body .label{color:var(--ink-3)}
/* ── Performance table ── */
.perf-num{font-family:var(--mono-font);font-weight:500;color:var(--accent)}
/* ── Module cards ── */
.module-grid{
display:grid;
grid-template-columns:repeat(auto-fit,minmax(280px,1fr));
gap:1rem;
margin:1.25rem 0;
}
.module-card{
border:1px solid var(--rule);
border-radius:8px;
padding:1.1rem;
background:var(--paper);
}
.module-card .module-name{
font-family:var(--mono-font);
font-size:0.9rem;
font-weight:500;
color:var(--accent);
margin-bottom:0.35rem;
}
.module-card .module-file{
font-family:var(--mono-font);
font-size:0.72rem;
color:var(--ink-4);
margin-bottom:0.6rem;
}
.module-card .module-desc{
font-size:0.83rem;
color:var(--ink-2);
line-height:1.65;
margin:0;
}
/* ── Index pipeline ── */
.index-flow{
display:grid;
grid-template-columns:1fr;
gap:0.5rem;
margin:1.25rem 0;
}
.index-step{
display:flex;
align-items:flex-start;
gap:0.75rem;
padding:0.7rem 0.9rem;
border:1px solid var(--rule);
border-radius:6px;
background:var(--paper);
}
.index-step-num{
font-family:var(--mono-font);
font-size:0.72rem;
font-weight:500;
background:var(--accent-pale);
color:var(--accent);
border:1px solid var(--accent-light);
border-radius:3px;
padding:0.15rem 0.4rem;
flex-shrink:0;
margin-top:0.1rem;
}
.index-step-content .title{font-size:0.88rem;font-weight:600;color:var(--ink);margin-bottom:0.15rem}
.index-step-content .desc{font-size:0.82rem;color:var(--ink-3);margin:0;line-height:1.55}
/* ── MCP section ── */
.mcp-box{
border:1px solid var(--accent-light);
border-radius:8px;
background:var(--accent-pale);
padding:1.25rem 1.4rem;
margin:1.25rem 0;
}
.mcp-box h4{color:var(--accent);text-transform:none;letter-spacing:0;font-size:0.9rem;margin:0 0 0.5rem}
.mcp-box p{font-size:0.88rem;color:var(--accent);opacity:0.85;margin:0 0 0.75rem}
.mcp-box pre{background:var(--accent-light);border-color:var(--accent-light);color:var(--accent)}
/* ── Scrollbar ── */
#sidebar::-webkit-scrollbar{width:4px}
#sidebar::-webkit-scrollbar-track{background:transparent}
#sidebar::-webkit-scrollbar-thumb{background:var(--rule);border-radius:2px}
/* ── Responsive ── */
@media(max-width:900px){
#sidebar{display:none}
#main{padding:2rem 1.5rem 4rem}
.hero h1{font-size:2.2rem}
.pipeline{flex-direction:column;align-items:flex-start}
.pipe-arrow{transform:rotate(90deg)}
}
hr.section-rule{border:none;border-top:1px solid var(--rule);margin:3rem 0}
/* ── Anchor offsets for sticky nav ── */
.anchor{display:block;position:relative;top:-80px;visibility:hidden}
</style>
</head>
<body>
<!-- SIDEBAR -->
<nav id="sidebar" aria-label="Documentation navigation">
<div class="sidebar-logo">
<div class="brand">doora</div>
<div class="tagline">Structural Code Search</div>
</div>
<div class="nav-section">Getting Started</div>
<a class="nav-link" href="#overview">Overview</a>
<a class="nav-link" href="#installation">Installation</a>
<a class="nav-link" href="#quickstart">Quick start</a>
<div class="nav-section">Core Concepts</div>
<a class="nav-link" href="#why-structural">Why structural search</a>
<a class="nav-link" href="#how-ast-works">How AST search works</a>
<a class="nav-link" href="#query-syntax">Query syntax</a>
<div class="nav-section">CLI Reference</div>
<a class="nav-link" href="#cli-search">search command</a>
<a class="nav-link" href="#cli-index">index command</a>
<a class="nav-link" href="#cli-flags">all flags</a>
<a class="nav-link" href="#cli-completions">shell completions</a>
<div class="nav-section">Query Guide</div>
<a class="nav-link" href="#query-basics">Basics</a>
<a class="nav-link" href="#query-predicates">Predicates</a>
<a class="nav-link" href="#query-captures">Captures</a>
<a class="nav-link" href="#query-examples">Examples by language</a>
<div class="nav-section">Languages</div>
<a class="nav-link" href="#lang-rust">Rust</a>
<a class="nav-link" href="#lang-python">Python</a>
<a class="nav-link" href="#lang-js">JavaScript</a>
<a class="nav-link" href="#lang-ts">TypeScript</a>
<a class="nav-link" href="#lang-go">Go</a>
<a class="nav-link" href="#lang-c">C / C++</a>
<a class="nav-link" href="#lang-auto">Auto-detection</a>
<div class="nav-section">Features</div>
<a class="nav-link" href="#bloom-index">Bloom filter index</a>
<a class="nav-link" href="#rewriting">Semantic rewriting</a>
<a class="nav-link" href="#tui">Interactive TUI</a>
<a class="nav-link" href="#mcp">MCP server</a>
<div class="nav-section">Architecture</div>
<a class="nav-link" href="#pipeline">Pipeline overview</a>
<a class="nav-link" href="#modules">Module reference</a>
<a class="nav-link" href="#concurrency">Concurrency model</a>
<a class="nav-link" href="#memory">Memory model</a>
<a class="nav-link" href="#perf">Performance</a>
<div class="nav-section">Development</div>
<a class="nav-link" href="#building">Building</a>
<a class="nav-link" href="#testing">Testing</a>
<a class="nav-link" href="#benchmarks">Benchmarks</a>
<a class="nav-link" href="#contributing">Contributing</a>
</nav>
<!-- MAIN CONTENT -->
<main id="main">
<!-- HERO -->
<div class="hero">
<div class="hero-eyebrow">Documentation · v0.1.0</div>
<h1>doora<br><em>Search code by shape,<br>not by text.</em></h1>
<p class="hero-desc">
A high-performance structural code search engine built on Tree-sitter. Where grep sees a flat river of bytes, doora sees a grammar — functions, types, scopes, and relationships.
</p>
<div class="hero-badges">
<span class="badge green">Rust</span>
<span class="badge">Tree-sitter</span>
<span class="badge">7 languages</span>
<span class="badge">MCP server</span>
<span class="badge">Rayon parallel</span>
<span class="badge green">Bloom filter index</span>
</div>
<div class="hero-install">
<span class="prompt">$</span>
<span>cargo install doora</span>
</div>
</div>
<!-- OVERVIEW -->
<span class="anchor" id="overview"></span>
<div class="section">
<h2><span class="num">01</span>Overview</h2>
<p class="section-intro">
doora is a command-line tool that parses source files into Abstract Syntax Trees and executes structural pattern queries against them. It is fundamentally different from text search: it understands the grammar of your code, not just its characters.
</p>
<p>Every text-based search tool — grep, ripgrep, ack — treats source code as a string. They cannot tell the difference between a function <em>named</em> <code>authenticate</code> and a comment that <em>mentions</em> <code>authenticate</code>. They cannot find "all functions that take exactly two arguments" or "all <code>unwrap()</code> calls outside test modules."</p>
<p>doora answers all of these queries instantly, across millions of lines of code, using Tree-sitter's incremental parsing library at its core.</p>
<div class="feature-grid">
<div class="feature-card">
<span class="icon">⬡</span>
<h4>Structural patterns</h4>
<p>Find code by its syntactic shape using Tree-sitter S-expression queries.</p>
</div>
<div class="feature-card">
<span class="icon">⚡</span>
<h4>Parallel processing</h4>
<p>Lock-free work-stealing thread pool via Rayon. Scales to all available cores.</p>
</div>
<div class="feature-card">
<span class="icon">◈</span>
<h4>7 languages</h4>
<p>Rust, Python, JavaScript, TypeScript, Go, C, and C++ with auto-detection.</p>
</div>
<div class="feature-card">
<span class="icon">◎</span>
<h4>Bloom filter index</h4>
<p>Pre-reject files that cannot possibly match before invoking the parser.</p>
</div>
<div class="feature-card">
<span class="icon">↺</span>
<h4>Semantic rewriting</h4>
<p>Replace structural patterns without corrupting surrounding syntax.</p>
</div>
<div class="feature-card">
<span class="icon">⬖</span>
<h4>MCP server</h4>
<p>Expose codebase structure to LLM agents via the Model Context Protocol.</p>
</div>
</div>
</div>
<hr class="section-rule">
<!-- INSTALLATION -->
<span class="anchor" id="installation"></span>
<div class="section">
<h2><span class="num">02</span>Installation</h2>
<p class="section-intro">doora is distributed as a single static binary. Install via Cargo, download a pre-built binary, or build from source.</p>
<h3>From crates.io</h3>
<pre><span class="comment"># Requires Rust 1.78+</span>
cargo install doora</pre>
<h3>Pre-built binaries</h3>
<p>Download from the <a href="https://github.com/backpack-lab/doora/releases">Releases page</a>. Binaries are available for:</p>
<table>
<thead><tr><th>Platform</th><th>Architecture</th><th>Binary</th></tr></thead>
<tbody>
<tr><td>Linux</td><td>x86_64</td><td><code>doora-x86_64-unknown-linux-gnu</code></td></tr>
<tr><td>Linux</td><td>aarch64</td><td><code>doora-aarch64-unknown-linux-gnu</code></td></tr>
<tr><td>macOS</td><td>x86_64</td><td><code>doora-x86_64-apple-darwin</code></td></tr>
<tr><td>macOS</td><td>Apple Silicon</td><td><code>doora-aarch64-apple-darwin</code></td></tr>
<tr><td>Windows</td><td>x86_64</td><td><code>doora-x86_64-pc-windows-msvc.exe</code></td></tr>
</tbody>
</table>
<h3>From source</h3>
<pre>git clone https://github.com/backpack-lab/doora
cd doora
cargo build --release
<span class="comment"># Binary at ./target/release/doora</span></pre>
<h3>Shell completions</h3>
<pre><span class="comment"># Bash</span>
doora --generate-completions bash >> ~/.bashrc
<span class="comment"># Zsh</span>
doora --generate-completions zsh >> ~/.zshrc
<span class="comment"># Fish</span>
doora --generate-completions fish > ~/.config/fish/completions/doora.fish</pre>
</div>
<hr class="section-rule">
<!-- QUICKSTART -->
<span class="anchor" id="quickstart"></span>
<div class="section">
<h2><span class="num">03</span>Quick start</h2>
<p class="section-intro">Run your first structural query in under 60 seconds.</p>
<h3>Find all function definitions</h3>
<div class="cli-block">
<div class="cli-header">terminal</div>
<div class="cli-body">
<span class="cmd">doora</span> <span class="flag">-q</span> <span class="val">'(function_item name: (identifier) @fn_name)'</span> <span class="flag">-p</span> <span class="val">./src</span><br><br>
<span class="out">src/auth/handler.rs:42:0 [@fn_name] "parse_token"</span><br>
<span class="out">src/auth/handler.rs:89:0 [@fn_name] "validate_session"</span><br>
<span class="out">src/db/pool.rs:14:0 [@fn_name] "connect"</span><br>
<span class="out">...</span><br><br>
<span class="cmt">Found 47 matches across 23 files in 38ms</span>
</div>
</div>
<h3>Find a specific function by name</h3>
<pre>doora \
-q '(function_item name: (identifier) @fn (#eq? @fn "connect"))' \
-p ./src</pre>
<h3>Search multiple languages at once</h3>
<pre>doora \
-q '(function_declaration name: (identifier) @fn_name)' \
-p ./src
<span class="comment"># auto-detects language per file</span></pre>
<h3>Multiple queries in one pass</h3>
<pre>doora \
-q '(function_item name: (identifier) @fn_name)' \
-q '(struct_item name: (type_identifier) @struct_name)' \
-p ./src --no-color</pre>
<h3>Launch the interactive TUI</h3>
<pre>doora -q '(function_item)' -p . --tui</pre>
<h3>Build a search index for faster queries</h3>
<pre>doora index ./src --verbose
<span class="comment"># Subsequent searches use Bloom filter pre-rejection</span></pre>
</div>
<hr class="section-rule">
<!-- WHY STRUCTURAL -->
<span class="anchor" id="why-structural"></span>
<div class="section">
<h2><span class="num">04</span>Why structural search</h2>
<p class="section-intro">Text search has fundamental limitations that no amount of regex cleverness can overcome. Structural search solves them categorically.</p>
<table>
<thead><tr><th>Query</th><th>grep / ripgrep</th><th>doora</th></tr></thead>
<tbody>
<tr>
<td>Find function definitions named <code>auth_user</code></td>
<td>Returns ALL occurrences — function defs, variable names, comments, string literals, dead code</td>
<td>Returns only function definition nodes named <code>auth_user</code></td>
</tr>
<tr>
<td>Find functions taking exactly 2 arguments</td>
<td>Cannot be expressed reliably in regex</td>
<td>Trivial: query the parameter list node child count</td>
</tr>
<tr>
<td>Find all <code>unwrap()</code> outside test modules</td>
<td>Cannot express scope constraints</td>
<td>Query for call sites with scope predicates</td>
</tr>
<tr>
<td>Find struct definitions that implement a trait</td>
<td>Multi-step, fragile, many false positives</td>
<td>Single S-expression query</td>
</tr>
<tr>
<td>Rename a function everywhere it is defined</td>
<td>Risk of corrupting string literals and comments</td>
<td>Semantic rewriting via AST: only actual definition nodes</td>
</tr>
</tbody>
</table>
<div class="callout">
<div class="callout-title">The key insight</div>
<p>doora is to grep what a SQL database is to a flat text file. Both store the same data; one understands its structure.</p>
</div>
</div>
<hr class="section-rule">
<!-- HOW AST WORKS -->
<span class="anchor" id="how-ast-works"></span>
<div class="section">
<h2><span class="num">05</span>How AST search works</h2>
<p class="section-intro">Source code has grammar. Every language defines how tokens nest into expressions, expressions into statements, and statements into functions and modules. doora makes this grammar queryable.</p>
<h3>From bytes to tree</h3>
<p>Consider this Rust function:</p>
<pre><span class="keyword">fn</span> <span class="fn-name">authenticate</span>(user: &<span class="type">str</span>, password: &<span class="type">str</span>) -> <span class="type">bool</span> {
<span class="keyword">true</span>
}</pre>
<p>Tree-sitter parses this into a Concrete Syntax Tree (CST):</p>
<div class="arch-diagram">
<div class="arch-header">Syntax tree structure</div>
<div class="arch-body">
<span class="box">source_file</span><br>
<span class="arrow">└─</span> <span class="box">function_item</span><br>
<span class="arrow">├─</span> <span class="box">name: identifier</span> <span class="label">"authenticate"</span><br>
<span class="arrow">├─</span> <span class="box">parameters: parameters</span><br>
│ <span class="arrow">├─</span> <span class="box">parameter</span><br>
│ │ <span class="arrow">├─</span> <span class="box">pattern: identifier</span> <span class="label">"user"</span><br>
│ │ <span class="arrow">└─</span> <span class="box">type: reference_type</span><br>
│ <span class="arrow">└─</span> <span class="box">parameter</span><br>
│ <span class="arrow">├─</span> <span class="box">pattern: identifier</span> <span class="label">"password"</span><br>
│ <span class="arrow">└─</span> <span class="box">type: reference_type</span><br>
<span class="arrow">├─</span> <span class="box">return_type: primitive_type</span> <span class="label">"bool"</span><br>
<span class="arrow">└─</span> <span class="box">body: block</span>
</div>
</div>
<p>An S-expression query navigates this tree structure. The query <code>(function_item name: (identifier) @fn)</code> matches any <code>function_item</code> node that has a <code>name</code> child of type <code>identifier</code>, and captures that identifier as <code>@fn</code>.</p>
<h3>CST vs AST</h3>
<p>Traditional compilers produce Abstract Syntax Trees (ASTs) that discard whitespace, comments, and punctuation. doora uses Concrete Syntax Trees (CSTs) that retain 100% fidelity to the original source — including exact byte offsets for every token. This is required for:</p>
<ul>
<li>Accurately mapping matches back to line and column numbers for display</li>
<li>Semantic rewriting that preserves the user's original formatting</li>
<li>Syntax highlighting driven by the tree itself rather than regex</li>
</ul>
</div>
<hr class="section-rule">
<!-- QUERY SYNTAX -->
<span class="anchor" id="query-syntax"></span>
<div class="section">
<h2><span class="num">06</span>Query syntax overview</h2>
<p class="section-intro">Queries use Tree-sitter's S-expression pattern syntax — a Lisp-like notation that mirrors the shape of the syntax tree.</p>
<h3>Basic node match</h3>
<pre>(node_type)</pre>
<p>Matches any node of the given type anywhere in the tree. Node type names are grammar-specific — see the language sections for common types.</p>
<h3>Named capture</h3>
<pre>(function_item name: (identifier) @my_capture)</pre>
<p>The <code>@my_capture</code> syntax tags a sub-node for extraction. Captured text appears in the output. Multiple captures per query are supported.</p>
<h3>Equality predicate</h3>
<pre>(function_item
name: (identifier) @fn
(#eq? @fn "connect"))</pre>
<p>Matches only when the captured node's text equals <code>"connect"</code> exactly.</p>
<h3>Regex predicate</h3>
<pre>(function_item
name: (identifier) @fn
(#match? @fn "^(get|set|update)_"))</pre>
<p>Matches function names starting with <code>get_</code>, <code>set_</code>, or <code>update_</code>.</p>
<h3>Wildcard child</h3>
<pre>(call_expression
function: (identifier) @callee
arguments: (arguments . (_) .))</pre>
<p>The <code>(_)</code> wildcard matches any single node. Use <code>.</code> as an anchor.</p>
<h3>Multi-query (single pass)</h3>
<pre>doora \
-q '(function_item name: (identifier) @fn_name)' \
-q '(struct_item name: (type_identifier) @struct_name)' \
-p ./src</pre>
<p>Multiple <code>-q</code> flags are compiled into a single-pass automaton. The AST is traversed exactly once regardless of query count.</p>
</div>
<hr class="section-rule">
<!-- CLI SEARCH -->
<span class="anchor" id="cli-search"></span>
<div class="section">
<h2><span class="num">07</span>CLI — search command</h2>
<p class="section-intro">The default command. When no subcommand is given, doora runs a structural search.</p>
<div class="cli-block">
<div class="cli-header">usage</div>
<div class="cli-body">
<span class="cmd">doora</span> [search] [OPTIONS] <span class="flag">--query</span> <span class="val"><S-EXPR></span>
</div>
</div>
<h3>Arguments</h3>
<table class="arg-table">
<thead>
<tr><th>Flag</th><th>Type</th><th>Default</th><th>Description</th></tr>
</thead>
<tbody>
<tr>
<td class="arg-flag">-q, --query <S-EXPR></td>
<td class="arg-type">String (repeatable)</td>
<td class="arg-default">required</td>
<td class="arg-desc">S-expression query pattern. Pass multiple times for multi-query single-pass search.</td>
</tr>
<tr>
<td class="arg-flag">-p, --path <DIR></td>
<td class="arg-type">PathBuf</td>
<td class="arg-default">"."</td>
<td class="arg-desc">Root directory to search. Must be an existing directory.</td>
</tr>
<tr>
<td class="arg-flag">-l, --lang <LANG></td>
<td class="arg-type">String</td>
<td class="arg-default">"auto"</td>
<td class="arg-desc">Language to parse. One of: <code>rust</code>, <code>python</code>, <code>js</code>, <code>ts</code>, <code>go</code>, <code>c</code>, <code>cpp</code>, <code>auto</code>.</td>
</tr>
<tr>
<td class="arg-flag">--no-color</td>
<td class="arg-type">bool</td>
<td class="arg-default">false</td>
<td class="arg-desc">Disable ANSI color output. Also honored via the <code>NO_COLOR</code> environment variable.</td>
</tr>
<tr>
<td class="arg-flag">-Q, --quiet</td>
<td class="arg-type">bool</td>
<td class="arg-default">false</td>
<td class="arg-desc">Suppress per-match result lines. Only the summary line is printed.</td>
</tr>
<tr>
<td class="arg-flag">--stats</td>
<td class="arg-type">bool</td>
<td class="arg-default">false</td>
<td class="arg-desc">Print detailed performance diagnostics to stderr after the search completes.</td>
</tr>
<tr>
<td class="arg-flag">--no-update-index</td>
<td class="arg-type">bool</td>
<td class="arg-default">false</td>
<td class="arg-desc">Disable automatic incremental index updates during search.</td>
</tr>
</tbody>
</table>
<h3>Output format</h3>
<div class="cli-block">
<div class="cli-header">stdout — one line per match</div>
<div class="cli-body">
<span class="out">src/auth/handler.rs:42:0 [@fn_name] "parse_token"</span>
</div>
</div>
<p>Fields: <code>filepath:line:col [@capture_name] "matched_text"</code></p>
<ul>
<li>Filepath is colorized cyan (unless <code>--no-color</code>)</li>
<li>Capture name is colorized yellow</li>
<li>Matched text is colorized green, always wrapped in literal quotes</li>
<li>Line numbers are 1-indexed; columns are 0-indexed byte offsets</li>
</ul>
<div class="cli-block">
<div class="cli-header">stderr — summary line</div>
<div class="cli-body">
<span class="cmt">Found 47 matches across 23 files in 38ms</span>
</div>
</div>
<h3>Stats output</h3>
<div class="cli-block">
<div class="cli-header">stderr — with --stats flag</div>
<div class="cli-body">
<span class="cmt">--- search statistics ---</span><br>
<span class="out">files walked: </span><span class="val">47</span><br>
<span class="out">files parsed: </span><span class="val">46</span><br>
<span class="out">files skipped: </span><span class="val">1</span><br>
<span class="out">matches found: </span><span class="val">12</span><br>
<span class="out">sieve rejected: </span><span class="val">18</span><br>
<span class="out">match rate: </span><span class="val">26.09%</span> <span class="cmt">(files with matches / files parsed)</span><br>
<span class="out">wall time: </span><span class="val">38ms</span><br>
<span class="out">throughput: </span><span class="val">1236.84 files/sec</span>