Skip to content

Commit

Permalink
docs/Shell-Completion: update Zsh completions docs for Linux
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhongRuoyu committed Oct 14, 2024
1 parent aea8775 commit 94426ba
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Shell-Completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ If you are using Homebrew's `bash` as your shell (i.e. `bash` >= v4) you should

## Configuring Completions in `zsh`

To make Homebrew's completions available in `zsh`, the Homebrew-managed `zsh/site-functions` path needs to be inserted into `FPATH` before initialising `zsh`'s completion facility. This is done by `brew shellenv`, so if you followed the post-Homebrew installation steps and have `eval "$(brew shellenv)"` in your `~/.zprofile`, all you need is add the following to your `~/.zshrc` if it's not already there:
To make Homebrew's completions available in `zsh`, the Homebrew-managed `zsh/site-functions` path needs to be inserted into `FPATH` before initialising `zsh`'s completion facility. This is done by `brew shellenv`, so if you followed the post-Homebrew installation steps, `eval "$(brew shellenv)"` should be in your `~/.zprofile` (on macOS) or `~/.zshrc` (on Linux). All you need is add the following to your `~/.zshrc` if it's not already there, and, if you're on Linux, make sure it's placed after `eval "$(brew shellenv)"`:

```sh
autoload -Uz compinit
compinit
```

Note that if you are using Oh My Zsh, it will call `compinit` for you when you source `oh-my-zsh.sh`. In this case, you should be all set without any additional configuration.
Note that if you are using Oh My Zsh, it will call `compinit` for you when you source `oh-my-zsh.sh`. In this case, make sure `eval "$(brew shellenv)"` is called before sourcing `oh-my-zsh.sh` if you're on Linux, and you should be all set without any additional configuration.

You may also need to forcibly rebuild `zcompdump`:

Expand Down

0 comments on commit 94426ba

Please sign in to comment.