Hugoifier

1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="AI-powered Hugo theme converter with Decap CMS integration">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://hugoifier.dev/getting-started/installation/">
16
17
18
<link rel="prev" href="../..">
19
20
21
<link rel="next" href="../quickstart/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
29
30
31
32
<title>Installation - Hugoifier</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/css/custom.css">
59
60
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#installation" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="Hugoifier" class="md-header__button md-logo" aria-label="Hugoifier" data-md-component="logo">
100
101
<img src="../../assets/images/conflict-logo.svg" alt="logo">
102
103
</a>
104
<label class="md-header__button md-icon" for="__drawer">
105
106
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
107
</label>
108
<div class="md-header__title" data-md-component="header-title">
109
<div class="md-header__ellipsis">
110
<div class="md-header__topic">
111
<span class="md-ellipsis">
112
Hugoifier
113
</span>
114
</div>
115
<div class="md-header__topic" data-md-component="header-topic">
116
<span class="md-ellipsis">
117
118
Installation
119
120
</span>
121
</div>
122
</div>
123
</div>
124
125
126
<form class="md-header__option" data-md-component="palette">
127
128
129
130
131
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
132
133
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
134
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
135
</label>
136
137
138
139
140
141
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
142
143
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
144
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
145
</label>
146
147
148
</form>
149
150
151
152
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
153
154
155
156
157
158
<label class="md-header__button md-icon" for="__search">
159
160
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
161
</label>
162
<div class="md-search" data-md-component="search" role="dialog">
163
<label class="md-search__overlay" for="__search"></label>
164
<div class="md-search__inner" role="search">
165
<form class="md-search__form" name="search">
166
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
167
<label class="md-search__icon md-icon" for="__search">
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
172
</label>
173
<nav class="md-search__options" aria-label="Search">
174
175
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
176
177
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
178
</button>
179
</nav>
180
181
<div class="md-search__suggest" data-md-component="search-suggest"></div>
182
183
</form>
184
<div class="md-search__output">
185
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
186
<div class="md-search-result" data-md-component="search-result">
187
<div class="md-search-result__meta">
188
Initializing search
189
</div>
190
<ol class="md-search-result__list" role="presentation"></ol>
191
</div>
192
</div>
193
</div>
194
</div>
195
</div>
196
197
198
199
<div class="md-header__source">
200
<a href="https://github.com/ConflictHQ/hugoifier" title="Go to repository" class="md-source" data-md-component="source">
201
<div class="md-source__icon md-icon">
202
203
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
204
</div>
205
<div class="md-source__repository">
206
ConflictHQ/hugoifier
207
</div>
208
</a>
209
</div>
210
211
</nav>
212
213
</header>
214
215
<div class="md-container" data-md-component="container">
216
217
218
219
220
221
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
222
<div class="md-grid">
223
<ul class="md-tabs__list">
224
225
226
227
228
229
230
<li class="md-tabs__item">
231
<a href="../.." class="md-tabs__link">
232
233
234
235
236
237
Home
238
239
</a>
240
</li>
241
242
243
244
245
246
247
248
249
250
251
252
253
<li class="md-tabs__item md-tabs__item--active">
254
<a href="./" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
<li class="md-tabs__item">
272
<a href="../../cli-reference/" class="md-tabs__link">
273
274
275
276
277
278
CLI Reference
279
280
</a>
281
</li>
282
283
284
285
286
287
288
289
290
<li class="md-tabs__item">
291
<a href="../../architecture/" class="md-tabs__link">
292
293
294
295
296
297
Architecture
298
299
</a>
300
</li>
301
302
303
304
305
306
307
308
309
<li class="md-tabs__item">
310
<a href="../../about/" class="md-tabs__link">
311
312
313
314
315
316
Why Hugo + Cloudflare
317
318
</a>
319
</li>
320
321
322
323
</ul>
324
</div>
325
</nav>
326
327
328
329
<main class="md-main" data-md-component="main">
330
<div class="md-main__inner md-grid">
331
332
333
334
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
335
<div class="md-sidebar__scrollwrap">
336
<div class="md-sidebar__inner">
337
338
339
340
341
342
343
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
344
<label class="md-nav__title" for="__drawer">
345
<a href="../.." title="Hugoifier" class="md-nav__button md-logo" aria-label="Hugoifier" data-md-component="logo">
346
347
<img src="../../assets/images/conflict-logo.svg" alt="logo">
348
349
</a>
350
Hugoifier
351
</label>
352
353
<div class="md-nav__source">
354
<a href="https://github.com/ConflictHQ/hugoifier" title="Go to repository" class="md-source" data-md-component="source">
355
<div class="md-source__icon md-icon">
356
357
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
358
</div>
359
<div class="md-source__repository">
360
ConflictHQ/hugoifier
361
</div>
362
</a>
363
</div>
364
365
<ul class="md-nav__list" data-md-scrollfix>
366
367
368
369
370
371
372
373
<li class="md-nav__item">
374
<a href="../.." class="md-nav__link">
375
376
377
378
<span class="md-ellipsis">
379
380
381
Home
382
383
384
385
</span>
386
387
388
389
</a>
390
</li>
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
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
416
417
418
419
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
420
421
422
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
423
424
425
426
<span class="md-ellipsis">
427
428
429
Getting Started
430
431
432
433
</span>
434
435
436
437
<span class="md-nav__icon md-icon"></span>
438
</label>
439
440
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
441
<label class="md-nav__title" for="__nav_2">
442
<span class="md-nav__icon md-icon"></span>
443
444
445
Getting Started
446
447
448
</label>
449
<ul class="md-nav__list" data-md-scrollfix>
450
451
452
453
454
455
456
457
458
459
<li class="md-nav__item md-nav__item--active">
460
461
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
462
463
464
465
466
467
<label class="md-nav__link md-nav__link--active" for="__toc">
468
469
470
471
<span class="md-ellipsis">
472
473
474
Installation
475
476
477
478
</span>
479
480
481
482
<span class="md-nav__icon md-icon"></span>
483
</label>
484
485
<a href="./" class="md-nav__link md-nav__link--active">
486
487
488
489
<span class="md-ellipsis">
490
491
492
Installation
493
494
495
496
</span>
497
498
499
500
</a>
501
502
503
504
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
505
506
507
508
509
510
511
<label class="md-nav__title" for="__toc">
512
<span class="md-nav__icon md-icon"></span>
513
Table of contents
514
</label>
515
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
516
517
<li class="md-nav__item">
518
<a href="#prerequisites" class="md-nav__link">
519
<span class="md-ellipsis">
520
521
Prerequisites
522
523
</span>
524
</a>
525
526
</li>
527
528
<li class="md-nav__item">
529
<a href="#from-source" class="md-nav__link">
530
<span class="md-ellipsis">
531
532
From Source
533
534
</span>
535
</a>
536
537
</li>
538
539
<li class="md-nav__item">
540
<a href="#docker" class="md-nav__link">
541
<span class="md-ellipsis">
542
543
Docker
544
545
</span>
546
</a>
547
548
</li>
549
550
<li class="md-nav__item">
551
<a href="#api-keys" class="md-nav__link">
552
<span class="md-ellipsis">
553
554
API Keys
555
556
</span>
557
</a>
558
559
</li>
560
561
</ul>
562
563
</nav>
564
565
</li>
566
567
568
569
570
571
572
573
574
575
576
<li class="md-nav__item">
577
<a href="../quickstart/" class="md-nav__link">
578
579
580
581
<span class="md-ellipsis">
582
583
584
Quick Start
585
586
587
588
</span>
589
590
591
592
</a>
593
</li>
594
595
596
597
598
599
600
601
602
603
604
<li class="md-nav__item">
605
<a href="../configuration/" class="md-nav__link">
606
607
608
609
<span class="md-ellipsis">
610
611
612
Configuration
613
614
615
616
</span>
617
618
619
620
</a>
621
</li>
622
623
624
625
626
</ul>
627
</nav>
628
629
</li>
630
631
632
633
634
635
636
637
638
639
<li class="md-nav__item">
640
<a href="../../cli-reference/" class="md-nav__link">
641
642
643
644
<span class="md-ellipsis">
645
646
647
CLI Reference
648
649
650
651
</span>
652
653
654
655
</a>
656
</li>
657
658
659
660
661
662
663
664
665
666
<li class="md-nav__item">
667
<a href="../../architecture/" class="md-nav__link">
668
669
670
671
<span class="md-ellipsis">
672
673
674
Architecture
675
676
677
678
</span>
679
680
681
682
</a>
683
</li>
684
685
686
687
688
689
690
691
692
693
<li class="md-nav__item">
694
<a href="../../about/" class="md-nav__link">
695
696
697
698
<span class="md-ellipsis">
699
700
701
Why Hugo + Cloudflare
702
703
704
705
</span>
706
707
708
709
</a>
710
</li>
711
712
713
714
</ul>
715
</nav>
716
</div>
717
</div>
718
</div>
719
720
721
722
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
723
<div class="md-sidebar__scrollwrap">
724
<div class="md-sidebar__inner">
725
726
727
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
728
729
730
731
732
733
734
<label class="md-nav__title" for="__toc">
735
<span class="md-nav__icon md-icon"></span>
736
Table of contents
737
</label>
738
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
739
740
<li class="md-nav__item">
741
<a href="#prerequisites" class="md-nav__link">
742
<span class="md-ellipsis">
743
744
Prerequisites
745
746
</span>
747
</a>
748
749
</li>
750
751
<li class="md-nav__item">
752
<a href="#from-source" class="md-nav__link">
753
<span class="md-ellipsis">
754
755
From Source
756
757
</span>
758
</a>
759
760
</li>
761
762
<li class="md-nav__item">
763
<a href="#docker" class="md-nav__link">
764
<span class="md-ellipsis">
765
766
Docker
767
768
</span>
769
</a>
770
771
</li>
772
773
<li class="md-nav__item">
774
<a href="#api-keys" class="md-nav__link">
775
<span class="md-ellipsis">
776
777
API Keys
778
779
</span>
780
</a>
781
782
</li>
783
784
</ul>
785
786
</nav>
787
</div>
788
</div>
789
</div>
790
791
792
793
<div class="md-content" data-md-component="content">
794
795
<article class="md-content__inner md-typeset">
796
797
798
799
800
801
802
803
804
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h1>
805
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
806
<ul>
807
<li><strong>Python 3.11+</strong></li>
808
<li><strong>Hugo extended</strong> — for building the generated site locally (<code>brew install hugo</code> on macOS)</li>
809
<li><strong>At least one AI API key</strong></li>
810
</ul>
811
<h2 id="from-source">From Source<a class="headerlink" href="#from-source" title="Permanent link">&para;</a></h2>
812
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/hugoifier.git
813
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>hugoifier
814
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
815
</code></pre></div>
816
<h2 id="docker">Docker<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h2>
817
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/hugoifier.git
818
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nb">cd</span><span class="w"> </span>hugoifier
819
</code></pre></div>
820
<p>Then run with your preferred backend:</p>
821
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Anthropic (default)</label><label for="__tabbed_1_2">OpenAI</label><label for="__tabbed_1_3">Google</label></div>
822
<div class="tabbed-content">
823
<div class="tabbed-block">
824
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nv">ANTHROPIC_API_KEY</span><span class="o">=</span>your_key<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up
825
</code></pre></div>
826
</div>
827
<div class="tabbed-block">
828
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nv">OPENAI_API_KEY</span><span class="o">=</span>your_key<span class="w"> </span><span class="nv">HUGOIFIER_BACKEND</span><span class="o">=</span>openai<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up
829
</code></pre></div>
830
</div>
831
<div class="tabbed-block">
832
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nv">GOOGLE_API_KEY</span><span class="o">=</span>your_key<span class="w"> </span><span class="nv">HUGOIFIER_BACKEND</span><span class="o">=</span>google<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up
833
</code></pre></div>
834
</div>
835
</div>
836
</div>
837
<h2 id="api-keys">API Keys<a class="headerlink" href="#api-keys" title="Permanent link">&para;</a></h2>
838
<p>Set the key for your chosen backend:</p>
839
<table>
840
<thead>
841
<tr>
842
<th>Backend</th>
843
<th>Environment Variable</th>
844
<th>Model</th>
845
</tr>
846
</thead>
847
<tbody>
848
<tr>
849
<td>Anthropic (default)</td>
850
<td><code>ANTHROPIC_API_KEY</code></td>
851
<td><code>claude-sonnet-4-6</code></td>
852
</tr>
853
<tr>
854
<td>OpenAI</td>
855
<td><code>OPENAI_API_KEY</code></td>
856
<td><code>gpt-4-turbo</code></td>
857
</tr>
858
<tr>
859
<td>Google</td>
860
<td><code>GOOGLE_API_KEY</code></td>
861
<td><code>gemini-1.5-pro</code></td>
862
</tr>
863
</tbody>
864
</table>
865
<p>Override the model with <code>ANTHROPIC_MODEL</code>, <code>OPENAI_MODEL</code>, or <code>GOOGLE_MODEL</code>.</p>
866
867
868
869
870
871
872
873
874
875
876
877
878
879
</article>
880
</div>
881
882
883
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
884
885
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
886
</div>
887
888
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
889
890
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
891
Back to top
892
</button>
893
894
</main>
895
896
<footer class="md-footer">
897
898
<div class="md-footer-meta md-typeset">
899
<div class="md-footer-meta__inner md-grid">
900
<div class="md-copyright">
901
902
<div class="md-copyright__highlight">
903
Copyright &copy; 2026 CONFLICT LLC
904
</div>
905
906
907
Made with
908
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
909
Material for MkDocs
910
</a>
911
912
</div>
913
914
915
<div class="md-social">
916
917
918
919
920
921
922
923
924
<a href="https://github.com/ConflictHQ/hugoifier" target="_blank" rel="noopener" title="github.com" class="md-social__link">
925
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
926
</a>
927
928
</div>
929
930
</div>
931
</div>
932
</footer>
933
934
</div>
935
<div class="md-dialog" data-md-component="dialog">
936
<div class="md-dialog__inner md-typeset"></div>
937
</div>
938
939
940
941
942
943
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
944
945
946
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
947
948
949
</body>
950
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button