From d86c141e4d8f02751673e65e9582b2a5137a7364 Mon Sep 17 00:00:00 2001 From: HAHWUL Date: Sun, 17 Nov 2024 22:48:49 +0900 Subject: [PATCH] docs: update shell completion documentation for Zsh, Bash, and Fish; add Homebrew users section Signed-off-by: HAHWUL --- docs/_advanced/tips/shell-completion.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/_advanced/tips/shell-completion.md b/docs/_advanced/tips/shell-completion.md index b564fed3..8261ff6d 100644 --- a/docs/_advanced/tips/shell-completion.md +++ b/docs/_advanced/tips/shell-completion.md @@ -6,7 +6,7 @@ nav_order: 2 layout: page --- -## Zsh completion +## Zsh Completion To enable auto-completion for Zsh, run the following command to generate the completion script: @@ -23,7 +23,7 @@ Then, move the generated script to your Zsh completions directory, typically `~/ noir --generate-completion zsh > ~/.zsh/completion/_noir ``` -## Bash completion +## Bash Completion For Bash, generate the completion script by running: @@ -40,7 +40,7 @@ After generating the script, move it to the appropriate directory for Bash compl noir --generate-completion bash > ~/.local/share/bash-completion/completions/noir ``` -## Fish completion +## Fish Completion For Fish, generate the completion script by running: @@ -54,4 +54,8 @@ After generating the script, move it to the Fish completions directory, typicall ```bash noir --generate-completion fish > ~/.config/fish/completions/noir.fish -``` \ No newline at end of file +``` + +## Shell Completion for Homebrew Users + +For Homebrew users, shell completion (e.g., for Zsh, Bash, etc.) is installed automatically, and no additional configuration is needed. The completions are ready to use immediately after installation. \ No newline at end of file