1HUGO-MOD(1)Apr(2020)                                      HUGO-MOD(1)Apr(2020)
2
3
4
5Hugo 0.69.0 Hugo Manual
6
7

NAME

9       hugo-mod - Various Hugo Modules helpers.
10
11
12

SYNOPSIS

14       hugo mod [flags]
15
16
17

DESCRIPTION

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

OPTIONS

40       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
41       http://spf13.com/
42
43
44       -D, --buildDrafts[=false]      include content marked as draft
45
46
47       -E, --buildExpired[=false]      include expired content
48
49
50       -F,  --buildFuture[=false]      include content with publishdate in the
51       future
52
53
54       --cacheDir=""       filesystem  path  to  cache  directory.   Defaults:
55       $TMPDIR/hugo_cache/
56
57
58       --cleanDestinationDir[=false]       remove  files  from destination not
59       found in static directories
60
61
62       -c, --contentDir=""      filesystem path to content directory
63
64
65       -d, --destination=""      filesystem path to write files to
66
67
68       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
69
70
71       --enableGitInfo[=false]      add Git revision, date and author info  to
72       the pages
73
74
75       --forceSyncStatic[=false]      copy all files when static is changed.
76
77
78       --gc[=false]      enable to run some cleanup tasks (remove unused cache
79       files) after the build
80
81
82       -h, --help[=false]      help for mod
83
84
85       --i18n-warnings[=false]      print missing translations
86
87
88       --ignoreCache[=false]      ignores the cache directory
89
90
91       -l, --layoutDir=""      filesystem path to layout directory
92
93
94       --minify[=false]      minify any supported  output  format  (HTML,  XML
95       etc.)
96
97
98       --noChmod[=false]      don't sync permission mode of files
99
100
101       --noTimes[=false]      don't sync modification time of files
102
103
104       --path-warnings[=false]       print  warnings on duplicate target paths
105       etc.
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       --log[=false]      enable Logging
140
141
142       --logFile=""      log File path (if set, logging enabled automatically)
143
144
145       --quiet[=false]      build in quiet mode
146
147
148       -s, --source=""      filesystem path to read files relative from
149
150
151       --themesDir=""      filesystem path to themes directory
152
153
154       -v, --verbose[=false]      verbose output
155
156
157       --verboseLog[=false]      verbose logging
158
159
160

SEE ALSO

162       hugo(1),   hugo-mod-clean(1),    hugo-mod-get(1),    hugo-mod-graph(1),
163       hugo-mod-init(1),  hugo-mod-tidy(1),  hugo-mod-vendor(1), hugo-mod-ver‐
164       ify(1)
165
166
167
168                                                          HUGO-MOD(1)Apr(2020)