Skip to content

Commit 034a486

Browse files
authored
cli reference: update completion docs for zsh (#2371)
## Summary The suggested docs don't work if Oh My Zsh Plugins are installed. I updated the docs accordingly.
1 parent e8763dd commit 034a486

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/app/docs/cli_reference/devbox_completion_zsh.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22

33
Generate the autocompletion script for the zsh shell.
44

5-
If shell completion is not already enabled in your environment you will need
6-
to enable it. You can execute the following once:
5+
If you are using Oh My Zsh, just run the following:
6+
7+
```bash
8+
mkdir -p ~/.oh-my-zsh/completions
9+
devbox completion zsh > ~/.oh-my-zsh/completions/_devbox
10+
```
11+
12+
If you are not using Oh My Zsh and shell completion is not already enabled in your environment you will need
13+
to enable it. You can execute the following once:
714

815
```bash
916
echo "autoload -U compinit; compinit" >> ~/.zshrc

0 commit comments

Comments
 (0)