Skip to content

Commit be80c40

Browse files
add details about zsh completion script format (#217)
1 parent 7255fd5 commit be80c40

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/07 Completion Scripts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ The correct method of installing a completion script depends on your shell and y
2828

2929
If you have [`oh-my-zsh`](https://ohmyz.sh) installed, you already have a directory of automatically loading completion scripts — `.oh-my-zsh/completions`. Copy your new completion script to that directory.
3030

31+
```
32+
$ example --generate-completion-script zsh > ~/.oh-my-zsh/completions/_example
33+
```
34+
35+
> Your completion script must have the following filename format: `_example`.
36+
3137
Without `oh-my-zsh`, you'll need to add a path for completion scripts to your function path, and turn on completion script autoloading. First, add these lines to `~/.zshrc`:
3238

3339
```

0 commit comments

Comments
 (0)