github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-27 18:51:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/commands/hugo_gen_autocomplete.md

60 lines
1.8 KiB
Markdown
Raw Normal View History

Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
---
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
---
## hugo gen autocomplete
Generate shell autocompletion script for Hugo
### Synopsis
Generates a shell autocompletion script for Hugo.
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
The script is written to the console (stdout).
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
To write to file, add the `--completionfile=/path/to/file` flag.
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
Add `--type={bash, zsh, fish or powershell}` flag to set alternative
shell type.
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
Logout and in again to reload the completion scripts,
or just source them in directly:
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
$ . /etc/bash_completion or /path/to/file
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
```
hugo gen autocomplete [flags]
```
### Options
```
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
-f, --completionfile string autocompletion file, defaults to stdout
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
-h, --help help for autocomplete
Squashed 'docs/' changes from d343ebf71..bb15e9804 bb15e9804 Update index.md (#1339) ffb2f21d1 Update index.md fc154ac02 Regenerate CLI docs a0a687738 Update index.md d0e35a844 Update index.md 86d0cc042 Update index.md bdaf7e022 Release 0.81.0 b51017445 releaser: Add release notes to /docs for release of 0.81.0 888dd8fcc docs: Regen CLI docs 8c3e8b270 docs: Regen docs helper 79e3e1ebc Merge commit 'acb9109df778fa4a51c0d8b29b3212b12988908f' 31f70af7e modules: Add config option modules.vendorClosest 2631df94e markup/goldmark: Add attributes support for blocks (tables etc.) 19dee04ad Update to Dart Sass Protocol beta6 e507721fe Refactor: Write to stdout by default d204bf160 Refactor: Remove powershell support 91bea48f5 Feat: Add zsh, fish and powershell completion support 9c915ea27 docs: Remove mention of a file size limit for readFile 5acc8b6c7 js: Add Inject config option 45321989e js: Add Shims option git-subtree-dir: docs git-subtree-split: bb15e9804ae56da41f3bdb361adc14f8711fc19d
2021-02-23 16:39:59 +00:00
-t, --type string autocompletion type (bash, zsh, fish, or powershell) (default "bash")
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
```
### Options inherited from parent commands
```
Squashed 'docs/' changes from 4895c29c5..9abd3043a 9abd3043a Add docs for shimming JS libraries 6a1c8dcd7 Update sitemap-template.md (#1245) 37c397332 Update frontends.md a0f86f6df Update configuration.md bb00cb2c1 Update page-bundles.md 773212de6 Restructure and simplify fcba7dddf Some minor clarifications of weight sorting 759b967fc Update configuration-markup.md 56708f0b7 module import path remove slash at end 59f4f4acd Doc: Fix typo in hugo command faacf2e97 Clarify pagination documentation (#1208) d8eb60887 netlify: Bump to 0.75.1 8cedf6231 Merge branch 'temp751' 188e2bf56 releaser: Add release notes to /docs for release of 0.75.1 c96d4b7a3 Update index.md 1a9d192f7 Update index.md 32731b916 Update index.md a5bfa0c9a Restore the ... home page b6850bf96 Release 0.75.0 d6e5e624f releaser: Add release notes to /docs for release of 0.75.0 8cd6b4f47 typo: already -> already 2cb2b22bb Merge commit '534ae9c57a902aea9ed6e62390dec11fa74b7122' e3525de23 docs: Regen docs helper fd746dd83 docs: Regenerate CLI docs e20127980 Add "hugo mod npm pack" 8e82c7ce1 markup/highlight: Add support to linkable line anchors on Chroma 21e94911b markup/asciidocext: Fix AsciiDoc TOC with code 50b8dace5 modules: Add noVendor to module config d05b541fe modules: Make ignoreVendor a glob pattern c946082e7 docs: Update replaceRE func 149054341 docs: Update replace func d917567df docs: Update merge function f1e093c92 docs: Regen CLI docs c7bac967d docs: Regen docs helper 7a38f7a45 Merge commit '7d7771b673e5949f554515a2c236b23192c765c8' 1a5a7263a markup/asciidoc: Add support for .TableOfContents git-subtree-dir: docs git-subtree-split: 9abd3043a9214b390e8cc148f4588bf630620851
2020-10-06 14:22:20 +00:00
--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
--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
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
```
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
Reference in a new issue Copy permalink