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 http://gohugo.io/.
24
25
26

OPTIONS

28       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
29       http://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       --config=""      config file (default is path/config.yaml|json|toml)
51
52
53       --configDir="config"      config dir
54
55
56       -c, --contentDir=""      filesystem path to content directory
57
58
59       --debug[=false]      debug output
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       -e, --environment=""      build environment
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 hugo
83
84
85       --ignoreCache[=false]      ignores the cache directory
86
87
88       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
89       ing the given Glob pattern
90
91
92       -l, --layoutDir=""      filesystem path to layout directory
93
94
95       --log[=false]      enable Logging
96
97
98       --logFile=""      log File path (if set, logging enabled automatically)
99
100
101       --minify[=false]       minify  any  supported  output format (HTML, XML
102       etc.)
103
104
105       --noChmod[=false]      don't sync permission mode of files
106
107
108       --noTimes[=false]      don't sync modification time of files
109
110
111       --panicOnWarning[=false]      panic on first WARNING log
112
113
114       --poll=""      set this to a poll interval, e.g --poll 700ms, to use  a
115       poll based approach to watch for file system changes
116
117
118       --printI18nWarnings[=false]      print missing translations
119
120
121       --printMemoryUsage[=false]       print memory usage to screen at inter‐
122       vals
123
124
125       --printPathWarnings[=false]      print  warnings  on  duplicate  target
126       paths etc.
127
128
129       --printUnusedTemplates[=false]      print warnings on unused templates.
130
131
132       --quiet[=false]      build in quiet mode
133
134
135       --renderToMemory[=false]       render to memory (only useful for bench‐
136       mark testing)
137
138
139       -s, --source=""      filesystem path to read files relative from
140
141
142       --templateMetrics[=false]      display metrics  about  template  execu‐
143       tions
144
145
146       --templateMetricsHints[=false]       calculate  some  improvement hints
147       when combined with --templateMetrics
148
149
150       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
151
152
153       --themesDir=""      filesystem path to themes directory
154
155
156       --trace=""      write trace to file (not useful in general)
157
158
159       -v, --verbose[=false]      verbose output
160
161
162       --verboseLog[=false]      verbose logging
163
164
165       -w, --watch[=false]      watch filesystem for changes and  recreate  as
166       needed
167
168
169

SEE ALSO

171       hugo-completion(1),  hugo-config(1),  hugo-convert(1),  hugo-deploy(1),
172       hugo-env(1), hugo-gen(1),  hugo-import(1),  hugo-list(1),  hugo-mod(1),
173       hugo-new(1), hugo-server(1), hugo-version(1)
174
175
176
177Hugo 0.93.3                        May 2022                            HUGO(1)