From 8ba7107205a159867ddfda9731efcd60592ba950 Mon Sep 17 00:00:00 2001 From: Jakub Coufal Date: Mon, 6 Nov 2023 14:18:32 +0100 Subject: [PATCH] Update docs --- docs/scccmd.md | 3 +- docs/scccmd_completion.md | 30 ++++++++++++++++ docs/scccmd_completion_bash.md | 49 ++++++++++++++++++++++++++ docs/scccmd_completion_fish.md | 40 ++++++++++++++++++++++ docs/scccmd_completion_powershell.md | 37 ++++++++++++++++++++ docs/scccmd_completion_zsh.md | 51 ++++++++++++++++++++++++++++ docs/scccmd_decrypt.md | 6 +--- docs/scccmd_diff.md | 6 +--- docs/scccmd_diff_files.md | 6 +--- docs/scccmd_diff_values.md | 6 +--- docs/scccmd_encrypt.md | 6 +--- docs/scccmd_gendoc.md | 6 +--- docs/scccmd_get.md | 6 +--- docs/scccmd_get_files.md | 6 +--- docs/scccmd_get_values.md | 6 +--- docs/scccmd_version.md | 6 +--- docs/scccmd_webhook.md | 14 +++----- 17 files changed, 224 insertions(+), 60 deletions(-) create mode 100644 docs/scccmd_completion.md create mode 100644 docs/scccmd_completion_bash.md create mode 100644 docs/scccmd_completion_fish.md create mode 100644 docs/scccmd_completion_powershell.md create mode 100644 docs/scccmd_completion_zsh.md diff --git a/docs/scccmd.md b/docs/scccmd.md index e97d313..c3d5b27 100644 --- a/docs/scccmd.md +++ b/docs/scccmd.md @@ -11,11 +11,12 @@ Tool currently provides functionality to get (download) config file from server. ``` -h, --help help for scccmd - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO +* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell * [scccmd decrypt](scccmd_decrypt.md) - Decrypt the value server-side and prints the response * [scccmd diff](scccmd_diff.md) - Diff the config from the given config server * [scccmd encrypt](scccmd_encrypt.md) - Encrypt the value server-side and prints the response diff --git a/docs/scccmd_completion.md b/docs/scccmd_completion.md new file mode 100644 index 0000000..b2973c7 --- /dev/null +++ b/docs/scccmd_completion.md @@ -0,0 +1,30 @@ +## scccmd completion + +Generate the autocompletion script for the specified shell + +### Synopsis + +Generate the autocompletion script for scccmd 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 + +``` + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") +``` + +### SEE ALSO + +* [scccmd](scccmd.md) - Spring Cloud Config management tool +* [scccmd completion bash](scccmd_completion_bash.md) - Generate the autocompletion script for bash +* [scccmd completion fish](scccmd_completion_fish.md) - Generate the autocompletion script for fish +* [scccmd completion powershell](scccmd_completion_powershell.md) - Generate the autocompletion script for powershell +* [scccmd completion zsh](scccmd_completion_zsh.md) - Generate the autocompletion script for zsh + diff --git a/docs/scccmd_completion_bash.md b/docs/scccmd_completion_bash.md new file mode 100644 index 0000000..e54cf21 --- /dev/null +++ b/docs/scccmd_completion_bash.md @@ -0,0 +1,49 @@ +## scccmd 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 <(scccmd completion bash) + +To load completions for every new session, execute once: + +#### Linux: + + scccmd completion bash > /etc/bash_completion.d/scccmd + +#### macOS: + + scccmd completion bash > $(brew --prefix)/etc/bash_completion.d/scccmd + +You will need to start a new shell for this setup to take effect. + + +``` +scccmd completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") +``` + +### SEE ALSO + +* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell + diff --git a/docs/scccmd_completion_fish.md b/docs/scccmd_completion_fish.md new file mode 100644 index 0000000..a6be2f3 --- /dev/null +++ b/docs/scccmd_completion_fish.md @@ -0,0 +1,40 @@ +## scccmd 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: + + scccmd completion fish | source + +To load completions for every new session, execute once: + + scccmd completion fish > ~/.config/fish/completions/scccmd.fish + +You will need to start a new shell for this setup to take effect. + + +``` +scccmd completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") +``` + +### SEE ALSO + +* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell + diff --git a/docs/scccmd_completion_powershell.md b/docs/scccmd_completion_powershell.md new file mode 100644 index 0000000..f6bdfc1 --- /dev/null +++ b/docs/scccmd_completion_powershell.md @@ -0,0 +1,37 @@ +## scccmd completion powershell + +Generate the autocompletion script for powershell + +### Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + scccmd completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +scccmd completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") +``` + +### SEE ALSO + +* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell + diff --git a/docs/scccmd_completion_zsh.md b/docs/scccmd_completion_zsh.md new file mode 100644 index 0000000..1704bda --- /dev/null +++ b/docs/scccmd_completion_zsh.md @@ -0,0 +1,51 @@ +## scccmd 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 <(scccmd completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + scccmd completion zsh > "${fpath[1]}/_scccmd" + +#### macOS: + + scccmd completion zsh > $(brew --prefix)/share/zsh/site-functions/_scccmd + +You will need to start a new shell for this setup to take effect. + + +``` +scccmd completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") +``` + +### SEE ALSO + +* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell + diff --git a/docs/scccmd_decrypt.md b/docs/scccmd_decrypt.md index e0b7f6e..85f830d 100644 --- a/docs/scccmd_decrypt.md +++ b/docs/scccmd_decrypt.md @@ -2,10 +2,6 @@ Decrypt the value server-side and prints the response -### Synopsis - -Decrypt the value server-side and prints the response - ``` scccmd decrypt [flags] ``` @@ -21,7 +17,7 @@ scccmd decrypt [flags] ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_diff.md b/docs/scccmd_diff.md index de2f088..01c8f45 100644 --- a/docs/scccmd_diff.md +++ b/docs/scccmd_diff.md @@ -2,10 +2,6 @@ Diff the config from the given config server -### Synopsis - -Diff the config from the given config server - ### Options ``` @@ -21,7 +17,7 @@ Diff the config from the given config server ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_diff_files.md b/docs/scccmd_diff_files.md index 4f1572e..245d78e 100644 --- a/docs/scccmd_diff_files.md +++ b/docs/scccmd_diff_files.md @@ -2,10 +2,6 @@ Diff the config files from the given config server -### Synopsis - -Diff the config files from the given config server - ``` scccmd diff files [flags] ``` @@ -22,7 +18,7 @@ scccmd diff files [flags] ``` -a, --application string name of the application to get the config for --label string configuration label (default "master") - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") --profile string configuration profile (default "default") -s, --source string address of the config server --target-label string second label to diff with diff --git a/docs/scccmd_diff_values.md b/docs/scccmd_diff_values.md index e6030d2..475f51f 100644 --- a/docs/scccmd_diff_values.md +++ b/docs/scccmd_diff_values.md @@ -2,10 +2,6 @@ Diff the config values in specified format from the given config server -### Synopsis - -Diff the config values in specified format from the given config server - ``` scccmd diff values [flags] ``` @@ -22,7 +18,7 @@ scccmd diff values [flags] ``` -a, --application string name of the application to get the config for --label string configuration label (default "master") - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") --profile string configuration profile (default "default") -s, --source string address of the config server --target-label string second label to diff with diff --git a/docs/scccmd_encrypt.md b/docs/scccmd_encrypt.md index 54d0ca8..3528195 100644 --- a/docs/scccmd_encrypt.md +++ b/docs/scccmd_encrypt.md @@ -2,10 +2,6 @@ Encrypt the value server-side and prints the response -### Synopsis - -Encrypt the value server-side and prints the response - ``` scccmd encrypt [flags] ``` @@ -21,7 +17,7 @@ scccmd encrypt [flags] ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_gendoc.md b/docs/scccmd_gendoc.md index adf87de..2b52cb3 100644 --- a/docs/scccmd_gendoc.md +++ b/docs/scccmd_gendoc.md @@ -2,10 +2,6 @@ Generates documentation for this tool in Markdown format -### Synopsis - -Generates documentation for this tool in Markdown format - ``` scccmd gendoc [flags] ``` @@ -20,7 +16,7 @@ scccmd gendoc [flags] ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_get.md b/docs/scccmd_get.md index caae088..962d34b 100644 --- a/docs/scccmd_get.md +++ b/docs/scccmd_get.md @@ -2,10 +2,6 @@ Get the config from the given config server -### Synopsis - -Get the config from the given config server - ### Options ``` @@ -19,7 +15,7 @@ Get the config from the given config server ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_get_files.md b/docs/scccmd_get_files.md index 0d4ece7..9174706 100644 --- a/docs/scccmd_get_files.md +++ b/docs/scccmd_get_files.md @@ -2,10 +2,6 @@ Get the config files from the given config server -### Synopsis - -Get the config files from the given config server - ``` scccmd get files [flags] ``` @@ -22,7 +18,7 @@ scccmd get files [flags] ``` -a, --application string name of the application to get the config for -l, --label string configuration label (default "master") - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") -p, --profile string configuration profile (default "default") -s, --source string address of the config server ``` diff --git a/docs/scccmd_get_values.md b/docs/scccmd_get_values.md index 62894e9..9b7d5da 100644 --- a/docs/scccmd_get_values.md +++ b/docs/scccmd_get_values.md @@ -2,10 +2,6 @@ Get the config values in specified format from the given config server -### Synopsis - -Get the config values in specified format from the given config server - ``` scccmd get values [flags] ``` @@ -23,7 +19,7 @@ scccmd get values [flags] ``` -a, --application string name of the application to get the config for -l, --label string configuration label (default "master") - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") -p, --profile string configuration profile (default "default") -s, --source string address of the config server ``` diff --git a/docs/scccmd_version.md b/docs/scccmd_version.md index 94b2970..495a29f 100644 --- a/docs/scccmd_version.md +++ b/docs/scccmd_version.md @@ -2,10 +2,6 @@ Print the version information -### Synopsis - -Print the version information - ``` scccmd version [flags] ``` @@ -19,7 +15,7 @@ scccmd version [flags] ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO diff --git a/docs/scccmd_webhook.md b/docs/scccmd_webhook.md index 6cd0ab1..44847a3 100644 --- a/docs/scccmd_webhook.md +++ b/docs/scccmd_webhook.md @@ -2,10 +2,6 @@ Runs K8s webhook for injecting config from Cloud Config Server -### Synopsis - -Runs K8s webhook for injecting config from Cloud Config Server - ``` scccmd webhook [flags] ``` @@ -13,17 +9,17 @@ scccmd webhook [flags] ### Options ``` - -c, --cert-file string Location of public part of SSL certificate (default "keys/publickey.cer") - -f, --config-file string The configuration namespace (default "config/config.yaml") + -c, --cert-file string location of public part of SSL certificate (default "keys/publickey.cer") + -f, --config-file string the configuration file (default "config/config.yaml") -h, --help help for webhook - -k, --key-file string Location of private key of SSL certificate (default "keys/private.key") - -p, --port int Webhook port (default 443) + -k, --key-file string location of private key of SSL certificate (default "keys/private.key") + -p, --port int webhook port (default 443) ``` ### Options inherited from parent commands ``` - --log-level string command log level (options: [panic fatal error warning info debug]) (default "info") + --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info") ``` ### SEE ALSO