-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(deps): bump github.com/mikefarah/yq/v4 from 4.43.1 to 4.44.2 (#…
…2799) Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Austin Abro <AustinAbro321@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Austin Abro <AustinAbro321@gmail.com> Co-authored-by: schristoff <28318173+schristoff@users.noreply.github.com>
- Loading branch information
3 people
authored
Jul 31, 2024
1 parent
7a5fb9e
commit 9be2009
Showing
4 changed files
with
119 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
site/src/content/docs/commands/zarf_tools_yq_completion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| title: zarf tools yq completion | ||
| description: Zarf CLI command reference for <code>zarf tools yq completion</code>. | ||
| tableOfContents: false | ||
| --- | ||
|
|
||
| <!-- Page generated by Zarf; DO NOT EDIT --> | ||
|
|
||
| ## zarf tools yq completion | ||
|
|
||
| Generate the autocompletion script for the specified shell | ||
|
|
||
| ### Synopsis | ||
|
|
||
| To load completions: | ||
|
|
||
| Bash: | ||
|
|
||
| $ source <(yq completion bash) | ||
|
|
||
| # To load completions for each session, execute once: | ||
| Linux: | ||
| $ yq completion bash > /etc/bash_completion.d/yq | ||
| MacOS: | ||
| $ yq completion bash > /usr/local/etc/bash_completion.d/yq | ||
|
|
||
| Zsh: | ||
|
|
||
| # 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 for each session, execute once: | ||
| $ yq completion zsh > "${fpath[1]}/_yq" | ||
|
|
||
| # You will need to start a new shell for this setup to take effect. | ||
|
|
||
| Fish: | ||
|
|
||
| $ yq completion fish | source | ||
|
|
||
| # To load completions for each session, execute once: | ||
| $ yq completion fish > ~/.config/fish/completions/yq.fish | ||
|
|
||
|
|
||
| ``` | ||
| zarf tools yq completion [bash|zsh|fish|powershell] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for completion | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| -C, --colors force print with colors | ||
| --csv-auto-parse parse CSV YAML/JSON values (default true) | ||
| --csv-separator char CSV Separator character (default ,) | ||
| -e, --exit-status set exit status if there are no matches or null or false is returned | ||
| --expression string forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file. | ||
| --from-file string Load expression from specified file. | ||
| -f, --front-matter string (extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact | ||
| --header-preprocess Slurp any header comments and separators before processing expression. (default true) | ||
| -I, --indent int sets indent level for output (default 2) | ||
| -i, --inplace update the file in place of first file given. | ||
| -p, --input-format string [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|lua|l] parse format for input. (default "auto") | ||
| --lua-globals output keys as top-level global variables | ||
| --lua-prefix string prefix (default "return ") | ||
| --lua-suffix string suffix (default ";\n") | ||
| --lua-unquoted output unquoted string keys (e.g. {foo="bar"}) | ||
| -M, --no-colors force print with no colors | ||
| -N, --no-doc Don't print document separators (---) | ||
| -0, --nul-output Use NUL char to separate values. If unwrap scalar is also set, fail if unwrapped scalar contains NUL char. | ||
| -n, --null-input Don't read input, simply evaluate the expression given. Useful for creating docs from scratch. | ||
| -o, --output-format string [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|shell|s|lua|l] output format type. (default "auto") | ||
| -P, --prettyPrint pretty print, shorthand for '... style = ""' | ||
| --properties-array-brackets use [x] in array paths (e.g. for SpringBoot) | ||
| --properties-separator string separator to use between keys and values (default " = ") | ||
| -s, --split-exp string print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter. | ||
| --split-exp-file string Use a file to specify the split-exp expression. | ||
| --string-interpolation Toggles strings interpolation of \(exp) (default true) | ||
| --tsv-auto-parse parse TSV YAML/JSON values (default true) | ||
| -r, --unwrapScalar unwrap scalar, print the value with no quotes, colors or comments. Defaults to true for yaml (default true) | ||
| -v, --verbose verbose mode | ||
| --xml-attribute-prefix string prefix for xml attributes (default "+@") | ||
| --xml-content-name string name for xml content (if no attribute name is present). (default "+content") | ||
| --xml-directive-name string name for xml directives (e.g. <!DOCTYPE thing cat>) (default "+directive") | ||
| --xml-keep-namespace enables keeping namespace after parsing attributes (default true) | ||
| --xml-proc-inst-prefix string prefix for xml processing instructions (e.g. <?xml version="1"?>) (default "+p_") | ||
| --xml-raw-token enables using RawToken method instead Token. Commonly disables namespace translations. See https://pkg.go.dev/encoding/xml#Decoder.RawToken for details. (default true) | ||
| --xml-skip-directives skip over directives (e.g. <!DOCTYPE thing cat>) | ||
| --xml-skip-proc-inst skip over process instructions (e.g. <?xml version="1"?>) | ||
| --xml-strict-mode enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details. | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [zarf tools yq](/commands/zarf_tools_yq/) - yq is a lightweight and portable command-line data file processor. | ||
|
|