gitingest 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/README.md +1 -1
- data/bin/gitingest +1 -1
- data/index.html +945 -356
- data/lib/gitingest/generator.rb +3 -2
- data/lib/gitingest/version.rb +1 -1
- metadata +2 -2
data/index.html
CHANGED
|
@@ -1,443 +1,1032 @@
|
|
|
1
1
|
<!DOCTYPE html>
|
|
2
2
|
<html lang="en">
|
|
3
|
+
|
|
3
4
|
<head>
|
|
4
|
-
<meta charset="UTF-8"
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0"
|
|
6
|
-
<title>Gitingest - GitHub Repository
|
|
7
|
-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/
|
|
5
|
+
<meta charset="UTF-8" />
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
7
|
+
<title>Gitingest - Streamlined GitHub Repository Extraction</title>
|
|
8
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" />
|
|
9
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap" rel="stylesheet" />
|
|
8
10
|
<style>
|
|
9
|
-
/* Styles remain the same */
|
|
10
11
|
:root {
|
|
11
|
-
--
|
|
12
|
-
--
|
|
13
|
-
--
|
|
14
|
-
--
|
|
15
|
-
--
|
|
16
|
-
--
|
|
17
|
-
--
|
|
18
|
-
--
|
|
19
|
-
--
|
|
12
|
+
--primary: #10B981;
|
|
13
|
+
--primary-dark: #059669;
|
|
14
|
+
--secondary: #8B5CF6;
|
|
15
|
+
--dark: #111827;
|
|
16
|
+
--darker: #0F172A;
|
|
17
|
+
--light: #F9FAFB;
|
|
18
|
+
--gray: #6B7280;
|
|
19
|
+
--light-gray: #E5E7EB;
|
|
20
|
+
--terminal-bg: rgba(15, 23, 42, 0.95);
|
|
21
|
+
--terminal-text: #A5F3FC;
|
|
22
|
+
--terminal-prompt: #10B981;
|
|
23
|
+
--terminal-cursor: #F9FAFB;
|
|
24
|
+
--cmd-output: #94A3B8;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
* {
|
|
28
|
+
margin: 0;
|
|
29
|
+
padding: 0;
|
|
30
|
+
box-sizing: border-box;
|
|
31
|
+
font-family: 'Inter', -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
|
|
20
32
|
}
|
|
21
33
|
|
|
22
34
|
body {
|
|
23
|
-
|
|
35
|
+
background-color: var(--dark);
|
|
36
|
+
color: var(--light);
|
|
24
37
|
line-height: 1.6;
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
max-width: 900px;
|
|
28
|
-
margin: 0 auto;
|
|
29
|
-
padding: 20px;
|
|
38
|
+
overflow-x: hidden;
|
|
39
|
+
position: relative;
|
|
30
40
|
}
|
|
31
41
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
42
|
+
/* Grainy background effect */
|
|
43
|
+
.grain {
|
|
44
|
+
position: fixed;
|
|
45
|
+
top: 0;
|
|
46
|
+
left: 0;
|
|
47
|
+
height: 100%;
|
|
48
|
+
width: 100%;
|
|
49
|
+
pointer-events: none;
|
|
50
|
+
opacity: 0.03;
|
|
51
|
+
background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 400 400' xmlns='http://www.w3.org/2000/svg'%3E%3Cfilter id='noiseFilter'%3E%3CfeTurbulence type='fractalNoise' baseFrequency='0.65' numOctaves='3' stitchTiles='stitch'/%3E%3C/filter%3E%3Crect width='100%25' height='100%25' filter='url(%23noiseFilter)'/%3E%3C/svg%3E");
|
|
52
|
+
z-index: 100;
|
|
38
53
|
}
|
|
39
54
|
|
|
40
|
-
|
|
55
|
+
header {
|
|
56
|
+
position: fixed;
|
|
57
|
+
top: 0;
|
|
58
|
+
width: 100%;
|
|
59
|
+
padding: 1.5rem 0;
|
|
60
|
+
background-color: rgba(17, 24, 39, 0.8);
|
|
61
|
+
backdrop-filter: blur(10px);
|
|
62
|
+
z-index: 50;
|
|
63
|
+
transition: all 0.3s ease;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
.header-container {
|
|
67
|
+
max-width: 1200px;
|
|
68
|
+
margin: 0 auto;
|
|
41
69
|
display: flex;
|
|
70
|
+
justify-content: space-between;
|
|
42
71
|
align-items: center;
|
|
43
|
-
margin-bottom: 30px;
|
|
44
72
|
}
|
|
45
73
|
|
|
46
74
|
.logo {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
75
|
+
display: flex;
|
|
76
|
+
align-items: center;
|
|
77
|
+
gap: 1rem;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
.logo-icon {
|
|
81
|
+
background: linear-gradient(135deg, var(--primary), var(--secondary));
|
|
82
|
+
width: 50px;
|
|
83
|
+
height: 50px;
|
|
84
|
+
border-radius: 8px;
|
|
52
85
|
display: flex;
|
|
53
86
|
align-items: center;
|
|
54
87
|
justify-content: center;
|
|
55
|
-
color: white;
|
|
56
|
-
font-size: 24px;
|
|
57
88
|
font-weight: bold;
|
|
89
|
+
font-size: 1.5rem;
|
|
90
|
+
box-shadow: 0 10px 15px -3px rgba(16, 185, 129, 0.2);
|
|
58
91
|
}
|
|
59
92
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
padding-bottom: 10px;
|
|
64
|
-
margin-top: 24px;
|
|
65
|
-
margin-bottom: 16px;
|
|
93
|
+
.logo-text {
|
|
94
|
+
font-size: 1.5rem;
|
|
95
|
+
font-weight: 700;
|
|
66
96
|
}
|
|
67
97
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
98
|
+
.version-tag {
|
|
99
|
+
background: rgba(16, 185, 129, 0.15);
|
|
100
|
+
color: var(--primary);
|
|
101
|
+
padding: 0.2rem 0.6rem;
|
|
102
|
+
border-radius: 20px;
|
|
103
|
+
font-size: 0.75rem;
|
|
104
|
+
font-weight: 600;
|
|
105
|
+
margin-left: 0.5rem;
|
|
73
106
|
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
107
|
+
|
|
108
|
+
nav ul {
|
|
109
|
+
display: flex;
|
|
110
|
+
list-style: none;
|
|
111
|
+
gap: 2rem;
|
|
78
112
|
}
|
|
79
113
|
|
|
80
|
-
a {
|
|
81
|
-
color: var(--
|
|
114
|
+
nav a {
|
|
115
|
+
color: var(--light);
|
|
82
116
|
text-decoration: none;
|
|
117
|
+
font-weight: 500;
|
|
118
|
+
transition: color 0.2s ease;
|
|
119
|
+
position: relative;
|
|
83
120
|
}
|
|
84
121
|
|
|
85
|
-
a:hover {
|
|
86
|
-
|
|
122
|
+
nav a:hover {
|
|
123
|
+
color: var(--primary);
|
|
87
124
|
}
|
|
88
125
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
126
|
+
nav a::after {
|
|
127
|
+
content: '';
|
|
128
|
+
position: absolute;
|
|
129
|
+
width: 0;
|
|
130
|
+
height: 2px;
|
|
131
|
+
bottom: -5px;
|
|
132
|
+
left: 0;
|
|
133
|
+
background-color: var(--primary);
|
|
134
|
+
transition: width 0.3s ease;
|
|
95
135
|
}
|
|
96
136
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
border-radius: 6px;
|
|
100
|
-
padding: 16px;
|
|
101
|
-
overflow: auto;
|
|
102
|
-
border: 1px solid var(--border-color);
|
|
103
|
-
margin: 16px 0;
|
|
137
|
+
nav a:hover::after {
|
|
138
|
+
width: 100%;
|
|
104
139
|
}
|
|
105
140
|
|
|
106
|
-
|
|
107
|
-
background-color:
|
|
108
|
-
|
|
109
|
-
border
|
|
110
|
-
|
|
141
|
+
.github-btn {
|
|
142
|
+
background-color: var(--darker);
|
|
143
|
+
color: var(--light);
|
|
144
|
+
border: 1px solid rgba(255, 255, 255, 0.1);
|
|
145
|
+
padding: 0.6rem 1.2rem;
|
|
146
|
+
border-radius: 8px;
|
|
147
|
+
font-weight: 500;
|
|
148
|
+
display: flex;
|
|
149
|
+
align-items: center;
|
|
150
|
+
gap: 0.5rem;
|
|
151
|
+
transition: all 0.2s ease;
|
|
152
|
+
text-decoration: none;
|
|
111
153
|
}
|
|
112
154
|
|
|
113
|
-
|
|
114
|
-
|
|
155
|
+
.github-btn:hover {
|
|
156
|
+
background-color: rgba(255, 255, 255, 0.05);
|
|
157
|
+
transform: translateY(-2px);
|
|
115
158
|
}
|
|
116
159
|
|
|
117
|
-
.
|
|
118
|
-
|
|
119
|
-
background
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
border-radius: 6px;
|
|
123
|
-
font-weight: 600;
|
|
124
|
-
margin: 8px 0;
|
|
160
|
+
.hero {
|
|
161
|
+
padding: 12rem 2rem 8rem;
|
|
162
|
+
background: radial-gradient(circle at 50% 50%, rgba(139, 92, 246, 0.15), rgba(17, 24, 39, 0) 50%);
|
|
163
|
+
position: relative;
|
|
164
|
+
overflow: hidden;
|
|
125
165
|
}
|
|
126
166
|
|
|
127
|
-
.
|
|
128
|
-
|
|
167
|
+
.blobs {
|
|
168
|
+
position: absolute;
|
|
169
|
+
top: 0;
|
|
170
|
+
left: 0;
|
|
171
|
+
width: 100%;
|
|
172
|
+
height: 100%;
|
|
173
|
+
overflow: hidden;
|
|
174
|
+
z-index: -1;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
.blob {
|
|
178
|
+
position: absolute;
|
|
179
|
+
border-radius: 50%;
|
|
180
|
+
filter: blur(80px);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
.blob-1 {
|
|
184
|
+
top: -200px;
|
|
185
|
+
right: -200px;
|
|
186
|
+
width: 600px;
|
|
187
|
+
height: 600px;
|
|
188
|
+
background: radial-gradient(circle, rgba(16, 185, 129, 0.05) 0%, rgba(139, 92, 246, 0.05) 100%);
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
.blob-2 {
|
|
192
|
+
bottom: -300px;
|
|
193
|
+
left: -200px;
|
|
194
|
+
width: 500px;
|
|
195
|
+
height: 500px;
|
|
196
|
+
background: radial-gradient(circle, rgba(139, 92, 246, 0.05) 0%, rgba(16, 185, 129, 0.05) 100%);
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
.container {
|
|
200
|
+
max-width: 1200px;
|
|
201
|
+
margin: 0 auto;
|
|
202
|
+
position: relative;
|
|
203
|
+
z-index: 1;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
.hero-content {
|
|
207
|
+
max-width: 700px;
|
|
208
|
+
margin-bottom: 5rem;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
.hero h1 {
|
|
212
|
+
font-size: 3.5rem;
|
|
213
|
+
font-weight: 800;
|
|
214
|
+
line-height: 1.2;
|
|
215
|
+
margin-bottom: 1.5rem;
|
|
216
|
+
background: linear-gradient(90deg, #fff, #94A3B8);
|
|
217
|
+
-webkit-background-clip: text;
|
|
218
|
+
-webkit-text-fill-color: transparent;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
.headline {
|
|
222
|
+
color: var(--gray);
|
|
223
|
+
font-size: 1.25rem;
|
|
224
|
+
margin-bottom: 2rem;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
.highlight {
|
|
228
|
+
color: var(--primary);
|
|
229
|
+
font-weight: 500;
|
|
230
|
+
position: relative;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
.highlight::before {
|
|
234
|
+
content: '';
|
|
235
|
+
position: absolute;
|
|
236
|
+
bottom: 0;
|
|
237
|
+
left: 0;
|
|
238
|
+
width: 100%;
|
|
239
|
+
height: 5px;
|
|
240
|
+
background-color: rgba(16, 185, 129, 0.2);
|
|
241
|
+
transform: translateY(2px);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
.cta-buttons {
|
|
245
|
+
display: flex;
|
|
246
|
+
gap: 1rem;
|
|
247
|
+
margin-bottom: 3rem;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
.btn {
|
|
251
|
+
padding: 0.75rem 1.5rem;
|
|
252
|
+
border-radius: 8px;
|
|
253
|
+
font-weight: 600;
|
|
254
|
+
font-size: 1rem;
|
|
255
|
+
transition: all 0.2s ease;
|
|
129
256
|
text-decoration: none;
|
|
257
|
+
display: inline-flex;
|
|
258
|
+
align-items: center;
|
|
259
|
+
gap: 0.5rem;
|
|
130
260
|
}
|
|
131
261
|
|
|
132
|
-
.
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
262
|
+
.btn-primary {
|
|
263
|
+
background-color: var(--primary);
|
|
264
|
+
color: var(--light);
|
|
265
|
+
box-shadow: 0 10px 15px -3px rgba(16, 185, 129, 0.2);
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
.btn-primary:hover {
|
|
269
|
+
background-color: var(--primary-dark);
|
|
270
|
+
transform: translateY(-2px);
|
|
271
|
+
box-shadow: 0 15px 20px -3px rgba(16, 185, 129, 0.3);
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
.btn-outline {
|
|
275
|
+
background-color: transparent;
|
|
276
|
+
color: var(--light);
|
|
277
|
+
border: 1px solid rgba(255, 255, 255, 0.2);
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
.btn-outline:hover {
|
|
281
|
+
background-color: rgba(255, 255, 255, 0.05);
|
|
282
|
+
transform: translateY(-2px);
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
/* Terminal simulation styles */
|
|
286
|
+
.terminal {
|
|
287
|
+
background-color: var(--terminal-bg);
|
|
288
|
+
border-radius: 12px;
|
|
289
|
+
overflow: hidden;
|
|
290
|
+
box-shadow: 0 20px 50px rgba(0, 0, 0, 0.3), 0 0 0 1px rgba(255, 255, 255, 0.1);
|
|
291
|
+
margin-top: 2rem;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
.terminal-header {
|
|
295
|
+
background-color: rgba(15, 23, 42, 0.6);
|
|
296
|
+
padding: 1rem;
|
|
297
|
+
display: flex;
|
|
298
|
+
align-items: center;
|
|
299
|
+
border-bottom: 1px solid rgba(255, 255, 255, 0.05);
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
.terminal-controls {
|
|
303
|
+
display: flex;
|
|
304
|
+
gap: 0.5rem;
|
|
305
|
+
margin-right: 1rem;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
.terminal-control {
|
|
309
|
+
width: 12px;
|
|
310
|
+
height: 12px;
|
|
311
|
+
border-radius: 50%;
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
.terminal-close {
|
|
315
|
+
background-color: #FF5F56;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
.terminal-minimize {
|
|
319
|
+
background-color: #FFBD2E;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
.terminal-maximize {
|
|
323
|
+
background-color: #27C93F;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
.terminal-title {
|
|
327
|
+
font-size: 0.875rem;
|
|
328
|
+
font-weight: 500;
|
|
329
|
+
color: var(--gray);
|
|
330
|
+
flex: 1;
|
|
331
|
+
text-align: center;
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
.terminal-body {
|
|
335
|
+
padding: 1.5rem;
|
|
336
|
+
font-family: 'SF Mono', 'Menlo', 'Monaco', 'Courier New', monospace;
|
|
337
|
+
font-size: 0.875rem;
|
|
338
|
+
line-height: 1.7;
|
|
339
|
+
overflow-x: auto;
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
.terminal-line {
|
|
343
|
+
margin-bottom: 0.75rem;
|
|
344
|
+
display: flex;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
.terminal-prompt {
|
|
348
|
+
color: var(--terminal-prompt);
|
|
349
|
+
margin-right: 0.75rem;
|
|
139
350
|
font-weight: bold;
|
|
140
|
-
margin-left: 10px;
|
|
141
351
|
}
|
|
142
352
|
|
|
143
|
-
|
|
144
|
-
|
|
353
|
+
.terminal-command {
|
|
354
|
+
color: var(--terminal-text);
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
.terminal-output {
|
|
358
|
+
color: var(--cmd-output);
|
|
359
|
+
margin-left: 1.65rem;
|
|
360
|
+
margin-bottom: 1.5rem;
|
|
361
|
+
opacity: 0.8;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
.typing::after {
|
|
365
|
+
content: '|';
|
|
366
|
+
color: var(--terminal-cursor);
|
|
367
|
+
animation: blink 1s step-end infinite;
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
@keyframes blink {
|
|
371
|
+
|
|
372
|
+
0%,
|
|
373
|
+
100% {
|
|
374
|
+
opacity: 1;
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
50% {
|
|
378
|
+
opacity: 0;
|
|
379
|
+
}
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
/* Features Section */
|
|
383
|
+
.features {
|
|
384
|
+
padding: 6rem 2rem;
|
|
385
|
+
background-color: var(--darker);
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
.section-header {
|
|
389
|
+
text-align: center;
|
|
390
|
+
margin-bottom: 4rem;
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
.section-pretitle {
|
|
394
|
+
color: var(--primary);
|
|
395
|
+
font-weight: 600;
|
|
396
|
+
text-transform: uppercase;
|
|
397
|
+
letter-spacing: 1.5px;
|
|
398
|
+
margin-bottom: 1rem;
|
|
399
|
+
font-size: 0.875rem;
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
.features h2 {
|
|
403
|
+
font-size: 2.5rem;
|
|
404
|
+
font-weight: 700;
|
|
405
|
+
margin-bottom: 1.5rem;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
.section-subtitle {
|
|
409
|
+
color: var(--gray);
|
|
410
|
+
font-size: 1.125rem;
|
|
411
|
+
max-width: 700px;
|
|
412
|
+
margin: 0 auto 2rem;
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
.feature-grid {
|
|
416
|
+
display: grid;
|
|
417
|
+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
|
|
418
|
+
gap: 2rem;
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
.feature-card {
|
|
422
|
+
background-color: rgba(255, 255, 255, 0.03);
|
|
423
|
+
border: 1px solid rgba(255, 255, 255, 0.07);
|
|
424
|
+
border-radius: 12px;
|
|
425
|
+
padding: 2rem;
|
|
426
|
+
transition: transform 0.3s ease, box-shadow 0.3s ease;
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
.feature-card:hover {
|
|
430
|
+
transform: translateY(-5px);
|
|
431
|
+
box-shadow: 0 10px 30px rgba(0, 0, 0, 0.2);
|
|
432
|
+
border-color: rgba(16, 185, 129, 0.2);
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
.feature-icon {
|
|
436
|
+
width: 56px;
|
|
437
|
+
height: 56px;
|
|
438
|
+
background: linear-gradient(135deg, rgba(16, 185, 129, 0.1), rgba(139, 92, 246, 0.1));
|
|
439
|
+
border-radius: 12px;
|
|
440
|
+
display: flex;
|
|
441
|
+
align-items: center;
|
|
442
|
+
justify-content: center;
|
|
443
|
+
margin-bottom: 1.5rem;
|
|
444
|
+
color: var(--primary);
|
|
445
|
+
font-size: 1.5rem;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
.feature-card h3 {
|
|
449
|
+
font-size: 1.25rem;
|
|
450
|
+
font-weight: 600;
|
|
451
|
+
margin-bottom: 1rem;
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
.feature-desc {
|
|
455
|
+
color: var(--gray);
|
|
456
|
+
font-size: 0.95rem;
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
/* Usage Section */
|
|
460
|
+
.usage {
|
|
461
|
+
padding: 6rem 2rem;
|
|
462
|
+
background-color: var(--dark);
|
|
463
|
+
position: relative;
|
|
464
|
+
overflow: hidden;
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
.usage h2 {
|
|
145
468
|
text-align: center;
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
border-top: 1px solid var(--border-color);
|
|
149
|
-
padding-top: 20px;
|
|
469
|
+
font-size: 2.5rem;
|
|
470
|
+
margin-bottom: 2rem;
|
|
150
471
|
}
|
|
151
472
|
|
|
473
|
+
.code-block {
|
|
474
|
+
background-color: rgba(255, 255, 255, 0.03);
|
|
475
|
+
border: 1px solid #fff;
|
|
476
|
+
margin-top: 1rem;
|
|
477
|
+
padding: 1rem;
|
|
478
|
+
border-radius: 8px;
|
|
479
|
+
overflow-x: auto;
|
|
480
|
+
font-family: 'SF Mono', monospace;
|
|
481
|
+
font-size: 0.875rem;
|
|
482
|
+
line-height: 1.7;
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
/* Changelog Section */
|
|
152
486
|
.changelog {
|
|
153
|
-
|
|
487
|
+
padding: 6rem 2rem;
|
|
488
|
+
background-color: var(--darker);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
.timeline {
|
|
492
|
+
max-width: 800px;
|
|
493
|
+
margin: 0 auto;
|
|
494
|
+
position: relative;
|
|
154
495
|
}
|
|
155
496
|
|
|
156
|
-
.
|
|
157
|
-
|
|
497
|
+
.timeline::before {
|
|
498
|
+
content: '';
|
|
499
|
+
position: absolute;
|
|
500
|
+
left: 32px;
|
|
501
|
+
top: 0;
|
|
502
|
+
height: 100%;
|
|
503
|
+
width: 2px;
|
|
504
|
+
background: linear-gradient(to bottom, var(--primary), var(--secondary));
|
|
158
505
|
}
|
|
159
506
|
|
|
160
|
-
.
|
|
507
|
+
.timeline-item {
|
|
508
|
+
margin-bottom: 3rem;
|
|
509
|
+
padding-left: 80px;
|
|
510
|
+
position: relative;
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
.timeline-date {
|
|
514
|
+
position: absolute;
|
|
515
|
+
left: 0;
|
|
516
|
+
top: 0;
|
|
517
|
+
width: 64px;
|
|
518
|
+
height: 64px;
|
|
519
|
+
background: linear-gradient(135deg, var(--primary), var(--secondary));
|
|
520
|
+
border-radius: 50%;
|
|
521
|
+
display: flex;
|
|
522
|
+
align-items: center;
|
|
523
|
+
justify-content: center;
|
|
524
|
+
flex-direction: column;
|
|
525
|
+
font-weight: 600;
|
|
526
|
+
line-height: 1.2;
|
|
527
|
+
box-shadow: 0 10px 15px -3px rgba(16, 185, 129, 0.2);
|
|
528
|
+
color: var(--light);
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
.timeline-month {
|
|
532
|
+
font-size: 0.75rem;
|
|
533
|
+
text-transform: uppercase;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
.timeline-day {
|
|
537
|
+
font-size: 1.25rem;
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
.timeline-version {
|
|
541
|
+
font-size: 1.25rem;
|
|
542
|
+
font-weight: 600;
|
|
543
|
+
margin-bottom: 0.5rem;
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
.timeline-desc {
|
|
547
|
+
color: var(--gray);
|
|
548
|
+
font-size: 0.95rem;
|
|
549
|
+
margin-bottom: 1rem;
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
.timeline-list {
|
|
553
|
+
background-color: rgba(255, 255, 255, 0.03);
|
|
554
|
+
border: 1px solid rgba(255, 255, 255, 0.07);
|
|
555
|
+
border-radius: 8px;
|
|
556
|
+
padding: 1.5rem;
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
.timeline-list li {
|
|
560
|
+
margin-bottom: 0.75rem;
|
|
561
|
+
color: var(--light-gray);
|
|
562
|
+
position: relative;
|
|
563
|
+
padding-left: 1.5rem;
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
.timeline-list li::before {
|
|
567
|
+
content: '•';
|
|
568
|
+
position: absolute;
|
|
569
|
+
left: 0;
|
|
570
|
+
top: 0;
|
|
571
|
+
color: var(--primary);
|
|
161
572
|
font-weight: bold;
|
|
162
|
-
color: var(--header-color);
|
|
163
573
|
}
|
|
164
574
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
575
|
+
/* Footer */
|
|
576
|
+
.footer {
|
|
577
|
+
background-color: var(--darker);
|
|
578
|
+
padding: 4rem 2rem;
|
|
579
|
+
border-top: 1px solid rgba(255, 255, 255, 0.05);
|
|
168
580
|
}
|
|
169
581
|
|
|
170
|
-
.
|
|
171
|
-
|
|
582
|
+
.footer-grid {
|
|
583
|
+
display: grid;
|
|
584
|
+
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
|
585
|
+
gap: 2rem;
|
|
586
|
+
max-width: 1200px;
|
|
587
|
+
margin: 0 auto;
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
.footer-logo {
|
|
591
|
+
display: flex;
|
|
592
|
+
align-items: center;
|
|
593
|
+
gap: 0.75rem;
|
|
594
|
+
margin-bottom: 1rem;
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
.footer-logo-icon {
|
|
598
|
+
width: 32px;
|
|
599
|
+
height: 32px;
|
|
600
|
+
background: linear-gradient(135deg, var(--primary), var(--secondary));
|
|
601
|
+
border-radius: 6px;
|
|
602
|
+
display: flex;
|
|
603
|
+
align-items: center;
|
|
604
|
+
justify-content: center;
|
|
605
|
+
font-weight: bold;
|
|
606
|
+
font-size: 18px;
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
.footer-desc {
|
|
610
|
+
color: var(--gray);
|
|
611
|
+
font-size: 0.95rem;
|
|
612
|
+
margin-bottom: 1.5rem;
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
.social-links {
|
|
616
|
+
display: flex;
|
|
617
|
+
gap: 1rem;
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
.social-link {
|
|
621
|
+
width: 40px;
|
|
622
|
+
height: 40px;
|
|
623
|
+
border-radius: 50%;
|
|
624
|
+
background-color: rgba(255, 255, 255, 0.05);
|
|
625
|
+
display: flex;
|
|
626
|
+
align-items: center;
|
|
627
|
+
justify-content: center;
|
|
628
|
+
color: var(--light);
|
|
629
|
+
font-size: 1.25rem;
|
|
630
|
+
transition: all 0.2s ease;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
.social-link:hover {
|
|
634
|
+
background-color: var(--primary);
|
|
635
|
+
transform: translateY(-3px);
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
.footer-title {
|
|
639
|
+
font-size: 1.125rem;
|
|
640
|
+
font-weight: 600;
|
|
641
|
+
margin-bottom: 1.25rem;
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
.footer-links {
|
|
645
|
+
list-style: none;
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
.footer-links li {
|
|
649
|
+
margin-bottom: 0.75rem;
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
.footer-links a {
|
|
653
|
+
color: var(--gray);
|
|
654
|
+
text-decoration: none;
|
|
655
|
+
transition: color 0.2s ease;
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
.footer-links a:hover {
|
|
659
|
+
color: var(--primary);
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
.copyright {
|
|
663
|
+
max-width: 1200px;
|
|
664
|
+
margin: 2rem auto 0;
|
|
665
|
+
text-align: center;
|
|
666
|
+
color: var(--gray);
|
|
667
|
+
font-size: 0.875rem;
|
|
668
|
+
border-top: 1px solid rgba(255, 255, 255, 0.05);
|
|
669
|
+
padding-top: 2rem;
|
|
670
|
+
}
|
|
671
|
+
|
|
672
|
+
@media (max-width: 768px) {
|
|
673
|
+
.header-container {
|
|
674
|
+
padding: 0 1rem;
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
.hero {
|
|
678
|
+
padding: 10rem 2rem 6rem;
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
.hero h1 {
|
|
682
|
+
font-size: 2.5rem;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
.cta-buttons {
|
|
686
|
+
flex-direction: column;
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
.feature-grid {
|
|
690
|
+
grid-template-columns: 1fr;
|
|
691
|
+
}
|
|
692
|
+
|
|
693
|
+
.footer-grid {
|
|
694
|
+
grid-template-columns: 1fr;
|
|
695
|
+
}
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
@media (max-width: 480px) {
|
|
699
|
+
.header-container {
|
|
700
|
+
padding: 0 1rem;
|
|
701
|
+
flex-direction: column;
|
|
702
|
+
gap: 1rem;
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
nav ul {
|
|
706
|
+
gap: 1rem;
|
|
707
|
+
}
|
|
172
708
|
}
|
|
173
709
|
</style>
|
|
174
710
|
</head>
|
|
711
|
+
|
|
175
712
|
<body>
|
|
176
|
-
<div class="
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
<
|
|
713
|
+
<div class="grain"></div>
|
|
714
|
+
|
|
715
|
+
<header>
|
|
716
|
+
<div class="header-container">
|
|
717
|
+
<div class="logo">
|
|
718
|
+
<div class="logo-icon">G</div>
|
|
719
|
+
<div class="logo-text">Gitingest <span class="version-tag">v0.6.0</span></div>
|
|
720
|
+
</div>
|
|
721
|
+
<nav>
|
|
722
|
+
<ul>
|
|
723
|
+
<li><a href="#features">Features</a></li>
|
|
724
|
+
<li><a href="#usage">Usage</a></li>
|
|
725
|
+
<li><a href="#changelog">Changelog</a></li>
|
|
726
|
+
</ul>
|
|
727
|
+
</nav>
|
|
728
|
+
<a href="https://github.com/davidesantangelo/gitingest" class="github-btn">
|
|
729
|
+
<i class="fab fa-github"></i> GitHub
|
|
730
|
+
</a>
|
|
731
|
+
</div>
|
|
732
|
+
</header>
|
|
733
|
+
|
|
734
|
+
<section class="hero">
|
|
735
|
+
<div class="blobs">
|
|
736
|
+
<div class="blob blob-1"></div>
|
|
737
|
+
<div class="blob blob-2"></div>
|
|
738
|
+
</div>
|
|
739
|
+
<div class="container">
|
|
740
|
+
<div class="hero-content">
|
|
741
|
+
<h1>Distill GitHub Repositories into Perfect LLM Prompts</h1>
|
|
742
|
+
<p class="headline">Gitingest is a <span class="highlight">powerful Ruby gem</span> that fetches
|
|
743
|
+
repository files and generates consolidated text prompts optimized for large language models.</p>
|
|
744
|
+
<div class="cta-buttons">
|
|
745
|
+
<a href="https://rubygems.org/gems/gitingest" class="btn btn-primary">
|
|
746
|
+
<i class="fas fa-gem"></i> Install from RubyGems
|
|
747
|
+
</a>
|
|
748
|
+
<a href="#usage" class="btn btn-outline">
|
|
749
|
+
<i class="fas fa-book"></i> Documentation
|
|
750
|
+
</a>
|
|
751
|
+
</div>
|
|
752
|
+
</div>
|
|
753
|
+
<div class="terminal">
|
|
754
|
+
<div class="terminal-header">
|
|
755
|
+
<div class="terminal-controls">
|
|
756
|
+
<div class="terminal-control terminal-close"></div>
|
|
757
|
+
<div class="terminal-control terminal-minimize"></div>
|
|
758
|
+
<div class="terminal-control terminal-maximize"></div>
|
|
759
|
+
</div>
|
|
760
|
+
<div class="terminal-title">zsh - gitingest</div>
|
|
761
|
+
</div>
|
|
762
|
+
<div class="terminal-body">
|
|
763
|
+
<div class="terminal-line">
|
|
764
|
+
<span class="terminal-prompt">$</span>
|
|
765
|
+
<span class="terminal-command">gem install gitingest</span>
|
|
766
|
+
</div>
|
|
767
|
+
<div class="terminal-output">
|
|
768
|
+
Successfully installed gitingest-0.5.0<br />
|
|
769
|
+
1 gem installed
|
|
770
|
+
</div>
|
|
771
|
+
<div class="terminal-line">
|
|
772
|
+
<span class="terminal-prompt">$</span>
|
|
773
|
+
<span class="terminal-command">gitingest --repository user/repo --token $GITHUB_TOKEN</span>
|
|
774
|
+
</div>
|
|
775
|
+
<div class="terminal-output">
|
|
776
|
+
Fetching repository: user/repo (branch: main)<br />
|
|
777
|
+
Found 87 files (excluding system and binary files)<br />
|
|
778
|
+
[====================] 100% | ETA: 0s | 87/87 files<br />
|
|
779
|
+
Prompt generated: repo_prompt.txt (254 KB)
|
|
780
|
+
</div>
|
|
781
|
+
<div class="terminal-line">
|
|
782
|
+
<span class="terminal-prompt">$</span>
|
|
783
|
+
<span class="terminal-command typing">gitingest --repository user/repo --show-structure</span>
|
|
784
|
+
</div>
|
|
785
|
+
</div>
|
|
786
|
+
</div>
|
|
787
|
+
</div>
|
|
788
|
+
</section>
|
|
789
|
+
|
|
790
|
+
<section class="features" id="features">
|
|
791
|
+
<div class="container">
|
|
792
|
+
<div class="section-header">
|
|
793
|
+
<p class="section-pretitle">Why Use Gitingest</p>
|
|
794
|
+
<h2>Streamlined Repository Extraction</h2>
|
|
795
|
+
<p class="section-subtitle">Extract the essence of any GitHub codebase with precision and transform it
|
|
796
|
+
into the perfect context for LLM prompting.</p>
|
|
797
|
+
</div>
|
|
798
|
+
<div class="feature-grid">
|
|
799
|
+
<div class="feature-card">
|
|
800
|
+
<div class="feature-icon">
|
|
801
|
+
<i class="fas fa-bolt"></i>
|
|
802
|
+
</div>
|
|
803
|
+
<h3>Concurrent Processing</h3>
|
|
804
|
+
<p class="feature-desc">Utilizes configurable thread counts to accelerate downloads and
|
|
805
|
+
intelligently prioritize files for optimal concurrency.</p>
|
|
806
|
+
</div>
|
|
807
|
+
<div class="feature-card">
|
|
808
|
+
<div class="feature-icon">
|
|
809
|
+
<i class="fas fa-filter"></i>
|
|
810
|
+
</div>
|
|
811
|
+
<h3>Smart Filtering</h3>
|
|
812
|
+
<p class="feature-desc">Automatically excludes unnecessary binary and system files while supporting
|
|
813
|
+
custom exclusion patterns to fit your needs.</p>
|
|
814
|
+
</div>
|
|
815
|
+
<div class="feature-card">
|
|
816
|
+
<div class="feature-icon">
|
|
817
|
+
<i class="fas fa-chart-line"></i>
|
|
818
|
+
</div>
|
|
819
|
+
<h3>Real-Time Progress</h3>
|
|
820
|
+
<p class="feature-desc">Visual progress indicators display processing speed, ETA, and file counts,
|
|
821
|
+
keeping you informed every step of the way.</p>
|
|
822
|
+
</div>
|
|
823
|
+
<div class="feature-card">
|
|
824
|
+
<div class="feature-icon">
|
|
825
|
+
<i class="fas fa-sitemap"></i>
|
|
826
|
+
</div>
|
|
827
|
+
<h3>Directory Visualization</h3>
|
|
828
|
+
<p class="feature-desc">Generate a tree-view of the repository structure to easily navigate and
|
|
829
|
+
understand codebase organization.</p>
|
|
830
|
+
</div>
|
|
831
|
+
<div class="feature-card">
|
|
832
|
+
<div class="feature-icon">
|
|
833
|
+
<i class="fas fa-code"></i>
|
|
834
|
+
</div>
|
|
835
|
+
<h3>Clean Code Output</h3>
|
|
836
|
+
<p class="feature-desc">Produces a well-organized, consolidated text prompt that’s perfect for
|
|
837
|
+
feeding into large language models.</p>
|
|
838
|
+
</div>
|
|
182
839
|
</div>
|
|
183
840
|
</div>
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
841
|
+
</section>
|
|
842
|
+
|
|
843
|
+
<section class="usage" id="usage">
|
|
844
|
+
<div class="container">
|
|
845
|
+
<h2>Usage</h2>
|
|
846
|
+
<p>
|
|
847
|
+
Integrate Gitingest seamlessly into your workflow. Whether you install via RubyGems or clone the
|
|
848
|
+
repository, the CLI lets you extract repository content quickly and effortlessly.
|
|
849
|
+
</p>
|
|
850
|
+
<div class="code-block-wrapper" style="position: relative;">
|
|
851
|
+
<button class="copy-btn" onclick="copyUsageCode()" title="Copy code" style="
|
|
852
|
+
position: absolute;
|
|
853
|
+
top: 10px;
|
|
854
|
+
right: 10px;
|
|
855
|
+
background: rgba(255, 255, 255, 0.1);
|
|
856
|
+
border: none;
|
|
857
|
+
color: var(--gray);
|
|
858
|
+
width: 32px;
|
|
859
|
+
height: 32px;
|
|
860
|
+
border-radius: 6px;
|
|
861
|
+
cursor: pointer;
|
|
862
|
+
transition: background 0.2s ease;
|
|
863
|
+
">
|
|
864
|
+
<i class="fas fa-copy"></i>
|
|
865
|
+
</button>
|
|
866
|
+
<div class="code-block">
|
|
867
|
+
<pre><code id="usage-code"># Install from RubyGems
|
|
868
|
+
gem install gitingest
|
|
869
|
+
|
|
870
|
+
# Clone from GitHub and install dependencies
|
|
871
|
+
git clone https://github.com/davidesantangelo/gitingest.git
|
|
195
872
|
cd gitingest
|
|
196
873
|
bundle install
|
|
197
|
-
bundle exec rake install
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
gitingest --repository user/repo
|
|
204
|
-
|
|
205
|
-
# With GitHub token for private repositories
|
|
874
|
+
bundle exec rake install
|
|
875
|
+
|
|
876
|
+
# Basic usage for public repositories
|
|
877
|
+
gitingest --repository user/repo
|
|
878
|
+
|
|
879
|
+
# Using a GitHub token for private repositories
|
|
206
880
|
gitingest --repository user/repo --token YOUR_GITHUB_TOKEN
|
|
207
881
|
|
|
208
|
-
#
|
|
209
|
-
gitingest --repository user/repo --
|
|
210
|
-
|
|
211
|
-
# Specify a different branch
|
|
212
|
-
gitingest --repository user/repo --branch develop
|
|
213
|
-
|
|
214
|
-
# Exclude additional patterns
|
|
215
|
-
gitingest --repository user/repo --exclude "*.md,docs/"
|
|
216
|
-
|
|
217
|
-
# Show repository directory structure
|
|
218
|
-
gitingest --repository user/repo -s
|
|
219
|
-
|
|
220
|
-
# Control the number of threads
|
|
221
|
-
gitingest --repository user/repo -T 4
|
|
222
|
-
|
|
223
|
-
# Set thread pool shutdown timeout
|
|
224
|
-
gitingest --repository user/repo -W 120
|
|
225
|
-
|
|
226
|
-
# Combine threading options
|
|
227
|
-
gitingest --repository user/repo -T 8 -W 90
|
|
228
|
-
|
|
229
|
-
# Quiet mode
|
|
230
|
-
gitingest --repository user/repo --quiet
|
|
231
|
-
|
|
232
|
-
# Verbose mode
|
|
233
|
-
gitingest --repository user/repo --verbose</code></pre>
|
|
234
|
-
|
|
235
|
-
<h4>Available Options</h4>
|
|
236
|
-
<ul>
|
|
237
|
-
<li><code>-r, --repository REPO</code>: GitHub repository (username/repo) [Required]</li>
|
|
238
|
-
<li><code>-t, --token TOKEN</code>: GitHub personal access token [Optional but recommended]</li>
|
|
239
|
-
<li><code>-o, --output FILE</code>: Output file for the prompt [Default: reponame_prompt.txt]</li>
|
|
240
|
-
<li><code>-e, --exclude PATTERN</code>: File patterns to exclude (comma separated)</li>
|
|
241
|
-
<li><code>-b, --branch BRANCH</code>: Repository branch [Default: main]</li>
|
|
242
|
-
<li><code>-s, --show-structure</code>: Show repository directory structure</li>
|
|
243
|
-
<li><code>-T, --threads COUNT</code>: Number of concurrent threads [Default: auto-detected]</li>
|
|
244
|
-
<li><code>-W, --thread-timeout SECONDS</code>: Thread pool shutdown timeout [Default: 60]</li>
|
|
245
|
-
<li><code>-q, --quiet</code>: Reduce logging to errors only</li>
|
|
246
|
-
<li><code>-v, --verbose</code>: Increase logging verbosity</li>
|
|
247
|
-
<li><code>-h, --help</code>: Show help message</li>
|
|
248
|
-
</ul>
|
|
249
|
-
|
|
250
|
-
<h3>Directory Structure Visualization</h3>
|
|
251
|
-
<p>You can visualize the structure of a repository using the <code>--show-structure</code> option:</p>
|
|
252
|
-
<pre><code>gitingest --repository user/repo --show-structure</code></pre>
|
|
253
|
-
|
|
254
|
-
<p>This will display a tree view of the repository's structure, for example:</p>
|
|
255
|
-
<pre><code>Directory structure:
|
|
256
|
-
└── repo-name/
|
|
257
|
-
├── README.md
|
|
258
|
-
├── LICENSE
|
|
259
|
-
├── lib/
|
|
260
|
-
│ ├── repo-name.rb
|
|
261
|
-
│ └── repo-name/
|
|
262
|
-
│ └── version.rb
|
|
263
|
-
├── bin/
|
|
264
|
-
│ └── console
|
|
265
|
-
└── spec/
|
|
266
|
-
├── spec_helper.rb
|
|
267
|
-
└── repo-name_spec.rb</code></pre>
|
|
268
|
-
|
|
269
|
-
<h3>As a Library</h3>
|
|
270
|
-
<pre><code>require "gitingest"
|
|
271
|
-
|
|
272
|
-
# Basic usage - write to a file
|
|
273
|
-
generator = Gitingest::Generator.new(
|
|
274
|
-
repository: "user/repo",
|
|
275
|
-
token: "YOUR_GITHUB_TOKEN" # optional
|
|
276
|
-
)
|
|
277
|
-
|
|
278
|
-
# Run the full workflow (fetch repository and generate file)
|
|
279
|
-
generator.run
|
|
280
|
-
|
|
281
|
-
# OR generate file only (if you need the output path)
|
|
282
|
-
output_path = generator.generate_file
|
|
283
|
-
|
|
284
|
-
# Get content as a string (for in-memory processing)
|
|
285
|
-
content = generator.generate_prompt
|
|
286
|
-
|
|
287
|
-
# Generate and get repository directory structure
|
|
288
|
-
structure = generator.generate_directory_structure
|
|
289
|
-
|
|
290
|
-
# With custom options
|
|
291
|
-
generator = Gitingest::Generator.new(
|
|
292
|
-
repository: "user/repo",
|
|
293
|
-
token: "YOUR_GITHUB_TOKEN",
|
|
294
|
-
output_file: "my_prompt.txt",
|
|
295
|
-
branch: "develop",
|
|
296
|
-
exclude: ["*.md", "docs/"],
|
|
297
|
-
threads: 4, # control concurrency
|
|
298
|
-
thread_timeout: 120, # custom thread timeout
|
|
299
|
-
quiet: true, # or verbose: true
|
|
300
|
-
show_structure: true # show directory structure instead of generating prompt
|
|
301
|
-
)
|
|
302
|
-
|
|
303
|
-
# With custom logger
|
|
304
|
-
custom_logger = Logger.new("gitingest.log")
|
|
305
|
-
generator = Gitingest::Generator.new(
|
|
306
|
-
repository: "user/repo",
|
|
307
|
-
logger: custom_logger
|
|
308
|
-
)</code></pre>
|
|
309
|
-
|
|
310
|
-
<h2>Features</h2>
|
|
311
|
-
<ul>
|
|
312
|
-
<li>Fetches all files from a GitHub repository based on the given branch</li>
|
|
313
|
-
<li>Automatically excludes common binary files and system files by default</li>
|
|
314
|
-
<li>Allows custom exclusion patterns for specific file extensions or directories</li>
|
|
315
|
-
<li>Uses concurrent processing with configurable thread count for faster downloads</li>
|
|
316
|
-
<li>Shows real-time progress with visual bar, ETA, and processing rate</li>
|
|
317
|
-
<li>Handles GitHub API rate limiting with automatic retry and exponential backoff</li>
|
|
318
|
-
<li>Optimizes memory usage with buffered writes and thread-local buffers</li>
|
|
319
|
-
<li>Intelligently prioritizes files for better thread distribution</li>
|
|
320
|
-
<li>Generates a clean, formatted output file with file paths and content</li>
|
|
321
|
-
<li>Provides both file-based and string-based output options</li>
|
|
322
|
-
<li>Visualizes repository directory structure in a tree format</li>
|
|
323
|
-
</ul>
|
|
324
|
-
|
|
325
|
-
<h2>Default Exclusion Patterns</h2>
|
|
326
|
-
<p>By default, the generator excludes files and directories commonly ignored in repositories, such as:</p>
|
|
327
|
-
<ul>
|
|
328
|
-
<li>Version control files (<code>.git/</code>, <code>.svn/</code>)</li>
|
|
329
|
-
<li>System files (<code>.DS_Store</code>, <code>Thumbs.db</code>)</li>
|
|
330
|
-
<li>Log files (<code>*.log</code>, <code>*.bak</code>)</li>
|
|
331
|
-
<li>Images and media files (<code>*.png</code>, <code>*.jpg</code>, <code>*.mp3</code>)</li>
|
|
332
|
-
<li>Archives (<code>*.zip</code>, <code>*.tar.gz</code>)</li>
|
|
333
|
-
<li>Dependency directories (<code>node_modules/</code>, <code>vendor/</code>)</li>
|
|
334
|
-
<li>Compiled and binary files (<code>*.pyc</code>, <code>*.class</code>, <code>*.exe</code>)</li>
|
|
335
|
-
</ul>
|
|
336
|
-
|
|
337
|
-
<h2>Limitations</h2>
|
|
338
|
-
<ul>
|
|
339
|
-
<li>To prevent memory overload, only the first 1000 files will be processed</li>
|
|
340
|
-
<li>API requests are subject to GitHub limits (60 requests/hour without token, 5000 requests/hour with token)</li>
|
|
341
|
-
<li>Private repositories require a GitHub personal access token</li>
|
|
342
|
-
</ul>
|
|
343
|
-
|
|
344
|
-
<div class="changelog">
|
|
345
|
-
<h2>Changelog</h2>
|
|
346
|
-
|
|
347
|
-
<div class="changelog-item">
|
|
348
|
-
<div>
|
|
349
|
-
<span class="changelog-version">v0.5.0</span>
|
|
350
|
-
<span class="changelog-date">- March 4, 2025</span>
|
|
882
|
+
# Generate repository prompt and show structure
|
|
883
|
+
gitingest --repository user/repo --show-structure</code></pre>
|
|
351
884
|
</div>
|
|
352
|
-
<ul class="changelog-list">
|
|
353
|
-
<li>Added repository directory structure visualization with <code>--show-structure</code> option</li>
|
|
354
|
-
<li>Created <code>DirectoryStructureBuilder</code> class to generate tree views of repositories</li>
|
|
355
|
-
<li>Added <code>generate_directory_structure</code> method to the Generator class</li>
|
|
356
|
-
<li>Added tests for the directory structure visualization</li>
|
|
357
|
-
<li>Updated documentation with directory structure visualization examples</li>
|
|
358
|
-
</ul>
|
|
359
885
|
</div>
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
886
|
+
</div>
|
|
887
|
+
</section>
|
|
888
|
+
<script>
|
|
889
|
+
function copyUsageCode() {
|
|
890
|
+
const code = document.getElementById("usage-code").innerText;
|
|
891
|
+
navigator.clipboard.writeText(code).then(() => {
|
|
892
|
+
// Provide visual feedback (e.g., a temporary alert)
|
|
893
|
+
alert("Code copied to clipboard!");
|
|
894
|
+
}).catch(err => {
|
|
895
|
+
console.error("Failed to copy code: ", err);
|
|
896
|
+
});
|
|
897
|
+
}
|
|
898
|
+
</script>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
<section class="changelog" id="changelog">
|
|
902
|
+
<div class="container">
|
|
903
|
+
<h2>Changelog</h2>
|
|
904
|
+
<div class="timeline">
|
|
905
|
+
<div class="timeline-item">
|
|
906
|
+
<div class="timeline-date">
|
|
907
|
+
<span class="timeline-month">Mar</span>
|
|
908
|
+
<span class="timeline-day">18</span>
|
|
909
|
+
</div>
|
|
910
|
+
<div class="timeline-content">
|
|
911
|
+
<h3 class="timeline-version">v0.6.0</h3>
|
|
912
|
+
<p class="timeline-desc">Improved default branch handling and enhanced repository validation
|
|
913
|
+
with better error handling.</p>
|
|
914
|
+
<div class="timeline-list">
|
|
915
|
+
<ul>
|
|
916
|
+
<li>Use repository's actual default branch instead of hardcoding "main"</li>
|
|
917
|
+
<li>Enhanced error handling in repository access validation</li>
|
|
918
|
+
<li>Updated documentation for default branch behavior</li>
|
|
919
|
+
<li>Fixed repository validation in test environment</li>
|
|
920
|
+
</ul>
|
|
921
|
+
</div>
|
|
922
|
+
</div>
|
|
923
|
+
</div>
|
|
924
|
+
<div class="timeline-item">
|
|
925
|
+
<div class="timeline-date">
|
|
926
|
+
<span class="timeline-month">Mar</span>
|
|
927
|
+
<span class="timeline-day">04</span>
|
|
928
|
+
</div>
|
|
929
|
+
<div class="timeline-content">
|
|
930
|
+
<h3 class="timeline-version">v0.5.0</h3>
|
|
931
|
+
<p class="timeline-desc">Introduced repository directory structure visualization, added
|
|
932
|
+
DirectoryStructureBuilder, and improved concurrent processing with thread management.</p>
|
|
933
|
+
<div class="timeline-list">
|
|
934
|
+
<ul>
|
|
935
|
+
<li>Added <code>--show-structure</code> option</li>
|
|
936
|
+
<li>Created <code>DirectoryStructureBuilder</code> class</li>
|
|
937
|
+
<li>Integrated directory tree view generation</li>
|
|
938
|
+
</ul>
|
|
939
|
+
</div>
|
|
940
|
+
</div>
|
|
941
|
+
</div>
|
|
942
|
+
<div class="timeline-item">
|
|
943
|
+
<div class="timeline-date">
|
|
944
|
+
<span class="timeline-month">Mar</span>
|
|
945
|
+
<span class="timeline-day">04</span>
|
|
946
|
+
</div>
|
|
947
|
+
<div class="timeline-content">
|
|
948
|
+
<h3 class="timeline-version">v0.4.0</h3>
|
|
949
|
+
<p class="timeline-desc">Implemented in-memory prompt generation, visual progress bar, and
|
|
950
|
+
enhanced multithreaded operations.</p>
|
|
951
|
+
<div class="timeline-list">
|
|
952
|
+
<ul>
|
|
953
|
+
<li>Added <code>generate_prompt</code> method</li>
|
|
954
|
+
<li>Integrated visual progress bar</li>
|
|
955
|
+
<li>Improved logging and error handling</li>
|
|
956
|
+
</ul>
|
|
957
|
+
</div>
|
|
958
|
+
</div>
|
|
959
|
+
</div>
|
|
960
|
+
<div class="timeline-item">
|
|
961
|
+
<div class="timeline-date">
|
|
962
|
+
<span class="timeline-month">Mar</span>
|
|
963
|
+
<span class="timeline-day">03</span>
|
|
964
|
+
</div>
|
|
965
|
+
<div class="timeline-content">
|
|
966
|
+
<h3 class="timeline-version">v0.3.1</h3>
|
|
967
|
+
<p class="timeline-desc">Optimized threading with configurable options and introduced
|
|
968
|
+
exponential backoff for API requests.</p>
|
|
969
|
+
<div class="timeline-list">
|
|
970
|
+
<ul>
|
|
971
|
+
<li>Configurable threading options</li>
|
|
972
|
+
<li>Added thread-local buffers</li>
|
|
973
|
+
<li>Improved file exclusion performance</li>
|
|
974
|
+
</ul>
|
|
975
|
+
</div>
|
|
976
|
+
</div>
|
|
365
977
|
</div>
|
|
366
|
-
<ul class="changelog-list">
|
|
367
|
-
<li>Added <code>generate_prompt</code> method for in-memory content generation without file I/O</li>
|
|
368
|
-
<li>Integrated visual progress bar with file processing rate reporting</li>
|
|
369
|
-
<li>Added human-readable time formatting for progress estimates</li>
|
|
370
|
-
<li>Enhanced test coverage for multithreaded operations</li>
|
|
371
|
-
<li>Refactored <code>process_content_to_output</code> for better code reuse</li>
|
|
372
|
-
<li>Improved thread management to handle various error conditions gracefully</li>
|
|
373
|
-
<li>Fixed thread pool shutdown issues and race conditions</li>
|
|
374
|
-
</ul>
|
|
375
978
|
</div>
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
979
|
+
</div>
|
|
980
|
+
</section>
|
|
981
|
+
|
|
982
|
+
<footer class="footer">
|
|
983
|
+
<div class="footer-grid">
|
|
984
|
+
<div>
|
|
985
|
+
<div class="footer-logo">
|
|
986
|
+
<div class="footer-logo-icon">G</div>
|
|
987
|
+
<div class="logo-text">Gitingest</div>
|
|
988
|
+
</div>
|
|
989
|
+
<p class="footer-desc">A powerful Ruby gem to distill GitHub repositories into optimal prompts for LLMs.
|
|
990
|
+
</p>
|
|
991
|
+
<div class="social-links">
|
|
992
|
+
<a href="https://github.com/davidesantangelo/gitingest" class="social-link" target="_blank"
|
|
993
|
+
rel="noopener"><i class="fab fa-github"></i></a>
|
|
994
|
+
<a href="https://rubygems.org/gems/gitingest" class="social-link" target="_blank" rel="noopener"><i
|
|
995
|
+
class="fas fa-gem"></i></a>
|
|
381
996
|
</div>
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
<li>
|
|
387
|
-
<li
|
|
388
|
-
<li
|
|
389
|
-
<li>
|
|
997
|
+
</div>
|
|
998
|
+
<div>
|
|
999
|
+
<h3 class="footer-title">Features</h3>
|
|
1000
|
+
<ul class="footer-links">
|
|
1001
|
+
<li><a href="#features">Concurrent Processing</a></li>
|
|
1002
|
+
<li><a href="#features">Smart Filtering</a></li>
|
|
1003
|
+
<li><a href="#features">Real-Time Progress</a></li>
|
|
1004
|
+
<li><a href="#features">Directory Visualization</a></li>
|
|
390
1005
|
</ul>
|
|
391
1006
|
</div>
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
<
|
|
395
|
-
<
|
|
396
|
-
<
|
|
397
|
-
|
|
398
|
-
<ul class="changelog-list">
|
|
399
|
-
<li>Added <code>faraday-retry</code> gem dependency for better API rate limit handling</li>
|
|
400
|
-
<li>Implemented thread-safe buffer management with mutex locks</li>
|
|
401
|
-
<li>Added new <code>ProgressIndicator</code> class for better CLI progress reporting</li>
|
|
402
|
-
<li>Improved memory efficiency with configurable buffer size</li>
|
|
403
|
-
<li>Enhanced code organization with dedicated methods for file content formatting</li>
|
|
404
|
-
<li>Added comprehensive method documentation and parameter descriptions</li>
|
|
405
|
-
<li>Optimized thread pool size calculation for better performance</li>
|
|
406
|
-
<li>Improved error handling in concurrent operations</li>
|
|
1007
|
+
<div>
|
|
1008
|
+
<h3 class="footer-title">Usage</h3>
|
|
1009
|
+
<ul class="footer-links">
|
|
1010
|
+
<li><a href="#usage">Installation</a></li>
|
|
1011
|
+
<li><a href="#usage">Command Line</a></li>
|
|
1012
|
+
<li><a href="#usage">Library Integration</a></li>
|
|
407
1013
|
</ul>
|
|
408
1014
|
</div>
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
<
|
|
412
|
-
<
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
<li>Added the ability to specify a custom output file for the prompt</li>
|
|
418
|
-
<li>Enhanced error handling with logging support</li>
|
|
419
|
-
<li>Added logging functionality with custom loggers</li>
|
|
420
|
-
<li>Introduced rate limit handling with retries for file fetching</li>
|
|
421
|
-
<li>Added repository branch support</li>
|
|
422
|
-
<li>Exclude specific file patterns via command-line arguments</li>
|
|
423
|
-
<li>Enforced a 1000 file limit to prevent memory overload</li>
|
|
1015
|
+
<div>
|
|
1016
|
+
<h3 class="footer-title">Resources</h3>
|
|
1017
|
+
<ul class="footer-links">
|
|
1018
|
+
<li><a href="https://github.com/davidesantangelo/gitingest" target="_blank"
|
|
1019
|
+
rel="noopener">GitHub</a></li>
|
|
1020
|
+
<li><a href="https://rubygems.org/gems/gitingest" target="_blank" rel="noopener">RubyGems</a></li>
|
|
1021
|
+
<li><a href="https://opensource.org/licenses/MIT" target="_blank" rel="noopener">MIT License</a>
|
|
1022
|
+
</li>
|
|
424
1023
|
</ul>
|
|
425
1024
|
</div>
|
|
426
1025
|
</div>
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
<h2>Acknowledgements</h2>
|
|
432
|
-
<p>Inspired by <a href="https://github.com/cyclotruc/gitingest"><code>cyclotruc/gitingest</code></a>.</p>
|
|
433
|
-
|
|
434
|
-
<h2>License</h2>
|
|
435
|
-
<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
436
|
-
</div>
|
|
437
|
-
|
|
438
|
-
<footer>
|
|
439
|
-
<p>© 2025 David Santangelo</p>
|
|
440
|
-
<p>Last updated: March 4, 2025</p>
|
|
1026
|
+
<div class="copyright">
|
|
1027
|
+
© 2025 David Santangelo. All rights reserved.
|
|
1028
|
+
</div>
|
|
441
1029
|
</footer>
|
|
442
1030
|
</body>
|
|
443
|
-
|
|
1031
|
+
|
|
1032
|
+
</html>
|