1HUGO-SERVER(1) Hugo Manual HUGO-SERVER(1)
2
6 hugo-server - A high performance webserver
7
11 hugo server [flags]
12
16 Hugo provides its own webserver which builds and serves the site.
17 While hugo server is high performance, it is a webserver with limited
18 options. Many run it in production, but the standard behavior is for
19 people to use it in development and use a more full featured server
20 such as Nginx or Caddy.
21 'hugo server' will avoid writing the rendered and served content to
24 disk, preferring to store it in memory.
25 By default hugo will also watch your files for any changes you make and
28 automatically rebuild the site. It will then live reload any open
29 browser pages and push the latest content to them. As most Hugo sites
30 are built in a fraction of a second, you will be able to save and see
31 your changes nearly instantly.
32
36 --appendPort[=true] append port to baseURL
37 -b, --baseURL="" hostname (and path) to the root, e.g.
40 https://spf13.com/
41 --bind="127.0.0.1" interface to which the server will bind
44 -D, --buildDrafts[=false] include content marked as draft
47 -E, --buildExpired[=false] include expired content
50 -F, --buildFuture[=false] include content with publishdate in the
53 future
54 --cacheDir="" filesystem path to cache directory. Defaults: $TM‐
57 PDIR/hugo_cache/
58 --cleanDestinationDir[=false] remove files from destination not
61 found in static directories
62 --clock="" set the clock used by Hugo, e.g. --clock
65 2021-11-06T22:30:00.00+09:00
66 -c, --contentDir="" filesystem path to content directory
69 -d, --destination="" filesystem path to write files to
72 --disableBrowserError[=false] do not show build errors in the
75 browser
76 --disableFastRender[=false] enables full re-renders on changes
79 --disableKinds=[] disable different kind of pages (home, RSS etc.)
82 --disableLiveReload[=false] watch without enabling live browser
85 reload on rebuild
86 --enableGitInfo[=false] add Git revision, date, author, and CODE‐
89 OWNERS info to the pages
90 -e, --environment="" build environment
93 --forceSyncStatic[=false] copy all files when static is changed.
96 --gc[=false] enable to run some cleanup tasks (remove unused cache
99 files) after the build
100 -h, --help[=false] help for server
103 --ignoreCache[=false] ignores the cache directory
106 --ignoreVendorPaths="" ignores any _vendor for module paths match‐
109 ing the given Glob pattern
110 -l, --layoutDir="" filesystem path to layout directory
113 --liveReloadPort=-1 port for live reloading (i.e. 443 in HTTPS
116 proxy situations)
117 --meminterval="100ms" interval to poll memory usage (requires
120 --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m",
121 "h".
122 --memstats="" log memory usage to this file
125 --minify[=false] minify any supported output format (HTML, XML
128 etc.)
129 --navigateToChanged[=false] navigate to changed content file on
132 live browser reload
133 --noBuildLock[=false] don't create .hugo_build.lock file
136 --noChmod[=false] don't sync permission mode of files
139 --noHTTPCache[=false] prevent HTTP caching
142 --noTimes[=false] don't sync modification time of files
145 --panicOnWarning[=false] panic on first WARNING log
148 --poll="" set this to a poll interval, e.g --poll 700ms, to use a
151 poll based approach to watch for file system changes
152 -p, --port=1313 port on which the server will listen
155 --printI18nWarnings[=false] print missing translations
158 --printMemoryUsage[=false] print memory usage to screen at inter‐
161 vals
162 --printPathWarnings[=false] print warnings on duplicate target
165 paths etc.
166 --printUnusedTemplates[=false] print warnings on unused templates.
169 --renderStaticToDisk[=false] serve static files from disk and dy‐
172 namic files from memory
173 --renderToDisk[=false] serve all files from disk (default is from
176 memory)
177 -s, --source="" filesystem path to read files relative from
180 --templateMetrics[=false] display metrics about template execu‐
183 tions
184 --templateMetricsHints[=false] calculate some improvement hints
187 when combined with --templateMetrics
188 -t, --theme=[] themes to use (located in /themes/THEMENAME/)
191 --themesDir="" filesystem path to themes directory
194 --trace="" write trace to file (not useful in general)
197 -w, --watch[=true] watch filesystem for changes and recreate as
200 needed
201
205 --config="" config file (default is hugo.yaml|json|toml)
206 --configDir="config" config dir
209 --debug[=false] debug output
212 --log[=false] enable Logging
215 --logFile="" log File path (if set, logging enabled automatically)
218 --quiet[=false] build in quiet mode
221 -v, --verbose[=false] verbose output
224 --verboseLog[=false] verbose logging
227
231 hugo(1)
232Hugo 0.111.3 Jul 2023 HUGO-SERVER(1)