docs: Regen CLI docs

This commit is contained in:
Bjørn Erik Pedersen 2022-11-17 16:19:22 +01:00
parent 9f7fb0a73b
commit 0a019a1a59
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
9 changed files with 237 additions and 237 deletions

View file

@ -18,25 +18,25 @@ hugo config [flags]
### Options ### Options
``` ```
-h, --help help for config --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for config
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -16,27 +16,27 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options ### Options
``` ```
-h, --help help for convert --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-o, --output string filesystem path to write files to -e, --environment string build environment
--unsafe enable less safe operations, please backup first -h, --help help for convert
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -22,31 +22,31 @@ hugo deploy [flags]
### Options ### Options
``` ```
--confirm ask for confirmation before making changes to the target --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--dryRun dry run --confirm ask for confirmation before making changes to the target
--force force upload of all files --dryRun dry run
-h, --help help for deploy -e, --environment string build environment
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true) --force force upload of all files
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256) -h, --help help for deploy
--target string target deployment from deployments section in config file; defaults to the first one --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
-s, --source string filesystem path to read files relative from
--target string target deployment from deployments section in config file; defaults to the first one
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -16,25 +16,25 @@ List requires a subcommand, e.g. `hugo list drafts`.
### Options ### Options
``` ```
-h, --help help for list --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for list
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -26,53 +26,53 @@ See https://gohugo.io/hugo-modules/ for more information.
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-d, --destination string filesystem path to write files to -c, --contentDir string filesystem path to content directory
--disableKinds strings disable different kind of pages (home, RSS etc.) -d, --destination string filesystem path to write files to
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --disableKinds strings disable different kind of pages (home, RSS etc.)
--forceSyncStatic copy all files when static is changed. --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--gc enable to run some cleanup tasks (remove unused cache files) after the build -e, --environment string build environment
-h, --help help for mod --forceSyncStatic copy all files when static is changed.
--ignoreCache ignores the cache directory --gc enable to run some cleanup tasks (remove unused cache files) after the build
-l, --layoutDir string filesystem path to layout directory -h, --help help for mod
--minify minify any supported output format (HTML, XML etc.) --ignoreCache ignores the cache directory
--noBuildLock don't create .hugo_build.lock file --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--noChmod don't sync permission mode of files -l, --layoutDir string filesystem path to layout directory
--noTimes don't sync modification time of files --minify minify any supported output format (HTML, XML etc.)
--panicOnWarning panic on first WARNING log --noBuildLock don't create .hugo_build.lock file
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes --noChmod don't sync permission mode of files
--printI18nWarnings print missing translations --noTimes don't sync modification time of files
--printMemoryUsage print memory usage to screen at intervals --panicOnWarning panic on first WARNING log
--printPathWarnings print warnings on duplicate target paths etc. --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--printUnusedTemplates print warnings on unused templates. --printI18nWarnings print missing translations
--templateMetrics display metrics about template executions --printMemoryUsage print memory usage to screen at intervals
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --printPathWarnings print warnings on duplicate target paths etc.
-t, --theme strings themes to use (located in /themes/THEMENAME/) --printUnusedTemplates print warnings on unused templates.
--trace file write trace to file (not useful in general) -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)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -25,56 +25,56 @@ hugo new [path] [flags]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-d, --destination string filesystem path to write files to -c, --contentDir string filesystem path to content directory
--disableKinds strings disable different kind of pages (home, RSS etc.) -d, --destination string filesystem path to write files to
--editor string edit new content with this editor, if provided --disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --editor string edit new content with this editor, if provided
-f, --force overwrite file if it already exists --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--forceSyncStatic copy all files when static is changed. -e, --environment string build environment
--gc enable to run some cleanup tasks (remove unused cache files) after the build -f, --force overwrite file if it already exists
-h, --help help for new --forceSyncStatic copy all files when static is changed.
--ignoreCache ignores the cache directory --gc enable to run some cleanup tasks (remove unused cache files) after the build
-k, --kind string content type to create -h, --help help for new
-l, --layoutDir string filesystem path to layout directory --ignoreCache ignores the cache directory
--minify minify any supported output format (HTML, XML etc.) --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--noBuildLock don't create .hugo_build.lock file -k, --kind string content type to create
--noChmod don't sync permission mode of files -l, --layoutDir string filesystem path to layout directory
--noTimes don't sync modification time of files --minify minify any supported output format (HTML, XML etc.)
--panicOnWarning panic on first WARNING log --noBuildLock don't create .hugo_build.lock file
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes --noChmod don't sync permission mode of files
--printI18nWarnings print missing translations --noTimes don't sync modification time of files
--printMemoryUsage print memory usage to screen at intervals --panicOnWarning panic on first WARNING log
--printPathWarnings print warnings on duplicate target paths etc. --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--printUnusedTemplates print warnings on unused templates. --printI18nWarnings print missing translations
--templateMetrics display metrics about template executions --printMemoryUsage print memory usage to screen at intervals
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --printPathWarnings print warnings on duplicate target paths etc.
-t, --theme strings themes to use (located in /themes/THEMENAME/) --printUnusedTemplates print warnings on unused templates.
--trace file write trace to file (not useful in general) -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)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -20,27 +20,27 @@ hugo new site [path] [flags]
### Options ### Options
``` ```
--force init inside non-empty directory --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-f, --format string config file format (default "toml") -e, --environment string build environment
-h, --help help for site --force init inside non-empty directory
-f, --format string config file format (default "toml")
-h, --help help for site
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -21,25 +21,25 @@ hugo new theme [name] [flags]
### Options ### Options
``` ```
-h, --help help for theme --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for theme
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO

View file

@ -29,67 +29,67 @@ hugo server [flags]
### Options ### Options
``` ```
--appendPort append port to baseURL (default true) --appendPort append port to baseURL (default true)
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--bind string interface to which the server will bind (default "127.0.0.1") --bind string interface to which the server will bind (default "127.0.0.1")
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-d, --destination string filesystem path to write files to -c, --contentDir string filesystem path to content directory
--disableBrowserError do not show build errors in the browser -d, --destination string filesystem path to write files to
--disableFastRender enables full re-renders on changes --disableBrowserError do not show build errors in the browser
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableFastRender enables full re-renders on changes
--disableLiveReload watch without enabling live browser reload on rebuild --disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --disableLiveReload watch without enabling live browser reload on rebuild
--forceSyncStatic copy all files when static is changed. --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--gc enable to run some cleanup tasks (remove unused cache files) after the build -e, --environment string build environment
-h, --help help for server --forceSyncStatic copy all files when static is changed.
--ignoreCache ignores the cache directory --gc enable to run some cleanup tasks (remove unused cache files) after the build
-l, --layoutDir string filesystem path to layout directory -h, --help help for server
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) --ignoreCache ignores the cache directory
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--memstats string log memory usage to this file -l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.) --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
--navigateToChanged navigate to changed content file on live browser reload --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
--noBuildLock don't create .hugo_build.lock file --memstats string log memory usage to this file
--noChmod don't sync permission mode of files --minify minify any supported output format (HTML, XML etc.)
--noHTTPCache prevent HTTP caching --navigateToChanged navigate to changed content file on live browser reload
--noTimes don't sync modification time of files --noBuildLock don't create .hugo_build.lock file
--panicOnWarning panic on first WARNING log --noChmod don't sync permission mode of files
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes --noHTTPCache prevent HTTP caching
-p, --port int port on which the server will listen (default 1313) --noTimes don't sync modification time of files
--printI18nWarnings print missing translations --panicOnWarning panic on first WARNING log
--printMemoryUsage print memory usage to screen at intervals --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--printPathWarnings print warnings on duplicate target paths etc. -p, --port int port on which the server will listen (default 1313)
--printUnusedTemplates print warnings on unused templates. --printI18nWarnings print missing translations
--renderStaticToDisk serve static files from disk and dynamic files from memory --printMemoryUsage print memory usage to screen at intervals
--renderToDisk serve all files from disk (default is from memory) --printPathWarnings print warnings on duplicate target paths etc.
--templateMetrics display metrics about template executions --printUnusedTemplates print warnings on unused templates.
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --renderStaticToDisk serve static files from disk and dynamic files from memory
-t, --theme strings themes to use (located in /themes/THEMENAME/) --renderToDisk serve all files from disk (default is from memory)
--trace file write trace to file (not useful in general) -s, --source string filesystem path to read files relative from
-w, --watch watch filesystem for changes and recreate as needed (default true) --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)
-w, --watch watch filesystem for changes and recreate as needed (default true)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 --config string config file (default is path/config.yaml|json|toml)
--config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config")
--configDir string config dir (default "config") --debug debug output
--debug debug output --log enable Logging
-e, --environment string build environment --logFile string log File path (if set, logging enabled automatically)
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --quiet build in quiet mode
--log enable Logging -v, --verbose verbose output
--logFile string log File path (if set, logging enabled automatically) --verboseLog verbose logging
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO