DragonFly On-Line Manual Pages

HUGO-MOD(1)                       Hugo Manual                      HUGO-MOD(1)

NAME
       hugo-mod - Various Hugo Modules helpers.

SYNOPSIS
       hugo mod [flags]

DESCRIPTION
       Various helpers to help manage the modules in your project's dependency
       graph.

       Most operations here requires a Go version installed on your system (>=
       Go 1.12) and the relevant VCS client (typically Git).  This is not
       needed if you only operate on modules inside /themes or if you have
       vendored them via "hugo mod vendor".

       Note that Hugo will always start out by resolving the components
       defined in the site configuration, provided by a _vendor directory (if
       no --ignoreVendorPaths flag provided), Go Modules, or a folder inside
       the themes directory, in that order.

       See https://gohugo.io/hugo-modules/ for more information.

OPTIONS
       -b, --baseURL=""    hostname (and path) to the root, e.g.
       https://spf13.com/

       -D, --buildDrafts[=false]     include content marked as draft

       -E, --buildExpired[=false]    include expired content

       -F, --buildFuture[=false]     include content with publishdate in the
       future

       --cacheDir=""  filesystem path to cache directory. Defaults:
       $TMPDIR/hugo_cache/

       --cleanDestinationDir[=false]      remove files from destination not
       found in static directories

       --clock=""     set the clock used by Hugo, e.g. --clock
       2021-11-06T22:30:00.00+09:00

       -c, --contentDir=""      filesystem path to content directory

       -d, --destination=""     filesystem path to write files to

       --disableKinds=[]   disable different kind of pages (home, RSS etc.)

       --enableGitInfo[=false]  add Git revision, date, author, and CODEOWNERS
       info to the pages

       -e, --environment=""     build environment

       --forceSyncStatic[=false]     copy all files when static is changed.

       --gc[=false]   enable to run some cleanup tasks (remove unused cache
       files) after the build

       -h, --help[=false]  help for mod

       --ignoreCache[=false]    ignores the cache directory

       --ignoreVendorPaths=""   ignores any _vendor for module paths matching
       the given Glob pattern

       -l, --layoutDir=""  filesystem path to layout directory

       --minify[=false]    minify any supported output format (HTML, XML etc.)

       --noBuildLock[=false]    don't create .hugo_build.lock file

       --noChmod[=false]   don't sync permission mode of files

       --noTimes[=false]   don't sync modification time of files

       --panicOnWarning[=false]      panic on first WARNING log

       --poll=""      set this to a poll interval, e.g --poll 700ms, to use a
       poll based approach to watch for file system changes

       --printI18nWarnings[=false]   print missing translations

       --printMemoryUsage[=false]    print memory usage to screen at intervals

       --printPathWarnings[=false]   print warnings on duplicate target paths
       etc.

       --printUnusedTemplates[=false]     print warnings on unused templates.

       -s, --source=""     filesystem path to read files relative from

       --templateMetrics[=false]     display metrics about template executions

       --templateMetricsHints[=false]     calculate some improvement hints
       when combined with --templateMetrics

       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)

       --themesDir=""      filesystem path to themes directory

       --trace=""     write trace to file (not useful in general)

OPTIONS INHERITED FROM PARENT COMMANDS
       --config=""    config file (default is hugo.yaml|json|toml)

       --configDir="config"     config dir

       --debug[=false]     debug output

       --log[=false]  enable Logging

       --logFile=""   log File path (if set, logging enabled automatically)

       --quiet[=false]     build in quiet mode

       -v, --verbose[=false]    verbose output

       --verboseLog[=false]     verbose logging

SEE ALSO
       hugo(1), hugo-mod-clean(1), hugo-mod-get(1), hugo-mod-graph(1), hugo-
       mod-init(1), hugo-mod-npm(1), hugo-mod-tidy(1), hugo-mod-vendor(1),
       hugo-mod-verify(1)

Hugo 0.111.3                       Sep 2023                        HUGO-MOD(1)