From e5ffeca203c4c6e37c6e7060e5d2293110834feb Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Thu, 2 Feb 2023 19:41:55 -0500 Subject: [PATCH] remove cli-usage --- docs/cli-usage/zrok.md | 31 ------------ docs/cli-usage/zrok_access.md | 24 --------- docs/cli-usage/zrok_access_private.md | 27 ---------- docs/cli-usage/zrok_access_public.md | 26 ---------- docs/cli-usage/zrok_admin.md | 29 ----------- docs/cli-usage/zrok_admin_bootstrap.md | 28 ----------- docs/cli-usage/zrok_admin_create.md | 24 --------- docs/cli-usage/zrok_admin_create_frontend.md | 26 ---------- docs/cli-usage/zrok_admin_create_identity.md | 26 ---------- docs/cli-usage/zrok_admin_delete.md | 23 --------- docs/cli-usage/zrok_admin_delete_frontend.md | 26 ---------- docs/cli-usage/zrok_admin_gc.md | 26 ---------- docs/cli-usage/zrok_admin_generate.md | 27 ---------- docs/cli-usage/zrok_admin_list.md | 23 --------- docs/cli-usage/zrok_admin_list_frontends.md | 26 ---------- docs/cli-usage/zrok_admin_update.md | 23 --------- docs/cli-usage/zrok_admin_update_frontend.md | 28 ----------- docs/cli-usage/zrok_completion.md | 32 ------------ docs/cli-usage/zrok_completion_bash.md | 51 ------------------- docs/cli-usage/zrok_completion_fish.md | 42 ---------------- docs/cli-usage/zrok_completion_powershell.md | 39 -------------- docs/cli-usage/zrok_completion_zsh.md | 53 -------------------- docs/cli-usage/zrok_config.md | 25 --------- docs/cli-usage/zrok_config_get.md | 26 ---------- docs/cli-usage/zrok_config_set.md | 26 ---------- docs/cli-usage/zrok_config_unset.md | 26 ---------- docs/cli-usage/zrok_controller.md | 26 ---------- docs/cli-usage/zrok_disable.md | 26 ---------- docs/cli-usage/zrok_enable.md | 27 ---------- docs/cli-usage/zrok_genmd.md | 26 ---------- docs/cli-usage/zrok_invite.md | 27 ---------- docs/cli-usage/zrok_release.md | 26 ---------- docs/cli-usage/zrok_reserve.md | 29 ----------- docs/cli-usage/zrok_share.md | 25 --------- docs/cli-usage/zrok_share_private.md | 30 ----------- docs/cli-usage/zrok_share_public.md | 31 ------------ docs/cli-usage/zrok_share_reserved.md | 29 ----------- docs/cli-usage/zrok_status.md | 26 ---------- docs/cli-usage/zrok_test.md | 24 --------- docs/cli-usage/zrok_test_endpoint.md | 28 ----------- docs/cli-usage/zrok_test_loop.md | 37 -------------- docs/cli-usage/zrok_version.md | 26 ---------- 42 files changed, 1206 deletions(-) delete mode 100644 docs/cli-usage/zrok.md delete mode 100644 docs/cli-usage/zrok_access.md delete mode 100644 docs/cli-usage/zrok_access_private.md delete mode 100644 docs/cli-usage/zrok_access_public.md delete mode 100644 docs/cli-usage/zrok_admin.md delete mode 100644 docs/cli-usage/zrok_admin_bootstrap.md delete mode 100644 docs/cli-usage/zrok_admin_create.md delete mode 100644 docs/cli-usage/zrok_admin_create_frontend.md delete mode 100644 docs/cli-usage/zrok_admin_create_identity.md delete mode 100644 docs/cli-usage/zrok_admin_delete.md delete mode 100644 docs/cli-usage/zrok_admin_delete_frontend.md delete mode 100644 docs/cli-usage/zrok_admin_gc.md delete mode 100644 docs/cli-usage/zrok_admin_generate.md delete mode 100644 docs/cli-usage/zrok_admin_list.md delete mode 100644 docs/cli-usage/zrok_admin_list_frontends.md delete mode 100644 docs/cli-usage/zrok_admin_update.md delete mode 100644 docs/cli-usage/zrok_admin_update_frontend.md delete mode 100644 docs/cli-usage/zrok_completion.md delete mode 100644 docs/cli-usage/zrok_completion_bash.md delete mode 100644 docs/cli-usage/zrok_completion_fish.md delete mode 100644 docs/cli-usage/zrok_completion_powershell.md delete mode 100644 docs/cli-usage/zrok_completion_zsh.md delete mode 100644 docs/cli-usage/zrok_config.md delete mode 100644 docs/cli-usage/zrok_config_get.md delete mode 100644 docs/cli-usage/zrok_config_set.md delete mode 100644 docs/cli-usage/zrok_config_unset.md delete mode 100644 docs/cli-usage/zrok_controller.md delete mode 100644 docs/cli-usage/zrok_disable.md delete mode 100644 docs/cli-usage/zrok_enable.md delete mode 100644 docs/cli-usage/zrok_genmd.md delete mode 100644 docs/cli-usage/zrok_invite.md delete mode 100644 docs/cli-usage/zrok_release.md delete mode 100644 docs/cli-usage/zrok_reserve.md delete mode 100644 docs/cli-usage/zrok_share.md delete mode 100644 docs/cli-usage/zrok_share_private.md delete mode 100644 docs/cli-usage/zrok_share_public.md delete mode 100644 docs/cli-usage/zrok_share_reserved.md delete mode 100644 docs/cli-usage/zrok_status.md delete mode 100644 docs/cli-usage/zrok_test.md delete mode 100644 docs/cli-usage/zrok_test_endpoint.md delete mode 100644 docs/cli-usage/zrok_test_loop.md delete mode 100644 docs/cli-usage/zrok_version.md diff --git a/docs/cli-usage/zrok.md b/docs/cli-usage/zrok.md deleted file mode 100644 index b88cfa68..00000000 --- a/docs/cli-usage/zrok.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_access.md b/docs/cli-usage/zrok_access.md deleted file mode 100644 index b416c86b..00000000 --- a/docs/cli-usage/zrok_access.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_access_private.md b/docs/cli-usage/zrok_access_private.md deleted file mode 100644 index c737128c..00000000 --- a/docs/cli-usage/zrok_access_private.md +++ /dev/null @@ -1,27 +0,0 @@ -## zrok access private - -Create a private frontend to access a share - -``` -zrok access private [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 diff --git a/docs/cli-usage/zrok_access_public.md b/docs/cli-usage/zrok_access_public.md deleted file mode 100644 index ad664c09..00000000 --- a/docs/cli-usage/zrok_access_public.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok access public - -Create a public access HTTP frontend - -``` -zrok access public [] [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 diff --git a/docs/cli-usage/zrok_admin.md b/docs/cli-usage/zrok_admin.md deleted file mode 100644 index 51afd92b..00000000 --- a/docs/cli-usage/zrok_admin.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_bootstrap.md b/docs/cli-usage/zrok_admin_bootstrap.md deleted file mode 100644 index b0f2d5c4..00000000 --- a/docs/cli-usage/zrok_admin_bootstrap.md +++ /dev/null @@ -1,28 +0,0 @@ -## zrok admin bootstrap - -Bootstrap the underlying Ziti network for zrok - -``` -zrok admin bootstrap [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 diff --git a/docs/cli-usage/zrok_admin_create.md b/docs/cli-usage/zrok_admin_create.md deleted file mode 100644 index ec82cf3d..00000000 --- a/docs/cli-usage/zrok_admin_create.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_create_frontend.md b/docs/cli-usage/zrok_admin_create_frontend.md deleted file mode 100644 index d9ff3d4b..00000000 --- a/docs/cli-usage/zrok_admin_create_frontend.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok admin create frontend - -Create a global public frontend - -``` -zrok admin create frontend [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 diff --git a/docs/cli-usage/zrok_admin_create_identity.md b/docs/cli-usage/zrok_admin_create_identity.md deleted file mode 100644 index 41a60c00..00000000 --- a/docs/cli-usage/zrok_admin_create_identity.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok admin create identity - -Create an identity and policies for a public frontend - -``` -zrok admin create identity [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 diff --git a/docs/cli-usage/zrok_admin_delete.md b/docs/cli-usage/zrok_admin_delete.md deleted file mode 100644 index e95933f3..00000000 --- a/docs/cli-usage/zrok_admin_delete.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_delete_frontend.md b/docs/cli-usage/zrok_admin_delete_frontend.md deleted file mode 100644 index c6df2f4e..00000000 --- a/docs/cli-usage/zrok_admin_delete_frontend.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok admin delete frontend - -Delete a global public frontend - -``` -zrok admin delete frontend [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 diff --git a/docs/cli-usage/zrok_admin_gc.md b/docs/cli-usage/zrok_admin_gc.md deleted file mode 100644 index 87124554..00000000 --- a/docs/cli-usage/zrok_admin_gc.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok admin gc - -Garbage collect a zrok instance - -``` -zrok admin gc [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 diff --git a/docs/cli-usage/zrok_admin_generate.md b/docs/cli-usage/zrok_admin_generate.md deleted file mode 100644 index 978ada09..00000000 --- a/docs/cli-usage/zrok_admin_generate.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_list.md b/docs/cli-usage/zrok_admin_list.md deleted file mode 100644 index 3d704ccf..00000000 --- a/docs/cli-usage/zrok_admin_list.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_list_frontends.md b/docs/cli-usage/zrok_admin_list_frontends.md deleted file mode 100644 index 776178a0..00000000 --- a/docs/cli-usage/zrok_admin_list_frontends.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_update.md b/docs/cli-usage/zrok_admin_update.md deleted file mode 100644 index c3582ade..00000000 --- a/docs/cli-usage/zrok_admin_update.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_admin_update_frontend.md b/docs/cli-usage/zrok_admin_update_frontend.md deleted file mode 100644 index 48b6fc27..00000000 --- a/docs/cli-usage/zrok_admin_update_frontend.md +++ /dev/null @@ -1,28 +0,0 @@ -## zrok admin update frontend - -Update a global public frontend - -``` -zrok admin update frontend [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 diff --git a/docs/cli-usage/zrok_completion.md b/docs/cli-usage/zrok_completion.md deleted file mode 100644 index 5a96796a..00000000 --- a/docs/cli-usage/zrok_completion.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_completion_bash.md b/docs/cli-usage/zrok_completion_bash.md deleted file mode 100644 index 34fcf246..00000000 --- a/docs/cli-usage/zrok_completion_bash.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_completion_fish.md b/docs/cli-usage/zrok_completion_fish.md deleted file mode 100644 index f7c3865e..00000000 --- a/docs/cli-usage/zrok_completion_fish.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_completion_powershell.md b/docs/cli-usage/zrok_completion_powershell.md deleted file mode 100644 index 4646cbc2..00000000 --- a/docs/cli-usage/zrok_completion_powershell.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_completion_zsh.md b/docs/cli-usage/zrok_completion_zsh.md deleted file mode 100644 index 2ee2492c..00000000 --- a/docs/cli-usage/zrok_completion_zsh.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_config.md b/docs/cli-usage/zrok_config.md deleted file mode 100644 index 62a7f8d2..00000000 --- a/docs/cli-usage/zrok_config.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_config_get.md b/docs/cli-usage/zrok_config_get.md deleted file mode 100644 index 84d6bf95..00000000 --- a/docs/cli-usage/zrok_config_get.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok config get - -Get a value from the environment config - -``` -zrok config get [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 diff --git a/docs/cli-usage/zrok_config_set.md b/docs/cli-usage/zrok_config_set.md deleted file mode 100644 index ba6682e4..00000000 --- a/docs/cli-usage/zrok_config_set.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok config set - -Set a value into the environment config - -``` -zrok config set [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 diff --git a/docs/cli-usage/zrok_config_unset.md b/docs/cli-usage/zrok_config_unset.md deleted file mode 100644 index 566c127a..00000000 --- a/docs/cli-usage/zrok_config_unset.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok config unset - -Unset a value from the environment config - -``` -zrok config unset [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 diff --git a/docs/cli-usage/zrok_controller.md b/docs/cli-usage/zrok_controller.md deleted file mode 100644 index d834c7f9..00000000 --- a/docs/cli-usage/zrok_controller.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok controller - -Start a zrok controller - -``` -zrok controller [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 diff --git a/docs/cli-usage/zrok_disable.md b/docs/cli-usage/zrok_disable.md deleted file mode 100644 index cd2e40ba..00000000 --- a/docs/cli-usage/zrok_disable.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_enable.md b/docs/cli-usage/zrok_enable.md deleted file mode 100644 index 5bd05e30..00000000 --- a/docs/cli-usage/zrok_enable.md +++ /dev/null @@ -1,27 +0,0 @@ -## zrok enable - -Enable an environment for zrok - -``` -zrok enable [flags] -``` - -### Options - -``` - -d, --description string Description of this environment (default "@") - -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 diff --git a/docs/cli-usage/zrok_genmd.md b/docs/cli-usage/zrok_genmd.md deleted file mode 100644 index 589df0b2..00000000 --- a/docs/cli-usage/zrok_genmd.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_invite.md b/docs/cli-usage/zrok_invite.md deleted file mode 100644 index 74670702..00000000 --- a/docs/cli-usage/zrok_invite.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_release.md b/docs/cli-usage/zrok_release.md deleted file mode 100644 index 74674500..00000000 --- a/docs/cli-usage/zrok_release.md +++ /dev/null @@ -1,26 +0,0 @@ -## zrok release - -Release a reserved share - -``` -zrok release [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 diff --git a/docs/cli-usage/zrok_reserve.md b/docs/cli-usage/zrok_reserve.md deleted file mode 100644 index 3eb4d87e..00000000 --- a/docs/cli-usage/zrok_reserve.md +++ /dev/null @@ -1,29 +0,0 @@ -## zrok reserve - -Create a reserved share - -``` -zrok reserve [flags] -``` - -### Options - -``` - --backend-mode string The backend mode {proxy, web} (default "proxy") - --basic-auth stringArray Basic authentication users (,...) - --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 diff --git a/docs/cli-usage/zrok_share.md b/docs/cli-usage/zrok_share.md deleted file mode 100644 index 1e086506..00000000 --- a/docs/cli-usage/zrok_share.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_share_private.md b/docs/cli-usage/zrok_share_private.md deleted file mode 100644 index 36172c0f..00000000 --- a/docs/cli-usage/zrok_share_private.md +++ /dev/null @@ -1,30 +0,0 @@ -## zrok share private - -Share a target resource privately - -``` -zrok share private [flags] -``` - -### Options - -``` - --backend-mode string The backend mode {proxy, web} (default "proxy") - --basic-auth stringArray Basic authentication users (,... - --headless Disable TUI and run headless - -h, --help help for private - --insecure Enable insecure TLS certificate validation for -``` - -### 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 diff --git a/docs/cli-usage/zrok_share_public.md b/docs/cli-usage/zrok_share_public.md deleted file mode 100644 index dc598321..00000000 --- a/docs/cli-usage/zrok_share_public.md +++ /dev/null @@ -1,31 +0,0 @@ -## zrok share public - -Share a target resource publicly - -``` -zrok share public [flags] -``` - -### Options - -``` - --backend-mode string The backend mode {proxy, web} (default "proxy") - --basic-auth stringArray Basic authentication users (,...) - --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 -``` - -### 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 diff --git a/docs/cli-usage/zrok_share_reserved.md b/docs/cli-usage/zrok_share_reserved.md deleted file mode 100644 index 2ae5b878..00000000 --- a/docs/cli-usage/zrok_share_reserved.md +++ /dev/null @@ -1,29 +0,0 @@ -## zrok share reserved - -Start a backend for a reserved share - -``` -zrok share reserved [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 diff --git a/docs/cli-usage/zrok_status.md b/docs/cli-usage/zrok_status.md deleted file mode 100644 index 63445939..00000000 --- a/docs/cli-usage/zrok_status.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_test.md b/docs/cli-usage/zrok_test.md deleted file mode 100644 index 08b15995..00000000 --- a/docs/cli-usage/zrok_test.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_test_endpoint.md b/docs/cli-usage/zrok_test_endpoint.md deleted file mode 100644 index 09ee499f..00000000 --- a/docs/cli-usage/zrok_test_endpoint.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_test_loop.md b/docs/cli-usage/zrok_test_loop.md deleted file mode 100644 index b2883f55..00000000 --- a/docs/cli-usage/zrok_test_loop.md +++ /dev/null @@ -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 diff --git a/docs/cli-usage/zrok_version.md b/docs/cli-usage/zrok_version.md deleted file mode 100644 index 7231b7ab..00000000 --- a/docs/cli-usage/zrok_version.md +++ /dev/null @@ -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