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. Complete documentation is available at http://gohugo.io/. hugo [flags] Options -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -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. Read More »

hugo check Contains some verification checks Synopsis Contains some verification checks Options -h, --help help for check Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo check ulimit - Check system ulimit settings Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo check ulimit Check system ulimit settings Synopsis Hugo will inspect the current ulimit settings on the system. This is primarily to ensure that Hugo can watch enough files on some OSs hugo check ulimit [flags] Options -h, --help help for ulimit Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo check - Contains some verification checks Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo config Print the site configuration Synopsis Print the site configuration, both default and custom settings. hugo config [flags] Options -h, --help help for config Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo config mounts - Print the configured file mounts Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo config mounts Print the configured file mounts Synopsis Print the configured file mounts hugo config mounts [flags] Options -h, --help help for mounts Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo config - Print the site configuration Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo convert Convert your content to different formats Synopsis Convert your content (e.g. front matter) to different formats. See convert’s subcommands toJSON, toTOML and toYAML for more information. Options -h, --help help for convert -o, --output string filesystem path to write files to --unsafe enable less safe operations, please backup first Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo convert toJSON - Convert front matter to JSON hugo convert toTOML - Convert front matter to TOML hugo convert toYAML - Convert front matter to YAML Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo convert toJSON Convert front matter to JSON Synopsis toJSON converts all front matter in the content directory to use JSON for the front matter. hugo convert toJSON [flags] Options -h, --help help for toJSON Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to --quiet build in quiet mode -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 -v, --verbose verbose output --verboseLog verbose logging SEE ALSO hugo convert - Convert your content to different formats Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo convert toTOML Convert front matter to TOML Synopsis toTOML converts all front matter in the content directory to use TOML for the front matter. hugo convert toTOML [flags] Options -h, --help help for toTOML Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to --quiet build in quiet mode -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 -v, --verbose verbose output --verboseLog verbose logging SEE ALSO hugo convert - Convert your content to different formats Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo convert toYAML Convert front matter to YAML Synopsis toYAML converts all front matter in the content directory to use YAML for the front matter. hugo convert toYAML [flags] Options -h, --help help for toYAML Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to --quiet build in quiet mode -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 -v, --verbose verbose output --verboseLog verbose logging SEE ALSO hugo convert - Convert your content to different formats Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo deploy Deploy your site to a Cloud provider. Synopsis Deploy your site to a Cloud provider. See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed documentation. hugo deploy [flags] Options --confirm ask for confirmation before making changes to the target --dryRun dry run --force force upload of all files -h, --help help for deploy --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) --target string target deployment from deployments section in config file; defaults to the first one Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo env Print Hugo version and environment info Synopsis Print Hugo version and environment info. This is useful in Hugo bug reports. hugo env [flags] Options -h, --help help for env Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo gen A collection of several useful generators. Synopsis A collection of several useful generators. Options -h, --help help for gen Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo gen autocomplete - Generate shell autocompletion script for Hugo hugo gen chromastyles - Generate CSS stylesheet for the Chroma code highlighter hugo gen doc - Generate Markdown documentation for the Hugo CLI. Read More »

hugo gen autocomplete Generate shell autocompletion script for Hugo Synopsis Generates a shell autocompletion script for Hugo. NOTE: The current version supports Bash only. This should work for *nix systems with Bash installed. By default, the file is written directly to /etc/bash_completion.d for convenience, and the command may need superuser rights, e.g.: $ sudo hugo gen autocomplete Add --completionfile=/path/to/file flag to set alternative file-path and name. Logout and in again to reload the completion scripts, or just source them in directly: Read More »

hugo gen chromastyles Generate CSS stylesheet for the Chroma code highlighter Synopsis Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config. See https://help.farbox.com/pygments.html for preview of available styles hugo gen chromastyles [flags] Options -h, --help help for chromastyles --highlightStyle string style used for highlighting lines (see https://github.com/alecthomas/chroma) (default "bg:#ffffcc") --linesStyle string style used for line numbers (see https://github. Read More »

hugo gen doc Generate Markdown documentation for the Hugo CLI. Synopsis Generate Markdown documentation for the Hugo CLI. This command is, mostly, used to create up-to-date documentation of Hugo’s command-line interface for https://gohugo.io/. It creates one Markdown file per command with front matter suitable for rendering in Hugo. hugo gen doc [flags] Options --dir string the directory to write the doc. (default "/tmp/hugodoc/") -h, --help help for doc Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo gen man Generate man pages for the Hugo CLI Synopsis This command automatically generates up-to-date man pages of Hugo’s command-line interface. By default, it creates the man page files in the “man” directory under the current directory. hugo gen man [flags] Options --dir string the directory to write the man pages. (default "man/") -h, --help help for man Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo import Import your site from others. Synopsis Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. hugo import jekyll jekyll_root_path target_path. Options -h, --help help for import Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo import jekyll - hugo import from Jekyll Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo import jekyll hugo import from Jekyll Synopsis hugo import from Jekyll. Import from Jekyll requires two paths, e.g. hugo import jekyll jekyll_root_path target_path. hugo import jekyll [flags] Options --force allow import into non-empty target directory -h, --help help for jekyll Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo import - Import your site from others. Read More »

hugo list Listing out various types of content Synopsis Listing out various types of content. List requires a subcommand, e.g. hugo list drafts. Options -h, --help help for list Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site hugo list all - List all posts hugo list drafts - List all drafts hugo list expired - List all posts already expired hugo list future - List all posts dated in the future Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo list all List all posts Synopsis List all of the posts in your content directory, include drafts, future and expired pages. hugo list all [flags] Options -h, --help help for all Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo list - Listing out various types of content Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo list drafts List all drafts Synopsis List all of the drafts in your content directory. hugo list drafts [flags] Options -h, --help help for drafts Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo list - Listing out various types of content Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo list expired List all posts already expired Synopsis List all of the posts in your content directory which has already expired. hugo list expired [flags] Options -h, --help help for expired Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo list - Listing out various types of content Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo list future List all posts dated in the future Synopsis List all of the posts in your content directory which will be posted in the future. hugo list future [flags] Options -h, --help help for future Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo list - Listing out various types of content Auto generated by spf13/cobra on 3-Mar-2020 Read More »

hugo mod Various Hugo Modules helpers. Synopsis 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 –ignoreVendor flag provided), Go Modules, or a folder inside the themes directory, in that order. Read More »

hugo mod clean Delete the Hugo Module cache for the current project. Synopsis Delete the Hugo Module cache for the current project. Note that after you run this command, all of your dependencies will be re-downloaded next time you run “hugo”. Also note that if you configure a positive maxAge for the “modules” file cache, it will also be cleaned as part of “hugo –gc”. hugo mod clean [flags] Options --all clean entire module cache -h, --help help for clean --pattern string pattern matching module paths to clean (all if not set), e. Read More »

hugo mod get Resolves dependencies in your current Hugo Project. Synopsis Resolves dependencies in your current Hugo Project. Some examples: Install the latest version possible for a given module: hugo mod get github.com/gohugoio/testshortcodes Install a specific version: hugo mod get github.com/gohugoio/testshortcodes@v0.3.0 Install the latest versions of all module dependencies: hugo mod get -u hugo mod get -u ./... (recursive) Run “go help get” for more information. All flags available for “go get” is also relevant here. Read More »

hugo mod graph Print a module dependency graph. Synopsis Print a module dependency graph with information about module status (disabled, vendored). Note that for vendored modules, that is the version listed and not the one from go.mod. hugo mod graph [flags] Options -h, --help help for graph Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo mod - Various Hugo Modules helpers. Read More »

hugo mod init Initialize this project as a Hugo Module. Synopsis Initialize this project as a Hugo Module. It will try to guess the module path, but you may help by passing it as an argument, e.g: hugo mod init github.com/gohugoio/testshortcodes Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module inside a subfolder on GitHub, as one example. hugo mod init [flags] Options -h, --help help for init Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo mod tidy Remove unused entries in go.mod and go.sum. Synopsis Remove unused entries in go.mod and go.sum. hugo mod tidy [flags] Options -h, --help help for tidy Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo mod - Various Hugo Modules helpers. Read More »

hugo mod vendor Vendor all module dependencies into the _vendor directory. Synopsis Vendor all module dependencies into the _vendor directory. If a module is vendored, that is where Hugo will look for it’s dependencies. hugo mod vendor [flags] Options -h, --help help for vendor Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo mod - Various Hugo Modules helpers. Read More »

hugo mod verify Verify dependencies. Synopsis Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded. hugo mod verify [flags] Options --clean delete module cache for dependencies that fail verification -h, --help help for verify Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo mod - Various Hugo Modules helpers. Read More »

hugo new Create new content for your site Synopsis Create a new content file and automatically set the date and title. It will guess which kind of file to create based on the path provided. You can also specify the kind with -k KIND. If archetypes are provided in your theme or site, they will be used. Ensure you run this within the root directory of your site. hugo new [path] [flags] Options -b, --baseURL string hostname (and path) to the root, e. Read More »

hugo new site Create a new site (skeleton) Synopsis Create a new site in the provided directory. The new site will have the correct structure, but no content or theme yet. Use hugo new [contentPath] to create new content. hugo new site [path] [flags] Options --force init inside non-empty directory -f, --format string config & frontmatter format (default "toml") -h, --help help for site Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo new theme Create a new theme Synopsis Create a new theme (skeleton) called [name] in the current directory. New theme is a skeleton. Please add content to the touched files. Add your name to the copyright line in the license and adjust the theme.toml file as you see fit. hugo new theme [name] [flags] Options -h, --help help for theme Options inherited from parent commands --config string config file (default is path/config. Read More »

hugo server A high performance webserver Synopsis Hugo provides its own webserver which builds and serves the site. While hugo server is high performance, it is a webserver with limited options. Many run it in production, but the standard behavior is for people to use it in development and use a more full featured server such as Nginx or Caddy. ‘hugo server’ will avoid writing the rendered and served content to disk, preferring to store it in memory. Read More »

hugo version Print the version number of Hugo Synopsis All software has versions. This is Hugo’s. hugo version [flags] Options -h, --help help for version Options inherited from parent commands --config string config file (default is path/config.yaml|json|toml) --configDir string config dir (default "config") --debug debug output -e, --environment string build environment --ignoreVendor ignores any _vendor directory --log enable Logging --logFile string log File path (if set, logging enabled automatically) --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 hugo - hugo builds your site Auto generated by spf13/cobra on 3-Mar-2020 Read More »