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 -c, --contentDir="" filesystem path to content directory
65 -d, --destination="" filesystem path to write files to
68 --disableBrowserError[=false] do not show build errors in the
71 browser
72 --disableFastRender[=false] enables full re-renders on changes
75 --disableKinds=[] disable different kind of pages (home, RSS etc.)
78 --disableLiveReload[=false] watch without enabling live browser
81 reload on rebuild
82 --enableGitInfo[=false] add Git revision, date, author, and CODE‐
85 OWNERS info to the pages
86 --forceSyncStatic[=false] copy all files when static is changed.
89 --gc[=false] enable to run some cleanup tasks (remove unused cache
92 files) after the build
93 -h, --help[=false] help for server
96 --ignoreCache[=false] ignores the cache directory
99 -l, --layoutDir="" filesystem path to layout directory
102 --liveReloadPort=-1 port for live reloading (i.e. 443 in HTTPS
105 proxy situations)
106 --meminterval="100ms" interval to poll memory usage (requires
109 --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m",
110 "h".
111 --memstats="" log memory usage to this file
114 --minify[=false] minify any supported output format (HTML, XML
117 etc.)
118 --navigateToChanged[=false] navigate to changed content file on
121 live browser reload
122 --noBuildLock[=false] don't create .hugo_build.lock file
125 --noChmod[=false] don't sync permission mode of files
128 --noHTTPCache[=false] prevent HTTP caching
131 --noTimes[=false] don't sync modification time of files
134 --panicOnWarning[=false] panic on first WARNING log
137 --poll="" set this to a poll interval, e.g --poll 700ms, to use a
140 poll based approach to watch for file system changes
141 -p, --port=1313 port on which the server will listen
144 --printI18nWarnings[=false] print missing translations
147 --printMemoryUsage[=false] print memory usage to screen at inter‐
150 vals
151 --printPathWarnings[=false] print warnings on duplicate target
154 paths etc.
155 --printUnusedTemplates[=false] print warnings on unused templates.
158 --renderStaticToDisk[=false] serve static files from disk and dy‐
161 namic files from memory
162 --renderToDisk[=false] serve all files from disk (default is from
165 memory)
166 --templateMetrics[=false] display metrics about template execu‐
169 tions
170 --templateMetricsHints[=false] calculate some improvement hints
173 when combined with --templateMetrics
174 -t, --theme=[] themes to use (located in /themes/THEMENAME/)
177 --trace="" write trace to file (not useful in general)
180 -w, --watch[=true] watch filesystem for changes and recreate as
183 needed
184
188 --clock="" set the clock used by Hugo, e.g. --clock
189 2021-11-06T22:30:00.00+09:00
190 --config="" config file (default is path/config.yaml|json|toml)
193 --configDir="config" config dir
196 --debug[=false] debug output
199 -e, --environment="" build environment
202 --ignoreVendorPaths="" ignores any _vendor for module paths match‐
205 ing the given Glob pattern
206 --log[=false] enable Logging
209 --logFile="" log File path (if set, logging enabled automatically)
212 --quiet[=false] build in quiet mode
215 -s, --source="" filesystem path to read files relative from
218 --themesDir="" filesystem path to themes directory
221 -v, --verbose[=false] verbose output
224 --verboseLog[=false] verbose logging
227
231 hugo(1)
232Hugo 0.101.0 Oct 2022 HUGO-SERVER(1)