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
27       defined in the site configuration, provided by a _vendor directory  (if
28       no  --ignoreVendor  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       http://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:
52       $TMPDIR/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 and author info  to
69       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       --i18n-warnings[=false]      print missing translations
83
84
85       --ignoreCache[=false]      ignores the cache directory
86
87
88       -l, --layoutDir=""      filesystem path to layout directory
89
90
91       --minify[=false]      minify any supported  output  format  (HTML,  XML
92       etc.)
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       --path-warnings[=false]       print  warnings on duplicate target paths
102       etc.
103
104
105       --print-mem[=false]      print memory usage to screen at intervals
106
107
108       --templateMetrics[=false]      display metrics  about  template  execu‐
109       tions
110
111
112       --templateMetricsHints[=false]       calculate  some  improvement hints
113       when combined with --templateMetrics
114
115
116       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
117
118
119       --trace=""      write trace to file (not useful in general)
120
121
122

OPTIONS INHERITED FROM PARENT COMMANDS

124       --config=""      config file (default is path/config.yaml|json|toml)
125
126
127       --configDir="config"      config dir
128
129
130       --debug[=false]      debug output
131
132
133       -e, --environment=""      build environment
134
135
136       --ignoreVendor[=false]      ignores any _vendor directory
137
138
139       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
140       ing the given Glob pattern
141
142
143       --log[=false]      enable Logging
144
145
146       --logFile=""      log File path (if set, logging enabled automatically)
147
148
149       --quiet[=false]      build in quiet mode
150
151
152       -s, --source=""      filesystem path to read files relative from
153
154
155       --themesDir=""      filesystem path to themes directory
156
157
158       -v, --verbose[=false]      verbose output
159
160
161       --verboseLog[=false]      verbose logging
162
163
164

SEE ALSO

166       hugo(1),    hugo-mod-clean(1),    hugo-mod-get(1),   hugo-mod-graph(1),
167       hugo-mod-init(1),  hugo-mod-npm(1),   hugo-mod-tidy(1),   hugo-mod-ven‐
168       dor(1), hugo-mod-verify(1)
169
170
171
172Hugo 0.80.0                        Jan 2021                        HUGO-MOD(1)