eia-api-go/docs/eia-client_completion_zsh.md
Ryan McGuire 373581c58a
All checks were successful
Build and Publish / release (push) Successful in 1m22s
Add docs, improve README
2024-12-17 17:24:48 -05:00

56 lines
1.4 KiB
Markdown

## eia-client 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 <(eia-client completion zsh)
To load completions for every new session, execute once:
#### Linux:
eia-client completion zsh > "${fpath[1]}/_eia-client"
#### macOS:
eia-client completion zsh > $(brew --prefix)/share/zsh/site-functions/_eia-client
You will need to start a new shell for this setup to take effect.
```
eia-client completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--apiKey string API Key, or set EIA_API_KEY in environment
-L, --apiLogLevel string Log Level for EIA API Middleware, or set EIA_API_LOG_LEVEL in environment
-l, --logLevel string Log Level, or set LOG_LEVEL in environment
-t, --timeout duration Request timeout, or set EIA_API_TMOUT in environment (default 15s)
```
### SEE ALSO
* [eia-client completion](eia-client_completion.md) - Generate the autocompletion script for the specified shell
###### Auto generated by spf13/cobra on 17-Dec-2024