diff --git a/docs/traefik-certs-dumper.md b/docs/traefik-certs-dumper.md index 3e57fbf..0e8db57 100644 --- a/docs/traefik-certs-dumper.md +++ b/docs/traefik-certs-dumper.md @@ -24,8 +24,9 @@ Dump Let's Encrypt certificates from Traefik. ### SEE ALSO +* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell * [traefik-certs-dumper file](traefik-certs-dumper_file.md) - Dump the content of the "acme.json" file. * [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store. * [traefik-certs-dumper version](traefik-certs-dumper_version.md) - Display version -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_completion.md b/docs/traefik-certs-dumper_completion.md new file mode 100644 index 0000000..8c2d64f --- /dev/null +++ b/docs/traefik-certs-dumper_completion.md @@ -0,0 +1,40 @@ +## traefik-certs-dumper completion + +Generate the autocompletion script for the specified shell + +### Synopsis + +Generate the autocompletion script for traefik-certs-dumper 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 + +``` + --clean Clean destination folder before dumping content. (default true) + --config string config file (default is $HOME/.traefik-certs-dumper.yaml) + --crt-ext string The file extension of the generated certificates. (default ".crt") + --crt-name string The file name (without extension) of the generated certificates. (default "certificate") + --dest string Path to store the dump content. (default "./dump") + --domain-subdir Use domain as sub-directory. + --key-ext string The file extension of the generated private keys. (default ".key") + --key-name string The file name (without extension) of the generated private keys. (default "privatekey") + --post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode) + --watch Enable watching changes. +``` + +### SEE ALSO + +* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik. +* [traefik-certs-dumper completion bash](traefik-certs-dumper_completion_bash.md) - Generate the autocompletion script for bash +* [traefik-certs-dumper completion fish](traefik-certs-dumper_completion_fish.md) - Generate the autocompletion script for fish +* [traefik-certs-dumper completion powershell](traefik-certs-dumper_completion_powershell.md) - Generate the autocompletion script for powershell +* [traefik-certs-dumper completion zsh](traefik-certs-dumper_completion_zsh.md) - Generate the autocompletion script for zsh + +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_completion_bash.md b/docs/traefik-certs-dumper_completion_bash.md new file mode 100644 index 0000000..47d2c5b --- /dev/null +++ b/docs/traefik-certs-dumper_completion_bash.md @@ -0,0 +1,59 @@ +## traefik-certs-dumper 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 <(traefik-certs-dumper completion bash) + +To load completions for every new session, execute once: + +#### Linux: + + traefik-certs-dumper completion bash > /etc/bash_completion.d/traefik-certs-dumper + +#### macOS: + + traefik-certs-dumper completion bash > $(brew --prefix)/etc/bash_completion.d/traefik-certs-dumper + +You will need to start a new shell for this setup to take effect. + + +``` +traefik-certs-dumper completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --clean Clean destination folder before dumping content. (default true) + --config string config file (default is $HOME/.traefik-certs-dumper.yaml) + --crt-ext string The file extension of the generated certificates. (default ".crt") + --crt-name string The file name (without extension) of the generated certificates. (default "certificate") + --dest string Path to store the dump content. (default "./dump") + --domain-subdir Use domain as sub-directory. + --key-ext string The file extension of the generated private keys. (default ".key") + --key-name string The file name (without extension) of the generated private keys. (default "privatekey") + --post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode) + --watch Enable watching changes. +``` + +### SEE ALSO + +* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_completion_fish.md b/docs/traefik-certs-dumper_completion_fish.md new file mode 100644 index 0000000..75f8be7 --- /dev/null +++ b/docs/traefik-certs-dumper_completion_fish.md @@ -0,0 +1,50 @@ +## traefik-certs-dumper 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: + + traefik-certs-dumper completion fish | source + +To load completions for every new session, execute once: + + traefik-certs-dumper completion fish > ~/.config/fish/completions/traefik-certs-dumper.fish + +You will need to start a new shell for this setup to take effect. + + +``` +traefik-certs-dumper completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --clean Clean destination folder before dumping content. (default true) + --config string config file (default is $HOME/.traefik-certs-dumper.yaml) + --crt-ext string The file extension of the generated certificates. (default ".crt") + --crt-name string The file name (without extension) of the generated certificates. (default "certificate") + --dest string Path to store the dump content. (default "./dump") + --domain-subdir Use domain as sub-directory. + --key-ext string The file extension of the generated private keys. (default ".key") + --key-name string The file name (without extension) of the generated private keys. (default "privatekey") + --post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode) + --watch Enable watching changes. +``` + +### SEE ALSO + +* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_completion_powershell.md b/docs/traefik-certs-dumper_completion_powershell.md new file mode 100644 index 0000000..e4d30e9 --- /dev/null +++ b/docs/traefik-certs-dumper_completion_powershell.md @@ -0,0 +1,47 @@ +## traefik-certs-dumper completion powershell + +Generate the autocompletion script for powershell + +### Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + traefik-certs-dumper completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +traefik-certs-dumper completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --clean Clean destination folder before dumping content. (default true) + --config string config file (default is $HOME/.traefik-certs-dumper.yaml) + --crt-ext string The file extension of the generated certificates. (default ".crt") + --crt-name string The file name (without extension) of the generated certificates. (default "certificate") + --dest string Path to store the dump content. (default "./dump") + --domain-subdir Use domain as sub-directory. + --key-ext string The file extension of the generated private keys. (default ".key") + --key-name string The file name (without extension) of the generated private keys. (default "privatekey") + --post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode) + --watch Enable watching changes. +``` + +### SEE ALSO + +* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_completion_zsh.md b/docs/traefik-certs-dumper_completion_zsh.md new file mode 100644 index 0000000..36f85e9 --- /dev/null +++ b/docs/traefik-certs-dumper_completion_zsh.md @@ -0,0 +1,61 @@ +## traefik-certs-dumper 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 <(traefik-certs-dumper completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + traefik-certs-dumper completion zsh > "${fpath[1]}/_traefik-certs-dumper" + +#### macOS: + + traefik-certs-dumper completion zsh > $(brew --prefix)/share/zsh/site-functions/_traefik-certs-dumper + +You will need to start a new shell for this setup to take effect. + + +``` +traefik-certs-dumper completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### Options inherited from parent commands + +``` + --clean Clean destination folder before dumping content. (default true) + --config string config file (default is $HOME/.traefik-certs-dumper.yaml) + --crt-ext string The file extension of the generated certificates. (default ".crt") + --crt-name string The file name (without extension) of the generated certificates. (default "certificate") + --dest string Path to store the dump content. (default "./dump") + --domain-subdir Use domain as sub-directory. + --key-ext string The file extension of the generated private keys. (default ".key") + --key-name string The file name (without extension) of the generated private keys. (default "privatekey") + --post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode) + --watch Enable watching changes. +``` + +### SEE ALSO + +* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_file.md b/docs/traefik-certs-dumper_file.md index be04027..8afe72b 100644 --- a/docs/traefik-certs-dumper_file.md +++ b/docs/traefik-certs-dumper_file.md @@ -15,7 +15,7 @@ traefik-certs-dumper file [flags] ``` -h, --help help for file --source string Path to 'acme.json' file. (default "./acme.json") - --version string Traefik version. If empty use v1. Possible values: 'v2'. + --version string Traefik version. If empty use v1. Possible values: 'v2', 'v3'. ``` ### Options inherited from parent commands @@ -37,4 +37,4 @@ traefik-certs-dumper file [flags] * [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_kv.md b/docs/traefik-certs-dumper_kv.md index a86b198..2ca0d2d 100644 --- a/docs/traefik-certs-dumper_kv.md +++ b/docs/traefik-certs-dumper_kv.md @@ -47,4 +47,4 @@ Dump the content of a KV store. * [traefik-certs-dumper kv etcd](traefik-certs-dumper_kv_etcd.md) - Dump the content of etcd. * [traefik-certs-dumper kv zookeeper](traefik-certs-dumper_kv_zookeeper.md) - Dump the content of zookeeper. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_kv_boltdb.md b/docs/traefik-certs-dumper_kv_boltdb.md index d94ce41..cc15f3d 100644 --- a/docs/traefik-certs-dumper_kv_boltdb.md +++ b/docs/traefik-certs-dumper_kv_boltdb.md @@ -49,4 +49,4 @@ traefik-certs-dumper kv boltdb [flags] * [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_kv_consul.md b/docs/traefik-certs-dumper_kv_consul.md index 2d640f1..529aaa1 100644 --- a/docs/traefik-certs-dumper_kv_consul.md +++ b/docs/traefik-certs-dumper_kv_consul.md @@ -48,4 +48,4 @@ traefik-certs-dumper kv consul [flags] * [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_kv_etcd.md b/docs/traefik-certs-dumper_kv_etcd.md index 6b3abc1..05e7eeb 100644 --- a/docs/traefik-certs-dumper_kv_etcd.md +++ b/docs/traefik-certs-dumper_kv_etcd.md @@ -49,4 +49,4 @@ traefik-certs-dumper kv etcd [flags] * [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_kv_zookeeper.md b/docs/traefik-certs-dumper_kv_zookeeper.md index b221d2e..683712a 100644 --- a/docs/traefik-certs-dumper_kv_zookeeper.md +++ b/docs/traefik-certs-dumper_kv_zookeeper.md @@ -47,4 +47,4 @@ traefik-certs-dumper kv zookeeper [flags] * [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025 diff --git a/docs/traefik-certs-dumper_version.md b/docs/traefik-certs-dumper_version.md index 09de24a..d0d20dd 100644 --- a/docs/traefik-certs-dumper_version.md +++ b/docs/traefik-certs-dumper_version.md @@ -2,10 +2,6 @@ Display version -### Synopsis - -Display version - ``` traefik-certs-dumper version [flags] ``` @@ -35,4 +31,4 @@ traefik-certs-dumper version [flags] * [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik. -###### Auto generated by spf13/cobra on 9-Oct-2019 +###### Auto generated by spf13/cobra on 21-Feb-2025