2019-10-21 04:22:28 -04:00
|
|
|
---
|
|
|
|
|
title: "hugo"
|
|
|
|
|
slug: hugo
|
|
|
|
|
url: /commands/hugo/
|
|
|
|
|
---
|
|
|
|
|
## hugo
|
|
|
|
|
|
|
|
|
|
hugo builds your site
|
|
|
|
|
|
|
|
|
|
### Synopsis
|
|
|
|
|
|
|
|
|
|
hugo is the main command, used to build your Hugo site.
|
|
|
|
|
|
|
|
|
|
Hugo is a Fast and Flexible Static Site Generator
|
|
|
|
|
built with love by spf13 and friends in Go.
|
|
|
|
|
|
2022-04-08 07:32:01 -04:00
|
|
|
Complete documentation is available at https://gohugo.io/.
|
2019-10-21 04:22:28 -04:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
hugo [flags]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
|
|
|
```
|
2022-04-08 07:32:01 -04:00
|
|
|
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
|
2020-10-06 10:22:20 -04:00
|
|
|
-D, --buildDrafts include content marked as draft
|
|
|
|
|
-E, --buildExpired include expired content
|
|
|
|
|
-F, --buildFuture include content with publishdate in the future
|
|
|
|
|
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
|
|
|
|
|
--cleanDestinationDir remove files from destination not found in static directories
|
2022-05-31 04:21:09 -04:00
|
|
|
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
|
2023-02-23 01:52:04 -05:00
|
|
|
--config string config file (default is hugo.yaml|json|toml)
|
2020-10-06 10:22:20 -04:00
|
|
|
--configDir string config dir (default "config")
|
|
|
|
|
-c, --contentDir string filesystem path to content directory
|
|
|
|
|
--debug debug output
|
|
|
|
|
-d, --destination string filesystem path to write files to
|
|
|
|
|
--disableKinds strings disable different kind of pages (home, RSS etc.)
|
2022-03-08 13:37:17 -05:00
|
|
|
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
|
2020-10-06 10:22:20 -04:00
|
|
|
-e, --environment string build environment
|
|
|
|
|
--forceSyncStatic copy all files when static is changed.
|
|
|
|
|
--gc enable to run some cleanup tasks (remove unused cache files) after the build
|
|
|
|
|
-h, --help help for hugo
|
|
|
|
|
--ignoreCache ignores the cache directory
|
|
|
|
|
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
|
|
|
|
|
-l, --layoutDir string filesystem path to layout directory
|
|
|
|
|
--log enable Logging
|
|
|
|
|
--logFile string log File path (if set, logging enabled automatically)
|
|
|
|
|
--minify minify any supported output format (HTML, XML etc.)
|
2022-06-16 01:22:11 -04:00
|
|
|
--noBuildLock don't create .hugo_build.lock file
|
2020-10-06 10:22:20 -04:00
|
|
|
--noChmod don't sync permission mode of files
|
|
|
|
|
--noTimes don't sync modification time of files
|
2022-02-14 06:58:42 -05:00
|
|
|
--panicOnWarning panic on first WARNING log
|
2021-07-21 04:45:05 -04:00
|
|
|
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
|
2022-03-08 13:37:17 -05:00
|
|
|
--printI18nWarnings print missing translations
|
|
|
|
|
--printMemoryUsage print memory usage to screen at intervals
|
|
|
|
|
--printPathWarnings print warnings on duplicate target paths etc.
|
|
|
|
|
--printUnusedTemplates print warnings on unused templates.
|
2020-10-06 10:22:20 -04:00
|
|
|
--quiet build in quiet mode
|
|
|
|
|
--renderToMemory render to memory (only useful for benchmark testing)
|
|
|
|
|
-s, --source string filesystem path to read files relative from
|
|
|
|
|
--templateMetrics display metrics about template executions
|
|
|
|
|
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
|
|
|
|
|
-t, --theme strings themes to use (located in /themes/THEMENAME/)
|
|
|
|
|
--themesDir string filesystem path to themes directory
|
|
|
|
|
--trace file write trace to file (not useful in general)
|
|
|
|
|
-v, --verbose verbose output
|
|
|
|
|
--verboseLog verbose logging
|
|
|
|
|
-w, --watch watch filesystem for changes and recreate as needed
|
2019-10-21 04:22:28 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### SEE ALSO
|
|
|
|
|
|
2022-03-08 13:37:17 -05:00
|
|
|
* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
|
2019-10-21 04:22:28 -04:00
|
|
|
* [hugo config](/commands/hugo_config/) - Print the site configuration
|
|
|
|
|
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
|
|
|
|
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
|
|
|
|
|
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
|
|
|
|
|
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
|
|
|
|
* [hugo import](/commands/hugo_import/) - Import your site from others.
|
|
|
|
|
* [hugo list](/commands/hugo_list/) - Listing out various types of content
|
|
|
|
|
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
|
|
|
|
|
* [hugo new](/commands/hugo_new/) - Create new content for your site
|
|
|
|
|
* [hugo server](/commands/hugo_server/) - A high performance webserver
|
2023-05-27 10:59:59 -04:00
|
|
|
* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info
|
2019-10-21 04:22:28 -04:00
|
|
|
|
