Skip to content

Commit

Permalink
docs: document shell completion
Browse files Browse the repository at this point in the history
  • Loading branch information
krish-r committed Jun 2, 2024
1 parent 1796735 commit 28f885c
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions book/src/building-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Note to packagers](#note-to-packagers)
- [Validating the installation](#validating-the-installation)
- [Configure the desktop shortcut](#configure-the-desktop-shortcut)
- [Configure shell completion](#configure-shell-completion)

Requirements:

Expand Down Expand Up @@ -156,3 +157,45 @@ file. For example, to use `kitty`:
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
```

### Configure shell completion

You can configure shell completion for Helix by copying the completion file into your shell's completion directory.

#### Bash

```sh
cp contrib/completion/hx.bash ~/.local/share/bash-completion/completions/hx
```

#### Zsh

```sh
cp contrib/completion/hx.zsh ~/.config/zsh/completions/_hx
```

Add the following in your `.zshrc` before initializing completions with `compinit`:

```sh
fpath+=~/.config/zsh/completions
```

#### Fish

```sh
cp contrib/completion/hx.fish ~/.config/fish/completions/hx.fish
```

#### Elvish

```sh
cp contrib/completion/hx.elv ~/.config/elvish/lib/hx.elv
```

Add the following in your `rc.elv`:

```sh
use hx
```

> 💡 You may need to restart your shell in order for the changes to take effect.

0 comments on commit 28f885c

Please sign in to comment.