-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation.html
More file actions
2031 lines (1666 loc) · 73 KB
/
documentation.html
File metadata and controls
2031 lines (1666 loc) · 73 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>Promptheus Documentation - Complete Guide to CLI and Web</title>
<meta name="description" content="Comprehensive documentation for Promptheus CLI and Web UI. Learn how to transform raw prompts into AI gold.">
<!-- Favicon Implementation -->
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
<link rel="manifest" href="site.webmanifest">
<meta name="theme-color" content="#1a1a1a">
<style>
/* Import distinctive fonts */
@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Serif:wght@400;600;700&family=Fira+Code:wght@400;600&display=swap');
/* CSS Reset & Base Styles */
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
:root {
--bg-primary: #0A0E1A;
--bg-secondary: #151F2E;
--bg-tertiary: #1E293B;
--accent-gold: #D4A574;
--accent-gold-light: #E5B88A;
--accent-gold-dark: #B8935F;
--accent-emerald: #4ADE80;
--accent-cyan: #06B6D4;
--accent-rose: #F43F5E;
--text-primary: #E2E8F0;
--text-secondary: #94A3B8;
--text-muted: #64748B;
--gradient-primary: linear-gradient(135deg, #0A0E1A 0%, #151F2E 50%, #1E293B 100%);
--gradient-gold: linear-gradient(135deg, #D4A574 0%, #E5B88A 100%);
--shadow-gold: 0 0 30px rgba(212, 165, 116, 0.3);
--sidebar-width: 280px;
}
@font-face {
font-family: 'IBM Plex Serif';
font-display: swap;
}
@font-face {
font-family: 'Fira Code';
font-display: swap;
}
body {
font-family: 'IBM Plex Serif', Georgia, serif;
line-height: 1.7;
color: var(--text-primary);
background: var(--bg-primary);
overflow-x: hidden;
}
/* Layout */
.docs-container {
display: flex;
min-height: 100vh;
}
/* Sidebar */
.sidebar {
position: fixed;
left: 0;
top: 0;
width: var(--sidebar-width);
height: 100vh;
background: var(--bg-secondary);
border-right: 1px solid rgba(212, 165, 116, 0.2);
overflow-y: auto;
z-index: 100;
padding: 2rem 0;
}
.sidebar-header {
padding: 0 1.5rem 1.5rem;
border-bottom: 1px solid rgba(212, 165, 116, 0.2);
margin-bottom: 1.5rem;
}
.sidebar-header h1 {
font-size: 1.5rem;
background: var(--gradient-gold);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
margin-bottom: 0.5rem;
}
.sidebar-header p {
color: var(--text-secondary);
font-size: 0.875rem;
}
.sidebar-nav {
padding: 0 1rem;
}
.nav-section {
margin-bottom: 1.5rem;
}
.nav-section-title {
color: var(--accent-gold);
font-size: 0.75rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.05em;
padding: 0.5rem 0.5rem;
margin-bottom: 0.5rem;
}
.nav-links {
list-style: none;
}
.nav-links li {
margin-bottom: 0.25rem;
}
.nav-links a {
display: block;
padding: 0.5rem 0.75rem;
color: var(--text-secondary);
text-decoration: none;
border-radius: 6px;
transition: all 0.2s ease;
font-size: 0.9rem;
}
.nav-links a:hover {
color: var(--text-primary);
background: var(--bg-tertiary);
}
.nav-links a.active {
color: var(--accent-gold);
background: var(--bg-tertiary);
font-weight: 600;
}
/* Main Content */
.main-content {
margin-left: var(--sidebar-width);
flex: 1;
padding: 3rem;
max-width: 1200px;
}
/* Typography */
h1, h2, h3, h4, h5, h6 {
font-family: 'IBM Plex Serif', Georgia, serif;
font-weight: 700;
line-height: 1.1;
margin-bottom: 1rem;
margin-top: 2rem;
}
h1 {
font-size: clamp(2rem, 4vw, 2.5rem);
background: var(--gradient-gold);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
letter-spacing: -0.02em;
}
h2 {
font-size: clamp(1.5rem, 3vw, 2rem);
color: var(--accent-gold);
padding-bottom: 0.75rem;
padding-left: 1rem;
border-left: 4px solid var(--accent-gold);
border-bottom: none;
position: relative;
letter-spacing: -0.01em;
}
h2::before {
content: '';
display: inline-block;
width: 1.25rem;
height: 1.25rem;
margin-right: 0.5rem;
background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23D4A574' d='M9 2v5.5L4 17c-.6 1.2.1 2.5 1.5 2.5h13c1.4 0 2.1-1.3 1.5-2.5l-5-9.5V2h-6zm2 1h2v5l.4.8 1.6 3.2H9l1.6-3.2.4-.8V3z'/%3E%3Ccircle cx='9' cy='13' r='1' fill='%23D4A574'/%3E%3Ccircle cx='15' cy='15' r='1' fill='%23D4A574'/%3E%3C/svg%3E");
background-size: contain;
background-repeat: no-repeat;
vertical-align: middle;
opacity: 0.7;
}
h3 {
font-size: clamp(1.25rem, 2.5vw, 1.5rem);
color: var(--accent-gold-light);
padding-left: 0.75rem;
border-left: 3px solid var(--accent-emerald);
transition: border-color 0.3s ease;
}
h3:hover {
border-left-color: var(--accent-cyan);
}
h4 {
font-size: 1.125rem;
color: var(--text-primary);
font-weight: 600;
}
p {
margin-bottom: 1rem;
color: var(--text-secondary);
line-height: 1.7;
}
/* Inline Code */
code {
background: rgba(212, 165, 116, 0.1);
padding: 0.2rem 0.5rem;
border-radius: 4px;
font-family: 'Fira Code', monospace;
font-size: 0.9em;
color: var(--accent-emerald);
border: 1px solid rgba(212, 165, 116, 0.2);
}
pre {
background: linear-gradient(135deg, #0F1117 0%, #161B22 100%);
padding: 0;
border-radius: 12px;
overflow: hidden;
margin-bottom: 1.5rem;
border: 1px solid rgba(212, 165, 116, 0.15);
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3), inset 0 1px 0 rgba(212, 165, 116, 0.1);
position: relative;
}
pre::before {
content: attr(data-label);
display: block;
background: linear-gradient(90deg, rgba(212, 165, 116, 0.1) 0%, transparent 100%);
padding: 0.75rem 1.5rem;
color: var(--accent-gold);
font-size: 0.85rem;
font-weight: 600;
border-bottom: 1px solid rgba(212, 165, 116, 0.1);
font-family: 'Fira Code', monospace;
letter-spacing: 0.05em;
min-height: 1.5rem;
}
pre code {
background: none;
padding: 1.5rem;
color: var(--text-primary);
display: block;
font-family: 'Fira Code', monospace;
font-size: 0.95rem;
line-height: 1.6;
}
/* Code Block Copy Button */
.code-block-wrapper {
position: relative;
margin-bottom: 1.5rem;
}
.copy-button {
position: absolute;
top: 0.5rem;
right: 0.5rem;
background: transparent;
border: none;
color: rgba(212, 165, 116, 0.4);
padding: 0.5rem;
cursor: pointer;
transition: all 0.2s ease;
z-index: 10;
display: flex;
align-items: center;
justify-content: center;
line-height: 1;
}
.copy-button svg {
stroke-linecap: round;
stroke-linejoin: round;
}
.copy-button:hover {
color: var(--accent-gold);
}
.copy-button.copied {
color: var(--accent-emerald);
}
/* Tables */
table {
width: 100%;
border-collapse: collapse;
margin-bottom: 1.5rem;
background: var(--bg-secondary);
border-radius: 8px;
overflow: hidden;
}
th, td {
padding: 0.75rem 1rem;
text-align: left;
border-bottom: 1px solid rgba(212, 165, 116, 0.1);
}
th {
background: var(--bg-tertiary);
color: var(--accent-gold);
font-weight: 600;
}
td {
color: var(--text-secondary);
}
tr:last-child td {
border-bottom: none;
}
/* Lists */
ul, ol {
margin-bottom: 1rem;
padding-left: 1.5rem;
}
li {
margin-bottom: 0.5rem;
color: var(--text-secondary);
}
/* Info Boxes - Enhanced */
.info-box {
background: linear-gradient(135deg, rgba(212, 165, 116, 0.08) 0%, rgba(212, 165, 116, 0.03) 100%);
border-left: 5px solid var(--accent-gold);
border-radius: 8px;
padding: 1.5rem;
margin-bottom: 1.5rem;
border-top: 1px solid rgba(212, 165, 116, 0.2);
border-right: 1px solid rgba(212, 165, 116, 0.1);
border-bottom: 1px solid rgba(212, 165, 116, 0.1);
box-shadow: 0 4px 12px rgba(212, 165, 116, 0.08), inset 0 1px 0 rgba(212, 165, 116, 0.1);
transition: all 0.3s ease;
}
.info-box:hover {
border-left-color: var(--accent-emerald);
background: linear-gradient(135deg, rgba(212, 165, 116, 0.12) 0%, rgba(212, 165, 116, 0.05) 100%);
}
.info-box h4 {
color: var(--accent-gold);
margin-top: 0;
margin-bottom: 0.75rem;
font-size: 1.1rem;
display: flex;
align-items: center;
gap: 0.5rem;
}
.info-box p {
color: var(--text-secondary);
margin: 0.5rem 0;
}
.info-box pre {
background: var(--bg-tertiary);
border: 1px solid rgba(212, 165, 116, 0.2);
margin-top: 1rem;
}
/* Back to Top Button */
.back-to-top {
position: fixed;
bottom: 2rem;
right: 2rem;
background: var(--gradient-gold);
color: var(--bg-primary);
width: 50px;
height: 50px;
border-radius: 50%;
display: flex;
align-items: center;
justify-content: center;
cursor: pointer;
opacity: 0;
visibility: hidden;
transition: all 0.3s ease;
box-shadow: var(--shadow-gold);
font-size: 1.5rem;
text-decoration: none;
}
.back-to-top.visible {
opacity: 1;
visibility: visible;
}
.back-to-top:hover {
transform: translateY(-5px);
}
/* Mobile Styles */
@media (max-width: 768px) {
.sidebar {
transform: translateX(-100%);
transition: transform 0.3s ease;
}
.sidebar.open {
transform: translateX(0);
}
.main-content {
margin-left: 0;
padding: 1.5rem;
}
.mobile-menu-toggle {
position: fixed;
top: 1rem;
left: 1rem;
z-index: 101;
background: var(--gradient-gold);
color: var(--bg-primary);
width: 40px;
height: 40px;
border-radius: 8px;
border: none;
cursor: pointer;
display: flex;
align-items: center;
justify-content: center;
font-size: 1.25rem;
}
}
@media (min-width: 769px) {
.mobile-menu-toggle {
display: none;
}
}
/* Section styling */
section {
margin-bottom: 3rem;
}
/* Smooth Scrolling */
html {
scroll-behavior: smooth;
}
/* Command blocks - Enhanced */
.command {
background: linear-gradient(135deg, var(--bg-tertiary) 0%, rgba(30, 41, 59, 0.8) 100%);
border-left: 4px solid var(--accent-cyan);
padding: 1.25rem;
margin-bottom: 1.25rem;
border-radius: 8px;
border-top: 1px solid rgba(6, 182, 212, 0.2);
position: relative;
transition: all 0.3s ease;
}
.command:hover {
border-left-color: var(--accent-emerald);
background: linear-gradient(135deg, rgba(30, 41, 59, 1) 0%, rgba(30, 41, 59, 0.95) 100%);
box-shadow: 0 4px 12px rgba(6, 182, 212, 0.1);
}
.command::before {
content: attr(data-type);
position: absolute;
top: 0.75rem;
right: 1.25rem;
background: rgba(212, 165, 116, 0.15);
color: var(--accent-gold);
padding: 0.3rem 0.75rem;
border-radius: 12px;
font-size: 0.75rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.05em;
border: 1px solid rgba(212, 165, 116, 0.3);
}
.command-title {
color: var(--accent-emerald);
font-weight: 700;
margin-bottom: 0.75rem;
font-family: 'Fira Code', monospace;
font-size: 1.05rem;
letter-spacing: 0.02em;
}
.command p {
color: var(--text-secondary);
margin: 0;
font-size: 0.95rem;
}
/* Enhanced focus states */
*:focus-visible {
outline: 3px solid var(--accent-gold);
outline-offset: 3px;
border-radius: 4px;
}
/* Reduced motion support */
@media (prefers-reduced-motion: reduce) {
.back-to-top,
.nav-links a,
.info-box,
.command,
* {
animation-duration: 0.01ms !important;
animation-iteration-count: 1 !important;
transition-duration: 0.01ms !important;
}
}
/* Additional responsive breakpoints */
@media (max-width: 480px) {
.main-content {
padding: 1.5rem;
}
.sidebar {
width: 85%;
max-width: 300px;
}
}
@media (min-width: 481px) and (max-width: 768px) {
.main-content {
padding: 2rem;
}
}
</style>
</head>
<body>
<!-- SVG Icon Sprite -->
<svg style="display: none;" aria-hidden="true">
<defs>
<!-- Alchemical Flask Icon -->
<symbol id="icon-flask" viewBox="0 0 24 24">
<path fill="currentColor" d="M9 2v5.5L4 17c-.6 1.2.1 2.5 1.5 2.5h13c1.4 0 2.1-1.3 1.5-2.5l-5-9.5V2h-6zm2 1h2v5l.4.8 1.6 3.2H9l1.6-3.2.4-.8V3z"/>
<circle cx="9" cy="13" r="1" fill="currentColor"/>
<circle cx="15" cy="15" r="1" fill="currentColor"/>
</symbol>
</defs>
</svg>
<button class="mobile-menu-toggle" onclick="toggleMobileMenu()" aria-label="Toggle navigation menu">☰</button>
<div class="docs-container">
<!-- Sidebar Navigation -->
<aside class="sidebar" id="sidebar">
<div class="sidebar-header">
<h1 style="display: flex; align-items: center; gap: 0.5rem;">
<svg width="24" height="24" viewBox="0 0 24 24" aria-hidden="true">
<path fill="currentColor" d="M9 2v5.5L4 17c-.6 1.2.1 2.5 1.5 2.5h13c1.4 0 2.1-1.3 1.5-2.5l-5-9.5V2h-6zm2 1h2v5l.4.8 1.6 3.2H9l1.6-3.2.4-.8V3z"/>
<circle cx="9" cy="13" r="1" fill="currentColor"/>
<circle cx="15" cy="15" r="1" fill="currentColor"/>
</svg>
Promptheus
</h1>
<p>Complete Documentation</p>
<a href="index.html" style="color: var(--accent-gold); text-decoration: none; font-size: 0.875rem;">← Back to Home</a>
</div>
<nav class="sidebar-nav">
<div class="nav-section">
<div class="nav-section-title">Getting Started</div>
<ul class="nav-links">
<li><a href="#overview">Overview</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#quick-start">Quick Start</a></li>
</ul>
</div>
<div class="nav-section">
<div class="nav-section-title">CLI Usage</div>
<ul class="nav-links">
<li><a href="#cli-basics">Basic Commands</a></li>
<li><a href="#cli-modes">Operational Modes</a></li>
<li><a href="#cli-interactive">Interactive Mode</a></li>
<li><a href="#cli-pipeline">Pipeline Integration</a></li>
<li><a href="#cli-flags">Command Flags</a></li>
</ul>
</div>
<div class="nav-section">
<div class="nav-section-title">Web Interface</div>
<ul class="nav-links">
<li><a href="#web-overview">Web UI Overview</a></li>
<li><a href="#web-features">Features</a></li>
<li><a href="#web-workflow">Workflow</a></li>
</ul>
</div>
<div class="nav-section">
<div class="nav-section-title">Features</div>
<ul class="nav-links">
<li><a href="#providers">Provider Support</a></li>
<li><a href="#history">History Management</a></li>
<li><a href="#authentication">Authentication</a></li>
<li><a href="#output-formats">Output Formats</a></li>
</ul>
</div>
<div class="nav-section">
<div class="nav-section-title">Advanced</div>
<ul class="nav-links">
<li><a href="#environment-vars">Environment Variables</a></li>
<li><a href="#validation">Validation Tools</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
</ul>
</div>
<div class="nav-section">
<div class="nav-section-title">Reference</div>
<ul class="nav-links">
<li><a href="#command-reference">Command Reference</a></li>
<li><a href="#mcp-server">MCP Server</a></li>
<li><a href="#examples">Usage Examples</a></li>
<li><a href="#contributing">Contributing</a></li>
</ul>
</div>
</nav>
</aside>
<!-- Main Content -->
<main class="main-content">
<!-- Overview Section -->
<section id="overview">
<h1>Promptheus Documentation</h1>
<p>Welcome to the comprehensive documentation for Promptheus - the AI-powered prompt optimization tool that transforms raw prompts into polished, effective queries for any LLM.</p>
<div class="info-box">
<h4>🔮 What is Promptheus?</h4>
<p>Promptheus uses advanced AI to analyze your basic prompts and transform them into detailed, structured instructions that get superior results from any large language model. Think of it as prompt alchemy - turning base prompts into gold.</p>
</div>
<h3>Core Capabilities</h3>
<ul>
<li><strong>Adaptive Intelligence:</strong> Automatically detects task types and applies appropriate refinement strategies</li>
<li><strong>Multi-Provider Support:</strong> Works with 6 major AI providers - Google, Claude, OpenAI, Groq, Qwen, and GLM</li>
<li><strong>Interactive Refinement:</strong> Asks clarifying questions to understand your intent</li>
<li><strong>Powerful CLI:</strong> Command-line interface with keyboard shortcuts and pipeline integration</li>
<li><strong>Beautiful Web UI:</strong> Modern alchemical-themed interface for prompt enhancement</li>
<li><strong>History Management:</strong> Track and reload your prompt evolution</li>
<li><strong>Dynamic Model Discovery:</strong> Fetches current model information from models.dev API</li>
</ul>
</section>
<!-- Installation Section -->
<section id="installation">
<h2>Installation</h2>
<h3>User Installation</h3>
<p>Install Promptheus via pip for standard usage:</p>
<pre data-label="Shell"><code>pip install promptheus</code></pre>
<p>Verify the installation:</p>
<pre data-label="Shell"><code>promptheus --version</code></pre>
<h3>Developer Installation</h3>
<p>For development work, install from source:</p>
<pre data-label="Shell"><code># Clone the repository
git clone https://github.com/abhichandra21/Promptheus.git
cd Promptheus
# Install in editable mode with dev dependencies
pip install -e ".[dev]"
# Run tests to verify
pytest -q</code></pre>
<h3>System Requirements</h3>
<ul>
<li>Python 3.10 or higher</li>
<li>At least one configured LLM provider API key</li>
<li>Internet connection for API calls</li>
</ul>
</section>
<!-- Configuration Section -->
<section id="configuration">
<h2>Configuration</h2>
<h3>API Key Setup</h3>
<p>Promptheus requires at least one AI provider API key. Create a <code>.env</code> file in your project directory:</p>
<pre data-label="Config"><code># Google AI Studio
GOOGLE_API_KEY=your_google_key_here
# Anthropic Claude
ANTHROPIC_API_KEY=your_anthropic_key_here
# OpenAI
OPENAI_API_KEY=your_openai_key_here
# Groq
GROQ_API_KEY=your_groq_key_here
# Alibaba Cloud Qwen (DashScope)
DASHSCOPE_API_KEY=your_qwen_key_here
# Zhipu AI GLM
ZHIPUAI_API_KEY=your_glm_key_here</code></pre>
<h3>Interactive Authentication</h3>
<p>Use the interactive auth command for guided setup:</p>
<pre data-label="Shell"><code># Interactive provider selection
promptheus auth
# Specific provider
promptheus auth google
promptheus auth anthropic
# Skip validation (for testing)
promptheus auth openai --skip-validation</code></pre>
<h3>Environment File Discovery</h3>
<p>Promptheus searches upward from your current directory for <code>.env</code> files, stopping at project root markers:</p>
<ul>
<li><code>.git</code> directory (repository root)</li>
<li><code>pyproject.toml</code> (Python project root)</li>
<li><code>setup.py</code> (Python project root)</li>
</ul>
</section>
<!-- Quick Start Section -->
<section id="quick-start">
<h2>Quick Start</h2>
<h3>Basic Usage</h3>
<p>Transform a prompt with a single command:</p>
<pre data-label="Shell"><code>promptheus "Write a blog post about AI ethics"</code></pre>
<h3>Skip Questions Mode</h3>
<p>For quick enhancements without interactive questions:</p>
<pre data-label="Shell"><code>promptheus -s "Explain quantum computing"</code></pre>
<h3>Interactive Mode</h3>
<p>Start a persistent session for multiple prompts:</p>
<pre data-label="Shell"><code>promptheus</code></pre>
<h3>Specify Provider</h3>
<p>Choose a specific AI provider:</p>
<pre data-label="Shell"><code>promptheus --provider google "Create a marketing plan"</code></pre>
</section>
<!-- CLI Basics Section -->
<section id="cli-basics">
<h2>CLI Basics</h2>
<h3>Command Structure</h3>
<p>The basic Promptheus command structure:</p>
<pre data-label="Shell"><code>promptheus [options] [prompt]</code></pre>
<h3>Input Methods</h3>
<p>Promptheus supports multiple input methods:</p>
<table>
<thead>
<tr>
<th>Method</th>
<th>Syntax</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>Inline</td>
<td><code>promptheus "text"</code></td>
<td><code>promptheus "Write a haiku"</code></td>
</tr>
<tr>
<td>File flag</td>
<td><code>-f <path></code></td>
<td><code>promptheus -f prompt.txt</code></td>
</tr>
<tr>
<td>@ shorthand</td>
<td><code>@<path></code></td>
<td><code>promptheus @prompt.txt</code></td>
</tr>
<tr>
<td>Standard input</td>
<td>Pipe</td>
<td><code>cat prompt.txt | promptheus</code></td>
</tr>
</tbody>
</table>
</section>
<!-- CLI Modes Section -->
<section id="cli-modes">
<h2>Operational Modes</h2>
<h3>Adaptive Mode (Default)</h3>
<p>Promptheus automatically detects whether your task is analytical or creative:</p>
<ul>
<li><strong>Analysis tasks:</strong> Skips questions, applies direct enhancement</li>
<li><strong>Generation tasks:</strong> Asks clarifying questions for better results</li>
</ul>
<pre data-label="Shell"><code># Adaptive mode detects task type
promptheus "Analyze this codebase" # Skips questions
promptheus "Write a story" # Asks questions</code></pre>
<h3>Skip Questions Mode</h3>
<p>Bypass questions and enhance directly:</p>
<pre data-label="Shell"><code>promptheus -s "Your prompt here"
promptheus --skip-questions "Your prompt here"</code></pre>
<h3>Refine Mode</h3>
<p>Force interactive questions regardless of task type:</p>
<pre data-label="Shell"><code>promptheus -r "Your prompt here"
promptheus --refine "Your prompt here"</code></pre>
<h3>Single Execution Mode</h3>
<p>Process one prompt and exit:</p>
<pre data-label="Shell"><code>promptheus "Generate a function"</code></pre>
</section>
<!-- CLI Interactive Section -->
<section id="cli-interactive">
<h2>Interactive Mode (REPL)</h2>
<p>Launch interactive mode for a persistent session:</p>
<pre data-label="Shell"><code>promptheus</code></pre>
<h3>Keyboard Shortcuts</h3>
<table>
<thead>
<tr>
<th>Key</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td>Enter</td>
<td>Submit prompt</td>
</tr>
<tr>
<td>Shift+Enter</td>
<td>Insert newline (multiline mode)</td>
</tr>
<tr>
<td>Option/Alt+Enter</td>
<td>Insert newline (alternative)</td>
</tr>
<tr>
<td>↑/↓ Arrows</td>
<td>Navigate command history</td>
</tr>
<tr>
<td>Tab</td>
<td>Command completion</td>
</tr>
<tr>
<td>Ctrl+C</td>
<td>Cancel current operation</td>
</tr>
</tbody>
</table>
<h3>Slash Commands</h3>
<div class="command" data-type="Interactive">
<div class="command-title">/help</div>
<p>Display available commands and keyboard shortcuts</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/history</div>
<p>Display recent prompts and refinements</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/load <n></div>
<p>Load prompt at index n from history</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/clear-history</div>
<p>Purge all history entries</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/copy</div>
<p>Copy last refined result to clipboard</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/status</div>
<p>Display current session configuration</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/set provider <name></div>
<p>Change the active AI provider (google, anthropic, openai, groq, qwen, glm)</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/set model <name></div>
<p>Change the active model</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/toggle refine</div>
<p>Toggle refinement mode on/off</p>
</div>
<div class="command" data-type="Interactive">
<div class="command-title">/toggle skip-questions</div>
<p>Toggle question bypass mode</p>
</div>
</section>
<!-- CLI Pipeline Section -->
<section id="cli-pipeline">
<h2>Pipeline Integration</h2>
<p>Promptheus is designed for seamless integration with Unix pipelines and command substitution workflows.</p>
<h3>Basic Pipeline Operations</h3>
<pre data-label="Shell"><code># Automatic quiet mode when piped
promptheus "Write a story" | cat
# File redirection
promptheus "Write docs" > output.txt
# Integration with AI tools
promptheus "Create a haiku" | claude exec</code></pre>
<h3>Command Substitution</h3>
<pre data-label="Shell"><code># Feed refined output to external tools
claude "$(promptheus 'Write a technical prompt')"
# Variable capture for scripting
REFINED=$(promptheus "Optimize this query")
echo "$REFINED" | mysql -u user -p</code></pre>
<h3>Unix Utility Integration</h3>
<pre data-label="Shell"><code># Save and display simultaneously
promptheus "Long explanation" | tee output.txt
# Filter output
promptheus "List best practices" | grep -i "security"
# Count words
promptheus "Write essay" | wc -w
# Transform output
promptheus "Generate list" | sed 's/^/- /' > checklist.md</code></pre>
<h3>JSON Processing</h3>
<pre data-label="Shell"><code># Extract fields with jq
promptheus -o json "Create API schema" | jq '.endpoints'
# Format and save