diff options
author | Sven-Hendrik Haase <svenstaro@gmail.com> | 2021-03-28 21:15:23 +0000 |
---|---|---|
committer | Sven-Hendrik Haase <svenstaro@gmail.com> | 2021-03-28 21:15:23 +0000 |
commit | b0a84c74ddbd50f760a002e470cfdb815a1bdd1a (patch) | |
tree | fd54033f31e1edad8e48a6a78578fe4962cfe629 | |
parent | Update features list (diff) | |
download | miniserve-b0a84c74ddbd50f760a002e470cfdb815a1bdd1a.tar.gz miniserve-b0a84c74ddbd50f760a002e470cfdb815a1bdd1a.zip |
Add README instructions for using shell completions
-rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -189,6 +189,19 @@ Alternatively install with [Homebrew](https://brew.sh/). docker run -v /tmp:/tmp -p 8080:8080 --rm -it svenstaro/miniserve /tmp +## Shell completions + +If you'd like to make use of the built-in shell completion support, you need to run `miniserve +--print-completions <your-shell>` and put the completions in the correct place for your shell. A +few examples with common paths are provided below: + + # For bash + miniserve --print-completions bash > ~/.local/share/bash-completion/miniserve + # For zsh + miniserve --print-completions zsh > /usr/local/share/zsh/site-functions/_miniserve + # For fish + miniserve --print-completions fish > ~/.config/fish/completions/miniserve.fish + ## Binding behavior For convenience reasons, miniserve will try to bind on all interfaces by default (if no `-i` is provided). |