Add docs, improve README
All checks were successful
Build and Publish / release (push) Successful in 1m22s
All checks were successful
Build and Publish / release (push) Successful in 1m22s
This commit is contained in:
22
docs/eia-client.md
Normal file
22
docs/eia-client.md
Normal file
@ -0,0 +1,22 @@
|
||||
## eia-client
|
||||
|
||||
Useful utilities for EIA API v2
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--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
|
||||
-h, --help help for eia-client
|
||||
-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
|
||||
* [eia-client docs](eia-client_docs.md) - Generate documentation for eia-client
|
||||
* [eia-client get](eia-client_get.md) - Commands for getting metadata
|
||||
* [eia-client list](eia-client_list.md) - Commands for listing metadata
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
34
docs/eia-client_completion.md
Normal file
34
docs/eia-client_completion.md
Normal file
@ -0,0 +1,34 @@
|
||||
## eia-client completion
|
||||
|
||||
Generate the autocompletion script for the specified shell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for eia-client for the specified shell.
|
||||
See each sub-command's help for details on how to use the generated script.
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for completion
|
||||
```
|
||||
|
||||
### 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](eia-client.md) - Useful utilities for EIA API v2
|
||||
* [eia-client completion bash](eia-client_completion_bash.md) - Generate the autocompletion script for bash
|
||||
* [eia-client completion fish](eia-client_completion_fish.md) - Generate the autocompletion script for fish
|
||||
* [eia-client completion powershell](eia-client_completion_powershell.md) - Generate the autocompletion script for powershell
|
||||
* [eia-client completion zsh](eia-client_completion_zsh.md) - Generate the autocompletion script for zsh
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
53
docs/eia-client_completion_bash.md
Normal file
53
docs/eia-client_completion_bash.md
Normal file
@ -0,0 +1,53 @@
|
||||
## eia-client completion bash
|
||||
|
||||
Generate the autocompletion script for bash
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for the bash shell.
|
||||
|
||||
This script depends on the 'bash-completion' package.
|
||||
If it is not installed already, you can install it via your OS's package manager.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
source <(eia-client completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
eia-client completion bash > /etc/bash_completion.d/eia-client
|
||||
|
||||
#### macOS:
|
||||
|
||||
eia-client completion bash > $(brew --prefix)/etc/bash_completion.d/eia-client
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
eia-client completion bash
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
--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
|
||||
44
docs/eia-client_completion_fish.md
Normal file
44
docs/eia-client_completion_fish.md
Normal file
@ -0,0 +1,44 @@
|
||||
## eia-client completion fish
|
||||
|
||||
Generate the autocompletion script for fish
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for the fish shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
eia-client completion fish | source
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
eia-client completion fish > ~/.config/fish/completions/eia-client.fish
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
eia-client completion fish [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for fish
|
||||
--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
|
||||
41
docs/eia-client_completion_powershell.md
Normal file
41
docs/eia-client_completion_powershell.md
Normal file
@ -0,0 +1,41 @@
|
||||
## eia-client completion powershell
|
||||
|
||||
Generate the autocompletion script for powershell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for powershell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
eia-client completion powershell | Out-String | Invoke-Expression
|
||||
|
||||
To load completions for every new session, add the output of the above command
|
||||
to your powershell profile.
|
||||
|
||||
|
||||
```
|
||||
eia-client completion powershell [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for powershell
|
||||
--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
|
||||
55
docs/eia-client_completion_zsh.md
Normal file
55
docs/eia-client_completion_zsh.md
Normal file
@ -0,0 +1,55 @@
|
||||
## 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
|
||||
29
docs/eia-client_docs.md
Normal file
29
docs/eia-client_docs.md
Normal file
@ -0,0 +1,29 @@
|
||||
## eia-client docs
|
||||
|
||||
Generate documentation for eia-client
|
||||
|
||||
```
|
||||
eia-client docs [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for docs
|
||||
-o, --outdir string specify output directory for documentation (default "./docs")
|
||||
```
|
||||
|
||||
### 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](eia-client.md) - Useful utilities for EIA API v2
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
26
docs/eia-client_get.md
Normal file
26
docs/eia-client_get.md
Normal file
@ -0,0 +1,26 @@
|
||||
## eia-client get
|
||||
|
||||
Commands for getting metadata
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for get
|
||||
```
|
||||
|
||||
### 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](eia-client.md) - Useful utilities for EIA API v2
|
||||
* [eia-client get facet](eia-client_get_facet.md) - Describe facet for given API route
|
||||
* [eia-client get route](eia-client_get_route.md) - Describe a route
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
28
docs/eia-client_get_facet.md
Normal file
28
docs/eia-client_get_facet.md
Normal file
@ -0,0 +1,28 @@
|
||||
## eia-client get facet
|
||||
|
||||
Describe facet for given API route
|
||||
|
||||
```
|
||||
eia-client get facet route facet [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for facet
|
||||
```
|
||||
|
||||
### 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 get](eia-client_get.md) - Commands for getting metadata
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
28
docs/eia-client_get_route.md
Normal file
28
docs/eia-client_get_route.md
Normal file
@ -0,0 +1,28 @@
|
||||
## eia-client get route
|
||||
|
||||
Describe a route
|
||||
|
||||
```
|
||||
eia-client get route [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for route
|
||||
```
|
||||
|
||||
### 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 get](eia-client_get.md) - Commands for getting metadata
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
26
docs/eia-client_list.md
Normal file
26
docs/eia-client_list.md
Normal file
@ -0,0 +1,26 @@
|
||||
## eia-client list
|
||||
|
||||
Commands for listing metadata
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### 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](eia-client.md) - Useful utilities for EIA API v2
|
||||
* [eia-client list facets](eia-client_list_facets.md) - List facets for given API route
|
||||
* [eia-client list routes](eia-client_list_routes.md) - List routes, optionally by type (default is Data)
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
28
docs/eia-client_list_facets.md
Normal file
28
docs/eia-client_list_facets.md
Normal file
@ -0,0 +1,28 @@
|
||||
## eia-client list facets
|
||||
|
||||
List facets for given API route
|
||||
|
||||
```
|
||||
eia-client list facets route [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for facets
|
||||
```
|
||||
|
||||
### 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 list](eia-client_list.md) - Commands for listing metadata
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
31
docs/eia-client_list_routes.md
Normal file
31
docs/eia-client_list_routes.md
Normal file
@ -0,0 +1,31 @@
|
||||
## eia-client list routes
|
||||
|
||||
List routes, optionally by type (default is Data)
|
||||
|
||||
```
|
||||
eia-client list routes [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --all List all methods, no filtering
|
||||
-f, --filters strings Optional [inclusion] filters, case insensitive
|
||||
-h, --help help for routes
|
||||
-p, --routePrefix string Prefix for routes, ignore with -a flag (default "Get")
|
||||
```
|
||||
|
||||
### 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 list](eia-client_list.md) - Commands for listing metadata
|
||||
|
||||
###### Auto generated by spf13/cobra on 17-Dec-2024
|
||||
Reference in New Issue
Block a user