hugo

Hugo builds your site

Subcommands

NameDescription
checkContains some verification checks
configPrint the site configuration
convertConvert your content to different formats
deployDeploy your site to a Cloud provider
envPrint Hugo version and environment info
genA collection of several useful generators
helpHelp about any command
importImport your site from others
listListing out various types of content
modVarious Hugo Modules helpers
newCreate new content for your site
serverA high performance webserver
versionPrint the version number of Hugo

Options

NameDescription
-h,--helphelp for hugo
-b,--baseURL <command>Hostname (and path) to the root, e.g. http://spf13.com/
-D,--buildDrafts <command>Include content marked as draft (default false)
-E,--buildExpired <command>Include expired content (default false)
-F,--buildFuture <command>Include content with publishdate in the future (default false)
--cacheDir <command>Filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir <command>Remove files from destination not found in static directories (default false)
-c,--contentDir <command>Filesystem path to content directory
-d,--destination <command>Filesystem path to write files to
--disableKinds <command>Disable different kind of pages (home, RSS etc.)
--enableGitInfo <command>Add Git revision, date and author info to the pages (default false)
--forceSyncStatic <command>Copy all files when static is changed (default false)
--gc <command>Enable to run some cleanup tasks (remove unused cache files) after the build (default false)
--i18n-warnings <command>Print missing translations (default false)
--ignoreCache <command>Ignores the cache directory (default false)
-l,--layoutDir <command>Filesystem path to layout directory
--minify <command>Minify any supported output format (HTML, XML etc.) (default false)
--noChmod <command>Don't sync permission mode of files (default false)
--noTimes <command>Don't sync modification time of files (default false)
--path-warnings <command>Print warnings on duplicate target paths etc (default false)
--poll <command>Set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--print-mem <command>Print memory usage to screen at intervals (default false)
--templateMetrics <command>Display metrics about template executions (default false)
--templateMetricsHints <command>Calculate some improvement hints when combined with --templateMetrics (default false)
-t,--theme <command>Themes to use (located in /themes/THEMENAME/)
--trace <command>Write trace to file (not useful in general)
--config <command>Config file (default is path/config.yaml|json|toml)
--configDir <command>Config dir (default 'config')
--debug <command>Debug output (default false)
-e,--environment <command>Build environment
--ignoreVendor <command>Ignores any _vendor directory (default false)
--ignoreVendorPaths <command>Ignores any _vendor for module paths matching the given Glob pattern
--log <command>Enable Logging (default false)
--logFile <command>Log File path (if set, logging enabled automatically)
--quiet <command>Build in quiet mode (default false)
-s,--source <command>Filesystem path to read files relative from
--themesDir <command>Filesystem path to themes directory
-v, --verbose <command>Verbose output (default false)
--verboseLog <command>Verbose logging (default false)
-w,--watch <command>Watch filesystem for changes and recreate as needed (default true)
--renderToMemoryRender to memory (only useful for benchmark testing)