Skip to content

Commit

Permalink
docs: update shell completion documentation for Zsh, Bash, and Fish; …
Browse files Browse the repository at this point in the history
…add Homebrew users section

Signed-off-by: HAHWUL <[email protected]>
  • Loading branch information
hahwul committed Nov 17, 2024
1 parent f4dbbea commit d86c141
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/_advanced/tips/shell-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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
```
```

## 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.

0 comments on commit d86c141

Please sign in to comment.