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

NAME

6       hugo - hugo builds your site
7
8
9

SYNOPSIS

11       hugo [flags]
12
13
14

DESCRIPTION

16       hugo is the main command, used to build your Hugo site.
17
18
19       Hugo  is  a  Fast and Flexible Static Site Generator built with love by
20       spf13 and friends in Go.
21
22
23       Complete documentation is available at https://gohugo.io/.
24
25
26

OPTIONS

28       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
29       https://spf13.com/
30
31
32       -D, --buildDrafts[=false]      include content marked as draft
33
34
35       -E, --buildExpired[=false]      include expired content
36
37
38       -F,  --buildFuture[=false]      include content with publishdate in the
39       future
40
41
42       --cacheDir=""      filesystem path to cache directory.  Defaults:  $TM‐
43       PDIR/hugo_cache/
44
45
46       --cleanDestinationDir[=false]       remove  files  from destination not
47       found in static directories
48
49
50       --clock=""       set   the   clock   used   by   Hugo,   e.g.   --clock
51       2021-11-06T22:30:00.00+09:00
52
53
54       --config=""      config file (default is hugo.yaml|json|toml)
55
56
57       --configDir="config"      config dir
58
59
60       -c, --contentDir=""      filesystem path to content directory
61
62
63       --debug[=false]      debug output
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 hugo
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       --log[=false]      enable Logging
100
101
102       --logFile=""      log File path (if set, logging enabled automatically)
103
104
105       --minify[=false]      minify any supported  output  format  (HTML,  XML
106       etc.)
107
108
109       --noBuildLock[=false]      don't create .hugo_build.lock file
110
111
112       --noChmod[=false]      don't sync permission mode of files
113
114
115       --noTimes[=false]      don't sync modification time of files
116
117
118       --panicOnWarning[=false]      panic on first WARNING log
119
120
121       --poll=""       set this to a poll interval, e.g --poll 700ms, to use a
122       poll based approach to watch for file system changes
123
124
125       --printI18nWarnings[=false]      print missing translations
126
127
128       --printMemoryUsage[=false]      print memory usage to screen at  inter‐
129       vals
130
131
132       --printPathWarnings[=false]       print  warnings  on  duplicate target
133       paths etc.
134
135
136       --printUnusedTemplates[=false]      print warnings on unused templates.
137
138
139       --quiet[=false]      build in quiet mode
140
141
142       --renderToMemory[=false]      render to memory (only useful for  bench‐
143       mark testing)
144
145
146       -s, --source=""      filesystem path to read files relative from
147
148
149       --templateMetrics[=false]       display  metrics  about template execu‐
150       tions
151
152
153       --templateMetricsHints[=false]      calculate  some  improvement  hints
154       when combined with --templateMetrics
155
156
157       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
158
159
160       --themesDir=""      filesystem path to themes directory
161
162
163       --trace=""      write trace to file (not useful in general)
164
165
166       -v, --verbose[=false]      verbose output
167
168
169       --verboseLog[=false]      verbose logging
170
171
172       -w,  --watch[=false]       watch filesystem for changes and recreate as
173       needed
174
175
176

SEE ALSO

178       hugo-completion(1),  hugo-config(1),  hugo-convert(1),  hugo-deploy(1),
179       hugo-env(1),  hugo-gen(1),  hugo-import(1),  hugo-list(1), hugo-mod(1),
180       hugo-new(1), hugo-server(1), hugo-version(1)
181
182
183
184Hugo 0.111.3                       Jul 2023                            HUGO(1)