hugo-mod(1)

1HUGO-MOD(1)                       Hugo Manual                      HUGO-MOD(1)
2
3
4

NAME

6       hugo-mod - Various Hugo Modules helpers.
7
8
9

SYNOPSIS

11       hugo mod [flags]
12
13
14

DESCRIPTION

16       Various helpers to help manage the modules in your project's dependency
17       graph.
18
19
20       Most operations here requires a Go version installed on your system (>=
21       Go  1.12)  and  the  relevant  VCS client (typically Git).  This is not
22       needed if you only operate on modules inside /themes  or  if  you  have
23       vendored them via "hugo mod vendor".
24
25
26       Note  that  Hugo  will always start out by resolving the components de‐
27       fined in the site configuration, provided by a _vendor directory (if no
28       --ignoreVendorPaths  flag provided), Go Modules, or a folder inside the
29       themes directory, in that order.
30
31
32       See https://gohugo.io/hugo-modules/ for more information.
33
34
35

OPTIONS

37       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
38       https://spf13.com/
39
40
41       -D, --buildDrafts[=false]      include content marked as draft
42
43
44       -E, --buildExpired[=false]      include expired content
45
46
47       -F,  --buildFuture[=false]      include content with publishdate in the
48       future
49
50
51       --cacheDir=""      filesystem path to cache directory.  Defaults:  $TM‐
52       PDIR/hugo_cache/
53
54
55       --cleanDestinationDir[=false]       remove  files  from destination not
56       found in static directories
57
58
59       -c, --contentDir=""      filesystem path to content directory
60
61
62       -d, --destination=""      filesystem path to write files to
63
64
65       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
66
67
68       --enableGitInfo[=false]      add Git revision, date, author, and  CODE‐
69       OWNERS info to the pages
70
71
72       --forceSyncStatic[=false]      copy all files when static is changed.
73
74
75       --gc[=false]      enable to run some cleanup tasks (remove unused cache
76       files) after the build
77
78
79       -h, --help[=false]      help for mod
80
81
82       --ignoreCache[=false]      ignores the cache directory
83
84
85       -l, --layoutDir=""      filesystem path to layout directory
86
87
88       --minify[=false]      minify any supported  output  format  (HTML,  XML
89       etc.)
90
91
92       --noBuildLock[=false]      don't create .hugo_build.lock file
93
94
95       --noChmod[=false]      don't sync permission mode of files
96
97
98       --noTimes[=false]      don't sync modification time of files
99
100
101       --panicOnWarning[=false]      panic on first WARNING log
102
103
104       --poll=""       set this to a poll interval, e.g --poll 700ms, to use a
105       poll based approach to watch for file system changes
106
107
108       --printI18nWarnings[=false]      print missing translations
109
110
111       --printMemoryUsage[=false]      print memory usage to screen at  inter‐
112       vals
113
114
115       --printPathWarnings[=false]       print  warnings  on  duplicate target
116       paths etc.
117
118
119       --printUnusedTemplates[=false]      print warnings on unused templates.
120
121
122       --templateMetrics[=false]      display metrics  about  template  execu‐
123       tions
124
125
126       --templateMetricsHints[=false]       calculate  some  improvement hints
127       when combined with --templateMetrics
128
129
130       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
131
132
133       --trace=""      write trace to file (not useful in general)
134
135
136

OPTIONS INHERITED FROM PARENT COMMANDS

138       --clock=""       set   the   clock   used   by   Hugo,   e.g.   --clock
139       2021-11-06T22:30:00.00+09:00
140
141
142       --config=""      config file (default is path/config.yaml|json|toml)
143
144
145       --configDir="config"      config dir
146
147
148       --debug[=false]      debug output
149
150
151       -e, --environment=""      build environment
152
153
154       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
155       ing the given Glob pattern
156
157
158       --log[=false]      enable Logging
159
160
161       --logFile=""      log File path (if set, logging enabled automatically)
162
163
164       --quiet[=false]      build in quiet mode
165
166
167       -s, --source=""      filesystem path to read files relative from
168
169
170       --themesDir=""      filesystem path to themes directory
171
172
173       -v, --verbose[=false]      verbose output
174
175
176       --verboseLog[=false]      verbose logging
177
178
179

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO