mirror of
https://github.com/openziti/zrok.git
synced 2024-12-23 07:09:12 +01:00
remove cli-usage
This commit is contained in:
dovholuknf
parent
50b592b4c3
commit
e5ffeca203
@ -1,31 +0,0 @@
|
|||||||
## zrok
|
|
||||||
|
|
||||||
zrok
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for zrok
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok access](zrok_access.md) - Create frontend access for shares
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
|
||||||
* [zrok config](zrok_config.md) - Configure your zrok environment
|
|
||||||
* [zrok controller](zrok_controller.md) - Start a zrok controller
|
|
||||||
* [zrok disable](zrok_disable.md) - Disable (and clean up) the enabled zrok environment
|
|
||||||
* [zrok enable](zrok_enable.md) - Enable an environment for zrok
|
|
||||||
* [zrok genmd](zrok_genmd.md) - generates markdown from the cobra code
|
|
||||||
* [zrok invite](zrok_invite.md) - Invite a new user to zrok
|
|
||||||
* [zrok release](zrok_release.md) - Release a reserved share
|
|
||||||
* [zrok reserve](zrok_reserve.md) - Create a reserved share
|
|
||||||
* [zrok share](zrok_share.md) - Create backend access for shares
|
|
||||||
* [zrok status](zrok_status.md) - Show the current environment status
|
|
||||||
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
|
||||||
* [zrok version](zrok_version.md) -
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
## zrok access
|
|
||||||
|
|
||||||
Create frontend access for shares
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for access
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok access private](zrok_access_private.md) - Create a private frontend to access a share
|
|
||||||
* [zrok access public](zrok_access_public.md) - Create a public access HTTP frontend
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
## zrok access private
|
|
||||||
|
|
||||||
Create a private frontend to access a share
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok access private <shareToken> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-b, --bind string The address to bind the private frontend (default "127.0.0.1:9191")
|
|
||||||
-h, --help help for private
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok access](zrok_access.md) - Create frontend access for shares
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok access public
|
|
||||||
|
|
||||||
Create a public access HTTP frontend
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok access public [<configPath>] [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for public
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok access](zrok_access.md) - Create frontend access for shares
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
## zrok admin
|
|
||||||
|
|
||||||
Administration and operations functions
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for admin
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok admin bootstrap](zrok_admin_bootstrap.md) - Bootstrap the underlying Ziti network for zrok
|
|
||||||
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
|
||||||
* [zrok admin delete](zrok_admin_delete.md) - Delete global resources
|
|
||||||
* [zrok admin gc](zrok_admin_gc.md) - Garbage collect a zrok instance
|
|
||||||
* [zrok admin generate](zrok_admin_generate.md) - Generate invite tokens
|
|
||||||
* [zrok admin list](zrok_admin_list.md) - List global resources
|
|
||||||
* [zrok admin update](zrok_admin_update.md) - Update global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
## zrok admin bootstrap
|
|
||||||
|
|
||||||
Bootstrap the underlying Ziti network for zrok
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin bootstrap <configPath> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for bootstrap
|
|
||||||
--skip-ctrl Skip controller (ctrl) identity bootstrapping
|
|
||||||
--skip-frontend Slip frontend identity bootstrapping
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
## zrok admin create
|
|
||||||
|
|
||||||
Create global resources
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for create
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
* [zrok admin create frontend](zrok_admin_create_frontend.md) - Create a global public frontend
|
|
||||||
* [zrok admin create identity](zrok_admin_create_identity.md) - Create an identity and policies for a public frontend
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok admin create frontend
|
|
||||||
|
|
||||||
Create a global public frontend
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin create frontend <zitiId> <publicName> <urlTemplate> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for frontend
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok admin create identity
|
|
||||||
|
|
||||||
Create an identity and policies for a public frontend
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin create identity <name> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for identity
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
## zrok admin delete
|
|
||||||
|
|
||||||
Delete global resources
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for delete
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
* [zrok admin delete frontend](zrok_admin_delete_frontend.md) - Delete a global public frontend
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok admin delete frontend
|
|
||||||
|
|
||||||
Delete a global public frontend
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin delete frontend <frontendToken> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for frontend
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin delete](zrok_admin_delete.md) - Delete global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok admin gc
|
|
||||||
|
|
||||||
Garbage collect a zrok instance
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin gc <configPath> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for gc
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
## zrok admin generate
|
|
||||||
|
|
||||||
Generate invite tokens
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin generate [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-n, --count int Number of tokens to generate (default 5)
|
|
||||||
-h, --help help for generate
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
## zrok admin list
|
|
||||||
|
|
||||||
List global resources
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for list
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
* [zrok admin list frontends](zrok_admin_list_frontends.md) - List global public frontends
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok admin list frontends
|
|
||||||
|
|
||||||
List global public frontends
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin list frontends [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for frontends
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin list](zrok_admin_list.md) - List global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
## zrok admin update
|
|
||||||
|
|
||||||
Update global resources
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for update
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
|
||||||
* [zrok admin update frontend](zrok_admin_update_frontend.md) - Update a global public frontend
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
## zrok admin update frontend
|
|
||||||
|
|
||||||
Update a global public frontend
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok admin update frontend <frontendToken> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for frontend
|
|
||||||
--public-name string Specify a new value for the public name
|
|
||||||
--url-template string Specify a new value for the url template
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok admin update](zrok_admin_update.md) - Update global resources
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
## zrok completion
|
|
||||||
|
|
||||||
Generate the autocompletion script for the specified shell
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Generate the autocompletion script for zrok 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
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok completion bash](zrok_completion_bash.md) - Generate the autocompletion script for bash
|
|
||||||
* [zrok completion fish](zrok_completion_fish.md) - Generate the autocompletion script for fish
|
|
||||||
* [zrok completion powershell](zrok_completion_powershell.md) - Generate the autocompletion script for powershell
|
|
||||||
* [zrok completion zsh](zrok_completion_zsh.md) - Generate the autocompletion script for zsh
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,51 +0,0 @@
|
|||||||
## zrok 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 <(zrok completion bash)
|
|
||||||
|
|
||||||
To load completions for every new session, execute once:
|
|
||||||
|
|
||||||
#### Linux:
|
|
||||||
|
|
||||||
zrok completion bash > /etc/bash_completion.d/zrok
|
|
||||||
|
|
||||||
#### macOS:
|
|
||||||
|
|
||||||
zrok completion bash > $(brew --prefix)/etc/bash_completion.d/zrok
|
|
||||||
|
|
||||||
You will need to start a new shell for this setup to take effect.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok completion bash
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for bash
|
|
||||||
--no-descriptions disable completion descriptions
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
## zrok 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:
|
|
||||||
|
|
||||||
zrok completion fish | source
|
|
||||||
|
|
||||||
To load completions for every new session, execute once:
|
|
||||||
|
|
||||||
zrok completion fish > ~/.config/fish/completions/zrok.fish
|
|
||||||
|
|
||||||
You will need to start a new shell for this setup to take effect.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok completion fish [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for fish
|
|
||||||
--no-descriptions disable completion descriptions
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
## zrok completion powershell
|
|
||||||
|
|
||||||
Generate the autocompletion script for powershell
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Generate the autocompletion script for powershell.
|
|
||||||
|
|
||||||
To load completions in your current shell session:
|
|
||||||
|
|
||||||
zrok completion powershell | Out-String | Invoke-Expression
|
|
||||||
|
|
||||||
To load completions for every new session, add the output of the above command
|
|
||||||
to your powershell profile.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok completion powershell [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for powershell
|
|
||||||
--no-descriptions disable completion descriptions
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,53 +0,0 @@
|
|||||||
## zrok 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 <(zrok completion zsh); compdef _zrok zrok
|
|
||||||
|
|
||||||
To load completions for every new session, execute once:
|
|
||||||
|
|
||||||
#### Linux:
|
|
||||||
|
|
||||||
zrok completion zsh > "${fpath[1]}/_zrok"
|
|
||||||
|
|
||||||
#### macOS:
|
|
||||||
|
|
||||||
zrok completion zsh > $(brew --prefix)/share/zsh/site-functions/_zrok
|
|
||||||
|
|
||||||
You will need to start a new shell for this setup to take effect.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok completion zsh [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for zsh
|
|
||||||
--no-descriptions disable completion descriptions
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
## zrok config
|
|
||||||
|
|
||||||
Configure your zrok environment
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok config get](zrok_config_get.md) - Get a value from the environment config
|
|
||||||
* [zrok config set](zrok_config_set.md) - Set a value into the environment config
|
|
||||||
* [zrok config unset](zrok_config_unset.md) - Unset a value from the environment config
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok config get
|
|
||||||
|
|
||||||
Get a value from the environment config
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok config get <configName> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for get
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok config](zrok_config.md) - Configure your zrok environment
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok config set
|
|
||||||
|
|
||||||
Set a value into the environment config
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok config set <configName> <value> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for set
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok config](zrok_config.md) - Configure your zrok environment
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok config unset
|
|
||||||
|
|
||||||
Unset a value from the environment config
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok config unset <configName> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for unset
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok config](zrok_config.md) - Configure your zrok environment
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok controller
|
|
||||||
|
|
||||||
Start a zrok controller
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok controller <configPath> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for controller
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok disable
|
|
||||||
|
|
||||||
Disable (and clean up) the enabled zrok environment
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok disable [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for disable
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
## zrok enable
|
|
||||||
|
|
||||||
Enable an environment for zrok
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok enable <token> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-d, --description string Description of this environment (default "<user>@<hostname>")
|
|
||||||
-h, --help help for enable
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok genmd
|
|
||||||
|
|
||||||
generates markdown from the cobra code
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok genmd [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for genmd
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
## zrok invite
|
|
||||||
|
|
||||||
Invite a new user to zrok
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok invite [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for invite
|
|
||||||
--token string Invite token required when zrok running in token store mode
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok release
|
|
||||||
|
|
||||||
Release a reserved share
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok release <shareToken> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for release
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
## zrok reserve
|
|
||||||
|
|
||||||
Create a reserved share
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok reserve <public|private> <target> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
|
||||||
--basic-auth stringArray Basic authentication users (<username:password>,...)
|
|
||||||
--frontends stringArray Selected frontends to use for the share (default [public])
|
|
||||||
-h, --help help for reserve
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
## zrok share
|
|
||||||
|
|
||||||
Create backend access for shares
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for share
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok share private](zrok_share_private.md) - Share a target resource privately
|
|
||||||
* [zrok share public](zrok_share_public.md) - Share a target resource publicly
|
|
||||||
* [zrok share reserved](zrok_share_reserved.md) - Start a backend for a reserved share
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,30 +0,0 @@
|
|||||||
## zrok share private
|
|
||||||
|
|
||||||
Share a target resource privately
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok share private <target> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
|
||||||
--basic-auth stringArray Basic authentication users (<username:password>,...
|
|
||||||
--headless Disable TUI and run headless
|
|
||||||
-h, --help help for private
|
|
||||||
--insecure Enable insecure TLS certificate validation for <target>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok share](zrok_share.md) - Create backend access for shares
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
## zrok share public
|
|
||||||
|
|
||||||
Share a target resource publicly
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok share public <target> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
|
||||||
--basic-auth stringArray Basic authentication users (<username:password>,...)
|
|
||||||
--frontends stringArray Selected frontends to use for the share (default [public])
|
|
||||||
--headless Disable TUI and run headless
|
|
||||||
-h, --help help for public
|
|
||||||
--insecure Enable insecure TLS certificate validation for <target>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok share](zrok_share.md) - Create backend access for shares
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
## zrok share reserved
|
|
||||||
|
|
||||||
Start a backend for a reserved share
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok share reserved <shareToken> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--headless Disable TUI and run headless
|
|
||||||
-h, --help help for reserved
|
|
||||||
--insecure Enable insecure TLS certificate validation
|
|
||||||
--override-endpoint string Override the stored target endpoint with a replacement
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok share](zrok_share.md) - Create backend access for shares
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok status
|
|
||||||
|
|
||||||
Show the current environment status
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok status [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for status
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
## zrok test
|
|
||||||
|
|
||||||
Utilities for testing zrok deployments
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for test
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
* [zrok test endpoint](zrok_test_endpoint.md) - Start a simple HTTP endpoint
|
|
||||||
* [zrok test loop](zrok_test_loop.md) - Start a loop agent
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
## zrok test endpoint
|
|
||||||
|
|
||||||
Start a simple HTTP endpoint
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok test endpoint [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-a, --address string The address for the HTTP listener (default "127.0.0.1")
|
|
||||||
-h, --help help for endpoint
|
|
||||||
-P, --port uint16 The port for the HTTP listener (default 9090)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
## zrok test loop
|
|
||||||
|
|
||||||
Start a loop agent
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok test loop [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--frontends stringArray Selected frontends to use for the share (default [public])
|
|
||||||
-h, --help help for loop
|
|
||||||
-i, --iterations int Number of iterations per looper (default 1)
|
|
||||||
-l, --loopers int Number of current loopers to start (default 1)
|
|
||||||
--max-dwell-ms int Maximum dwell time in milliseconds (default 1000)
|
|
||||||
--max-pacing-ms int Maximum pacing in milliseconds
|
|
||||||
--max-payload int Maximum payload size in bytes (default 10240)
|
|
||||||
--min-dwell-ms int Minimum dwell time in milliseconds (default 1000)
|
|
||||||
--min-pacing-ms int Minimum pacing in milliseconds
|
|
||||||
--min-payload int Minimum payload size in bytes (default 64)
|
|
||||||
-E, --status-every int Show status every # iterations (default 100)
|
|
||||||
-T, --timeout-seconds int Time out after # seconds when sending http requests (default 30)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## zrok version
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
zrok version [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for version
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
-p, --panic Panic instead of showing pretty errors
|
|
||||||
-v, --verbose Enable verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [zrok](zrok.md) - zrok
|
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 1-Feb-2023
|
|
||||||
Loading…
Reference in New Issue
Block a user