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       --clock=""       set   the   clock   used   by   Hugo,   e.g.   --clock
60       2021-11-06T22:30:00.00+09:00
61
62
63       -c, --contentDir=""      filesystem path to content directory
64
65
66       -d, --destination=""      filesystem path to write files to
67
68
69       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
70
71
72       --enableGitInfo[=false]       add Git revision, date, author, and CODE‐
73       OWNERS info to the pages
74
75
76       -e, --environment=""      build environment
77
78
79       --forceSyncStatic[=false]      copy all files when static is changed.
80
81
82       --gc[=false]      enable to run some cleanup tasks (remove unused cache
83       files) after the build
84
85
86       -h, --help[=false]      help for mod
87
88
89       --ignoreCache[=false]      ignores the cache directory
90
91
92       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
93       ing the given Glob pattern
94
95
96       -l, --layoutDir=""      filesystem path to layout directory
97
98
99       --minify[=false]      minify any supported  output  format  (HTML,  XML
100       etc.)
101
102
103       --noBuildLock[=false]      don't create .hugo_build.lock file
104
105
106       --noChmod[=false]      don't sync permission mode of files
107
108
109       --noTimes[=false]      don't sync modification time of files
110
111
112       --panicOnWarning[=false]      panic on first WARNING log
113
114
115       --poll=""       set this to a poll interval, e.g --poll 700ms, to use a
116       poll based approach to watch for file system changes
117
118
119       --printI18nWarnings[=false]      print missing translations
120
121
122       --printMemoryUsage[=false]      print memory usage to screen at  inter‐
123       vals
124
125
126       --printPathWarnings[=false]       print  warnings  on  duplicate target
127       paths etc.
128
129
130       --printUnusedTemplates[=false]      print warnings on unused templates.
131
132
133       -s, --source=""      filesystem path to read files relative from
134
135
136       --templateMetrics[=false]      display metrics  about  template  execu‐
137       tions
138
139
140       --templateMetricsHints[=false]       calculate  some  improvement hints
141       when combined with --templateMetrics
142
143
144       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
145
146
147       --themesDir=""      filesystem path to themes directory
148
149
150       --trace=""      write trace to file (not useful in general)
151
152
153

OPTIONS INHERITED FROM PARENT COMMANDS

155       --config=""      config file (default is hugo.yaml|json|toml)
156
157
158       --configDir="config"      config dir
159
160
161       --debug[=false]      debug output
162
163
164       --log[=false]      enable Logging
165
166
167       --logFile=""      log File path (if set, logging enabled automatically)
168
169
170       --quiet[=false]      build in quiet mode
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