From b0a84c74ddbd50f760a002e470cfdb815a1bdd1a Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase Date: Sun, 28 Mar 2021 23:15:23 +0200 Subject: Add README instructions for using shell completions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9796886..5503f4d 100644 --- a/README.md +++ b/README.md @@ -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 ` 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). -- cgit v1.2.3