hugo/docs/content/en/commands/hugo_completion_zsh.md

69 lines
2 KiB
Markdown
Raw Normal View History

2021-08-03 05:55:02 -04:00
---
title: "hugo completion zsh"
slug: hugo_completion_zsh
url: /commands/hugo_completion_zsh/
---
## hugo completion zsh
2022-02-28 02:12:35 -05:00
Generate the autocompletion script for zsh
2021-08-03 05:55:02 -04:00
### 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:
2022-02-28 02:12:35 -05:00
echo "autoload -U compinit; compinit" >> ~/.zshrc
2021-08-03 05:55:02 -04:00
2022-09-22 11:57:13 -04:00
To load completions in your current shell session:
source <(hugo completion zsh); compdef _hugo hugo
2021-08-03 05:55:02 -04:00
To load completions for every new session, execute once:
2022-02-28 02:12:35 -05:00
#### Linux:
hugo completion zsh > "${fpath[1]}/_hugo"
#### macOS:
2022-09-22 11:57:13 -04:00
hugo completion zsh > $(brew --prefix)/share/zsh/site-functions/_hugo
2021-08-03 05:55:02 -04:00
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
```
2022-05-08 10:57:29 -04:00
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
2023-01-17 06:52:53 -05:00
--config string config file (default is hugo.yaml|json|toml)
2021-08-03 05:55:02 -04:00
--configDir string config dir (default "config")
--debug debug output
-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
```
### SEE ALSO
2022-02-28 02:12:35 -05:00
* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
2021-08-03 05:55:02 -04:00