hugo/content/en/commands/hugo_completion_zsh.md at 3c1deaf201a35de08d23cc58f8f03682cace3349

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00

Bjørn Erik Pedersen dfb1895e4b Squashed 'docs/' changes from 1798dc0d5..1d5548d73

1d5548d73 build.cachebusters
3c966904d netlify: Hugo 0.112.5
b32c3a811 Bump min Go version to 1.19 when building from source (#2095)
9dea2d2f9 netlify: Hugo 0.112.4
b3fb4a1bc docs: Regenerate CLI docs
291ecd301 docs: Regen CLI docs
c886958e2 Merge commit 'd3927310d5b2404c3238f9b899db3329ea516490'

git-subtree-dir: docs
git-subtree-split: 1d5548d7355be39364404a67eee7186d5ea71930

2023-06-01 10:51:24 +02:00

2 KiB

Raw Blame History

title	slug	url
hugo completion zsh	hugo_completion_zsh	/commands/hugo_completion_zsh/

hugo completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(hugo completion zsh)

To load completions for every new session, execute once:

Linux:

hugo completion zsh > "${fpath[1]}/_hugo"

macOS:

hugo completion zsh > $(brew --prefix)/share/zsh/site-functions/_hugo

You will need to start a new shell for this setup to take effect.

hugo completion zsh [flags]

Options

  -h, --help              help for zsh
      --no-descriptions   disable completion descriptions

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 hugo.yaml|json|toml)
      --configDir string           config dir (default "config")
      --debug                      debug output
  -d, --destination string         filesystem path to write files to
  -e, --environment string         build environment
      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
      --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

2 KiB Raw Blame History