1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Add Shell Completion script generation

`dnsutils shell-completion <shell>` will generate a shell completion
script for the specified shell (bash or zsh). If no shell is specified,
the script will be generated for the current shell, using `$SHELL`.
This commit is contained in:
Tom Whitwell
2023-06-20 16:45:16 +01:00
parent cb3c020f45
commit b91bcf373f
7 changed files with 413 additions and 1 deletions

View File

@ -54,6 +54,23 @@ git clone https://github.com/StackExchange/dnscontrol
If these don't work, more info is in [#805](https://github.com/StackExchange/dnscontrol/issues/805).
## 1.1. Shell Completion
Shell completion is available for `zsh` and `bash`.
### zsh
Add `eval "$(dnscontrol shell-completion zsh)"` to your `~/.zshrc` file.
This requires completion to be enabled in zsh. A good tutorial for this is available at
[The Valuable Dev](https://thevaluable.dev/zsh-completion-guide-examples/) <sup>[[archived](https://web.archive.org/web/20231015083946/https://thevaluable.dev/zsh-completion-guide-examples/)]</sup>.
### bash
Add `eval "$(dnscontrol shell-completion bash)"` to your `~/.bashrc` file.
This requires the `bash-completion` package to be installed. See [scop/bash-completion](https://github.com/scop/bash-completion/) for instructions.
## 2. Create a place for the config files
Create a directory where you'll store your configuration files.