hugo-server(1)

1HUGO-SERVER(1)Apr(2020)                                HUGO-SERVER(1)Apr(2020)
2
3
4
5Hugo 0.69.0 Hugo Manual
6
7

NAME

9       hugo-server - A high performance webserver
10
11
12

SYNOPSIS

14       hugo server [flags]
15
16
17

DESCRIPTION

19       Hugo  provides  its  own  webserver  which  builds and serves the site.
20       While hugo server is high performance, it is a webserver  with  limited
21       options.   Many  run it in production, but the standard behavior is for
22       people to use it in development and use a  more  full  featured  server
23       such as Nginx or Caddy.
24
25
26       'hugo  server'  will  avoid  writing the rendered and served content to
27       disk, preferring to store it in memory.
28
29
30       By default hugo will also watch your files for any changes you make and
31       automatically  rebuild  the  site.  It  will  then live reload any open
32       browser pages and push the latest content to them. As most  Hugo  sites
33       are  built  in a fraction of a second, you will be able to save and see
34       your changes nearly instantly.
35
36
37

OPTIONS

39       --appendPort[=true]      append port to baseURL
40
41
42       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
43       http://spf13.com/
44
45
46       --bind="127.0.0.1"      interface to which the server will bind
47
48
49       -D, --buildDrafts[=false]      include content marked as draft
50
51
52       -E, --buildExpired[=false]      include expired content
53
54
55       -F,  --buildFuture[=false]      include content with publishdate in the
56       future
57
58
59       --cacheDir=""       filesystem  path  to  cache  directory.   Defaults:
60       $TMPDIR/hugo_cache/
61
62
63       --cleanDestinationDir[=false]       remove  files  from destination not
64       found in static directories
65
66
67       -c, --contentDir=""      filesystem path to content directory
68
69
70       -d, --destination=""      filesystem path to write files to
71
72
73       --disableBrowserError[=false]      do not  show  build  errors  in  the
74       browser
75
76
77       --disableFastRender[=false]      enables full re-renders on changes
78
79
80       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
81
82
83       --disableLiveReload[=false]       watch  without  enabling live browser
84       reload on rebuild
85
86
87       --enableGitInfo[=false]      add Git revision, date and author info  to
88       the pages
89
90
91       --forceSyncStatic[=false]      copy all files when static is changed.
92
93
94       --gc[=false]      enable to run some cleanup tasks (remove unused cache
95       files) after the build
96
97
98       -h, --help[=false]      help for server
99
100
101       --i18n-warnings[=false]      print missing translations
102
103
104       --ignoreCache[=false]      ignores the cache directory
105
106
107       -l, --layoutDir=""      filesystem path to layout directory
108
109
110       --liveReloadPort=-1      port for live reloading  (i.e.  443  in  HTTPS
111       proxy situations)
112
113
114       --meminterval="100ms"       interval  to  poll  memory  usage (requires
115       --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m",
116       "h".
117
118
119       --memstats=""      log memory usage to this file
120
121
122       --minify[=false]       minify  any  supported  output format (HTML, XML
123       etc.)
124
125
126       --navigateToChanged[=false]      navigate to changed  content  file  on
127       live browser reload
128
129
130       --noChmod[=false]      don't sync permission mode of files
131
132
133       --noHTTPCache[=false]      prevent HTTP caching
134
135
136       --noTimes[=false]      don't sync modification time of files
137
138
139       --path-warnings[=false]       print  warnings on duplicate target paths
140       etc.
141
142
143       -p, --port=1313      port on which the server will listen
144
145
146       --renderToDisk[=false]      render to Destination path (default is ren‐
147       der to memory  serve from there)
148
149
150       --templateMetrics[=false]       display  metrics  about template execu‐
151       tions
152
153
154       --templateMetricsHints[=false]      calculate  some  improvement  hints
155       when combined with --templateMetrics
156
157
158       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
159
160
161       --trace=""      write trace to file (not useful in general)
162
163
164       -w,  --watch[=true]       watch  filesystem for changes and recreate as
165       needed
166
167
168

OPTIONS INHERITED FROM PARENT COMMANDS

170       --config=""      config file (default is path/config.yaml|json|toml)
171
172
173       --configDir="config"      config dir
174
175
176       --debug[=false]      debug output
177
178
179       -e, --environment=""      build environment
180
181
182       --ignoreVendor[=false]      ignores any _vendor directory
183
184
185       --log[=false]      enable Logging
186
187
188       --logFile=""      log File path (if set, logging enabled automatically)
189
190
191       --quiet[=false]      build in quiet mode
192
193
194       -s, --source=""      filesystem path to read files relative from
195
196
197       --themesDir=""      filesystem path to themes directory
198
199
200       -v, --verbose[=false]      verbose output
201
202
203       --verboseLog[=false]      verbose logging
204
205
206

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO