-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdocs.html
More file actions
2711 lines (2515 loc) · 129 KB
/
docs.html
File metadata and controls
2711 lines (2515 loc) · 129 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>GitWhisper Documentation - Complete Setup Guide</title>
<meta
name="description"
content="Complete documentation for GitWhisper - AI-powered Git commit message generator. Setup guides, API keys, and detailed usage instructions."
/>
<meta
name="keywords"
content="git, commit, ai, documentation, setup, api keys, guide"
/>
<!-- Open Graph Meta Tags -->
<meta
property="og:title"
content="GitWhisper Documentation - Complete Setup Guide"
/>
<meta
property="og:description"
content="Complete setup guide for GitWhisper including API key configuration, usage examples, and troubleshooting."
/>
<meta property="og:type" content="website" />
<meta
property="og:url"
content="https://iamngoni.github.io/gitwhisper/docs.html"
/>
<!-- Favicon -->
<link
rel="icon"
href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>📚</text></svg>"
/>
<!-- CSS Libraries -->
<link
href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
rel="stylesheet"
/>
<link
href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css"
rel="stylesheet"
/>
<!-- Custom Styles -->
<style>
:root {
--primary: #6366f1;
--primary-dark: #4f46e5;
--secondary: #8b5cf6;
--accent: #06b6d4;
--dark: #0f172a;
--gray-dark: #1e293b;
--gray-medium: #475569;
--gray-light: #f1f5f9;
--success: #10b981;
--warning: #f59e0b;
--error: #ef4444;
}
* {
font-family: "Inter", sans-serif;
}
.font-mono {
font-family: "JetBrains Mono", monospace;
}
.gradient-bg {
background: linear-gradient(
135deg,
var(--primary) 0%,
var(--secondary) 100%
);
}
.gradient-text {
background: linear-gradient(
135deg,
var(--primary),
var(--secondary)
);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
.docs-nav {
position: sticky;
top: 80px;
max-height: calc(100vh - 100px);
overflow-y: auto;
}
.docs-content {
scroll-behavior: smooth;
}
.docs-content h2,
.docs-content h3,
.docs-content h4 {
scroll-margin-top: 100px;
}
.code-block {
background: var(--dark);
border-radius: 12px;
padding: 1.5rem;
position: relative;
overflow-x: auto;
}
.code-block::before {
content: "";
position: absolute;
top: 0;
left: 0;
right: 0;
height: 3px;
background: linear-gradient(
90deg,
#ff6b6b,
#4ecdc4,
#45b7d1,
#96ceb4
);
}
.copy-btn {
position: absolute;
top: 1rem;
right: 1rem;
background: rgba(255, 255, 255, 0.1);
border: 1px solid rgba(255, 255, 255, 0.2);
color: white;
padding: 0.5rem;
border-radius: 0.5rem;
cursor: pointer;
transition: all 0.3s ease;
}
.copy-btn:hover {
background: rgba(255, 255, 255, 0.2);
}
.nav-link {
transition: all 0.3s ease;
border-left: 3px solid transparent;
padding: 0.75rem 1rem;
cursor: pointer;
border-radius: 0.5rem;
margin-bottom: 0.5rem;
}
.nav-link:hover,
.nav-link.active {
border-left-color: var(--primary);
background: rgba(99, 102, 241, 0.1);
color: var(--primary);
}
.tab-content {
display: none !important;
}
.tab-content.active {
display: block !important;
}
.alert {
border-radius: 12px;
padding: 1rem 1.5rem;
margin: 1.5rem 0;
border-left: 4px solid;
}
.alert-info {
background: rgba(6, 182, 212, 0.1);
border-color: var(--accent);
color: #0891b2;
}
.alert-warning {
background: rgba(245, 158, 11, 0.1);
border-color: var(--warning);
color: #d97706;
}
.alert-success {
background: rgba(16, 185, 129, 0.1);
border-color: var(--success);
color: #059669;
}
.alert-error {
background: rgba(239, 68, 68, 0.1);
border-color: var(--error);
color: #dc2626;
}
.step-card {
background: white;
border-radius: 12px;
padding: 2rem;
box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1);
border: 1px solid #e5e7eb;
margin-bottom: 2rem;
transition: all 0.3s ease;
}
.step-card:hover {
box-shadow: 0 10px 25px -3px rgba(0, 0, 0, 0.1);
transform: translateY(-2px);
}
.step-number {
background: var(--primary);
color: white;
width: 2.5rem;
height: 2.5rem;
border-radius: 50%;
display: flex;
align-items: center;
justify-content: center;
font-weight: bold;
margin-bottom: 1rem;
}
.breadcrumb {
background: rgba(99, 102, 241, 0.1);
padding: 1rem 1.5rem;
border-radius: 12px;
margin-bottom: 2rem;
}
.table-container {
overflow-x: auto;
background: white;
border-radius: 12px;
box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1);
}
.docs-table {
width: 100%;
border-collapse: collapse;
}
.docs-table th,
.docs-table td {
padding: 1rem;
text-align: left;
border-bottom: 1px solid #e5e7eb;
}
.docs-table th {
background: #f9fafb;
font-weight: 600;
color: #374151;
}
.docs-table tbody tr:hover {
background: #f9fafb;
}
.scroll-indicator {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 4px;
background: rgba(99, 102, 241, 0.2);
z-index: 1000;
}
.scroll-progress {
height: 100%;
background: linear-gradient(
90deg,
var(--primary),
var(--secondary)
);
width: 0%;
transition: width 0.1s ease;
}
@media (max-width: 1024px) {
.docs-nav {
position: static;
max-height: none;
margin-bottom: 2rem;
}
.grid.lg\\:grid-cols-4 {
grid-template-columns: 1fr;
gap: 1.5rem;
}
}
@media (max-width: 768px) {
.step-card {
padding: 1.5rem;
margin-bottom: 1.5rem;
}
.code-block {
padding: 1rem;
overflow-x: auto;
}
.docs-content h2,
.docs-content h3,
.docs-content h4 {
scroll-margin-top: 120px;
}
.grid {
grid-template-columns: 1fr !important;
gap: 1rem !important;
}
.docs-table {
font-size: 0.875rem;
}
.docs-table th,
.docs-table td {
padding: 0.75rem;
}
.breadcrumb {
padding: 0.75rem 1rem;
}
.alert {
padding: 1rem;
margin: 1rem 0;
}
}
@media (max-width: 640px) {
.step-card {
padding: 1rem;
}
.code-block {
padding: 0.75rem;
font-size: 0.875rem;
}
.copy-btn {
padding: 0.25rem;
font-size: 0.75rem;
}
.step-number {
width: 2rem;
height: 2rem;
font-size: 0.875rem;
}
}
</style>
</head>
<body class="bg-gray-50">
<!-- Scroll Progress Indicator -->
<div class="scroll-indicator">
<div class="scroll-progress" id="scrollProgress"></div>
</div>
<!-- Navigation -->
<nav
class="fixed top-0 w-full z-50 bg-white/80 backdrop-blur-md border-b border-gray-200"
>
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between items-center h-16">
<div class="flex items-center space-x-4">
<a
href="index.html"
class="flex items-center space-x-2"
>
<img
src="assets/images/logo.png"
alt="GitWhisper Logo"
class="h-20 w-20"
/>
</a>
<span class="text-gray-400">/</span>
<span class="text-gray-600 font-medium">Docs</span>
</div>
<div class="flex items-center space-x-2 sm:space-x-4">
<a
href="index.html"
class="text-gray-600 hover:text-indigo-600 transition-colors text-sm sm:text-base"
>
<i class="fas fa-home mr-1"></i>
<span class="hidden sm:inline">Home</span>
</a>
<a
href="https://github.com/iamngoni/gitwhisper"
target="_blank"
class="text-gray-600 hover:text-indigo-600 transition-colors"
>
<i class="fab fa-github text-lg sm:text-xl"></i>
</a>
</div>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="pt-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<!-- Breadcrumb -->
<div class="breadcrumb">
<nav class="flex" aria-label="Breadcrumb">
<ol class="flex items-center space-x-2">
<li>
<a
href="index.html"
class="text-indigo-600 hover:text-indigo-800"
>
Home
</a>
</li>
<li>
<span class="text-gray-400">/</span>
</li>
<li>
<span class="text-gray-600 font-medium"
>Documentation</span
>
</li>
</ol>
</nav>
</div>
<div class="grid grid-cols-1 lg:grid-cols-4 gap-6 lg:gap-8">
<!-- Sidebar Navigation -->
<div class="lg:col-span-1 mb-8 lg:mb-0">
<div
class="docs-nav bg-white rounded-lg p-4 lg:p-0 lg:bg-transparent shadow-md lg:shadow-none"
>
<h3
class="text-lg font-semibold text-gray-900 mb-4"
>
Table of Contents
</h3>
<nav class="space-y-2">
<div
class="nav-link active block text-gray-600 hover:text-indigo-600"
data-tab="getting-started"
>
Getting Started
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="editor-integrations"
>
Editor Integrations
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="installation"
>
Installation
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="api-keys"
>
API Keys Setup
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="first-commit"
>
Your First Commit
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="interactive-workflow"
>
Interactive Workflow
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="configuration"
>
Configuration
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="language-config"
>
Language Settings
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="ai-models"
>
AI Models
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="advanced-usage"
>
Advanced Usage
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="troubleshooting"
>
Troubleshooting
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="examples"
>
Examples
</div>
<div
class="nav-link block text-gray-600 hover:text-indigo-600"
data-tab="faq"
>
FAQ
</div>
</nav>
</div>
</div>
<!-- Main Documentation Content -->
<div class="lg:col-span-3 docs-content">
<!-- Getting Started -->
<div
id="getting-started"
class="tab-content mb-16"
style="display: none"
>
<!-- Header -->
<div class="mb-12">
<h1
class="text-4xl md:text-5xl font-bold text-gray-900 mb-4"
>
GitWhisper
<span class="gradient-text"
>Documentation</span
>
</h1>
<p class="text-xl text-gray-600 max-w-3xl">
Complete guide to setting up and using
GitWhisper - the AI-powered Git commit
message generator that whispers the perfect
commit message for your changes.
</p>
</div>
<h2
class="text-3xl font-bold text-gray-900 mb-6 flex items-center"
>
<i
class="fas fa-rocket text-indigo-600 mr-3"
></i>
Getting Started
</h2>
<div class="alert alert-info">
<div class="flex items-start">
<i
class="fas fa-info-circle text-xl mr-3 mt-1"
></i>
<div>
<strong>Prerequisites:</strong> Make
sure you have Git installed and are in a
Git repository. You'll also need an API
key from at least one AI provider.
</div>
</div>
</div>
<p class="text-gray-600 mb-6">
GitWhisper analyzes your staged Git changes and
uses AI to generate meaningful commit messages
following conventional commit format with
emojis. It features an interactive confirmation
workflow and supports multiple AI models
including OpenAI GPT, Claude, Gemini, GitHub
Models, and more.
</p>
<div
class="grid grid-cols-1 md:grid-cols-3 gap-4 md:gap-6 mb-8"
>
<div
class="text-center p-6 bg-white rounded-lg shadow-md"
>
<i
class="fas fa-download text-3xl text-indigo-600 mb-4"
></i>
<h3 class="text-lg font-semibold mb-2">
1. Install
</h3>
<p class="text-gray-600 text-sm">
Choose your preferred installation
method
</p>
</div>
<div
class="text-center p-6 bg-white rounded-lg shadow-md"
>
<i
class="fas fa-key text-3xl text-indigo-600 mb-4"
></i>
<h3 class="text-lg font-semibold mb-2">
2. Setup API Key
</h3>
<p class="text-gray-600 text-sm">
Configure your AI provider credentials
</p>
</div>
<div
class="text-center p-6 bg-white rounded-lg shadow-md"
>
<i
class="fas fa-magic text-3xl text-indigo-600 mb-4"
></i>
<h3 class="text-lg font-semibold mb-2">
3. Generate Commits
</h3>
<p class="text-gray-600 text-sm">
Let AI create perfect commit messages
</p>
</div>
</div>
</div>
<!-- Editor Integrations -->
<div
id="editor-integrations"
class="tab-content mb-16"
style="display: none"
>
<h2
class="text-3xl font-bold text-gray-900 mb-6 flex items-center"
>
<i class="fas fa-plug text-indigo-600 mr-3"></i>
Editor Integrations
</h2>
<p class="text-gray-600 mb-8">
GitWhisper is available as plugins for popular
code editors, providing seamless integration
with your existing workflow. These plugins allow
you to generate commit messages directly within
your IDE without switching to the command line.
</p>
<!-- VS Code Extension -->
<div class="step-card">
<h3
class="text-xl font-semibold mb-4 flex items-center"
>
<i
class="fab fa-microsoft text-blue-600 mr-2"
></i>
Visual Studio Code Extension
</h3>
<div class="mb-4">
<p class="text-gray-600 mb-3">
<strong>Developer:</strong> Panashe
Mushinyi
</p>
<p class="text-gray-600 mb-4">
The VS Code extension provides seamless
integration with Visual Studio Code's
built-in Git interface, allowing you to
generate AI-powered commit messages
without leaving your editor.
</p>
</div>
<div class="mb-4">
<h4
class="font-semibold text-gray-900 mb-2"
>
Features:
</h4>
<ul class="text-gray-600 space-y-1 ml-4">
<li>
• Generate commit messages from
staged changes
</li>
<li>
• Works with VS Code's built-in Git
tools
</li>
<li>• Easy one-click installation</li>
<li>• No command line required</li>
<li>
• Supports all GitWhisper AI models
</li>
</ul>
</div>
<div class="mb-4">
<h4
class="font-semibold text-gray-900 mb-2"
>
Installation:
</h4>
<ol
class="list-decimal list-inside space-y-2 text-gray-600 mb-4"
>
<li>Open VS Code</li>
<li>Go to Extensions (Ctrl+Shift+X)</li>
<li>Search for "GitWhisper"</li>
<li>
Click "Install" on the GitWhisper
extension
</li>
</ol>
<p class="text-gray-600 mb-4">
Or install directly from the
marketplace:
</p>
<a
href="https://marketplace.visualstudio.com/items?itemName=gitwhisper.gitwhisper"
target="_blank"
class="inline-flex items-center space-x-2 bg-blue-600 hover:bg-blue-700 text-white px-4 py-2 rounded-lg transition-colors"
>
<i class="fas fa-external-link-alt"></i>
<span>View in VS Code Marketplace</span>
</a>
</div>
</div>
<!-- JetBrains Plugin -->
<div class="step-card">
<h3
class="text-xl font-semibold mb-4 flex items-center"
>
<i
class="fas fa-code text-purple-600 mr-2"
></i>
JetBrains IDEs Plugin
</h3>
<div class="mb-4">
<p class="text-gray-600 mb-3">
<strong>Developer:</strong> Panashe
Mushinyi
</p>
<p class="text-gray-600 mb-4">
The JetBrains plugin is compatible with
all JetBrains IDEs including IntelliJ
IDEA, WebStorm, PhpStorm, PyCharm,
RubyMine, CLion, GoLand, DataGrip, and
more.
</p>
</div>
<div class="mb-4">
<h4
class="font-semibold text-gray-900 mb-2"
>
Features:
</h4>
<ul class="text-gray-600 space-y-1 ml-4">
<li>
• Integrated with JetBrains VCS
tools
</li>
<li>
• Support for all JetBrains IDEs
</li>
<li>• Native IDE experience</li>
<li>
• Context-aware commit message
generation
</li>
<li>
• Works with built-in Git
integration
</li>
</ul>
</div>
<div class="mb-4">
<h4
class="font-semibold text-gray-900 mb-2"
>
Supported IDEs:
</h4>
<div
class="grid grid-cols-2 md:grid-cols-3 gap-2 text-gray-600 text-sm mb-4"
>
<div>• IntelliJ IDEA</div>
<div>• WebStorm</div>
<div>• PhpStorm</div>
<div>• PyCharm</div>
<div>• RubyMine</div>
<div>• CLion</div>
<div>• GoLand</div>
<div>• DataGrip</div>
<div>• Rider</div>
<div>• AppCode</div>
<div>• Android Studio</div>
<div>• And more...</div>
</div>
</div>
<div class="mb-4">
<h4
class="font-semibold text-gray-900 mb-2"
>
Installation:
</h4>
<ol
class="list-decimal list-inside space-y-2 text-gray-600 mb-4"
>
<li>Open your JetBrains IDE</li>
<li>
Go to File → Settings (or
Preferences on Mac)
</li>
<li>Navigate to Plugins</li>
<li>Click on "Marketplace" tab</li>
<li>Search for "GitWhisper"</li>
<li>
Click "Install" and restart your IDE
</li>
</ol>
<p class="text-gray-600 mb-4">
Or install directly from the JetBrains
Plugin Repository:
</p>
<a
href="https://plugins.jetbrains.com/plugin/28057-gitwhisper"
target="_blank"
class="inline-flex items-center space-x-2 bg-purple-600 hover:bg-purple-700 text-white px-4 py-2 rounded-lg transition-colors"
>
<i class="fas fa-external-link-alt"></i>
<span
>View in JetBrains Repository</span
>
</a>
</div>
</div>
<div class="alert alert-info">
<div class="flex items-start">
<i
class="fas fa-info-circle text-xl mr-3 mt-1"
></i>
<div>
<strong>Note:</strong> Both plugins
require the same API key setup as the
CLI tool. You can configure your API
keys through the plugin settings or use
environment variables. <br /><br />
For command line users, you can still
install the CLI tool alongside these
plugins for maximum flexibility.
</div>
</div>
</div>
</div>
<!-- Installation -->
<div
id="installation"
class="tab-content mb-16"
style="display: none"
>
<h2
class="text-3xl font-bold text-gray-900 mb-6 flex items-center"
>
<i
class="fas fa-download text-indigo-600 mr-3"
></i>
Installation
</h2>
<div class="space-y-6">
<!-- Dart Installation -->
<div class="step-card">
<div class="step-number">1</div>
<h3 class="text-xl font-semibold mb-3">
Dart Package Manager (Recommended)
</h3>
<p class="text-gray-600 mb-4">
If you have Dart installed, this is the
easiest method:
</p>
<div class="code-block">
<button
class="copy-btn"
data-copy="dart pub global activate gitwhisper"
>
<i class="fas fa-copy"></i>
</button>
<pre
class="font-mono text-white"
><code>dart pub global activate gitwhisper</code></pre>
</div>
</div>
<!-- Homebrew Installation -->
<div class="step-card">
<div class="step-number">2</div>
<h3 class="text-xl font-semibold mb-3">
Homebrew (macOS)
</h3>
<p class="text-gray-600 mb-4">
For macOS users with Homebrew:
</p>
<div class="code-block">
<button
class="copy-btn"
data-copy="brew tap iamngoni/homebrew-gitwhisper && brew install gitwhisper"
>
<i class="fas fa-copy"></i>
</button>
<pre
class="font-mono text-white"
><code>brew tap iamngoni/homebrew-gitwhisper
brew install gitwhisper</code></pre>
</div>
</div>
<!-- APT Installation -->
<div class="step-card">
<div class="step-number">3</div>
<h3 class="text-xl font-semibold mb-3">
APT (Debian/Ubuntu)
</h3>
<p class="text-gray-600 mb-4">
For Debian-based Linux distributions:
</p>
<div class="code-block">
<button
class="copy-btn"
data-copy="echo 'deb [trusted=yes] https://iamngoni.github.io/gitwhisper-apt stable main' | sudo tee /etc/apt/sources.list.d/gitwhisper.list && sudo apt update && sudo apt install gitwhisper"
>
<i class="fas fa-copy"></i>
</button>
<pre
class="font-mono text-white"
><code>echo "deb [trusted=yes] https://iamngoni.github.io/gitwhisper-apt stable main" | sudo tee /etc/apt/sources.list.d/gitwhisper.list
sudo apt update
sudo apt install gitwhisper</code></pre>
</div>
</div>
<!-- PowerShell Installation -->
<div class="step-card">
<div class="step-number">4</div>
<h3 class="text-xl font-semibold mb-3">
PowerShell (Windows)
</h3>
<p class="text-gray-600 mb-4">
For Windows users with PowerShell (run
as Administrator):
</p>
<div class="code-block">
<button
class="copy-btn"
data-copy="irm https://raw.githubusercontent.com/iamngoni/gitwhisper/master/install.ps1 | iex"
>
<i class="fas fa-copy"></i>
</button>
<pre
class="font-mono text-white"
><code>irm https://raw.githubusercontent.com/iamngoni/gitwhisper/master/install.ps1 | iex</code></pre>
</div>
</div>
<!-- cURL Installation -->
<div class="step-card">
<div class="step-number">5</div>
<h3 class="text-xl font-semibold mb-3">
cURL (Unix/Linux/macOS)
</h3>
<p class="text-gray-600 mb-4">
Universal installation script for
Unix-based systems:
</p>
<div class="code-block">