Skip to content

Commit

Permalink
cli reference: update completion docs for zsh (#2371)
Browse files Browse the repository at this point in the history
## Summary

The suggested docs don't work if Oh My Zsh Plugins are installed.
 I updated the docs accordingly.
  • Loading branch information
DerArkeN authored Oct 23, 2024
1 parent e8763dd commit 034a486
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/app/docs/cli_reference/devbox_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
If you are using Oh My Zsh, just run the following:

```bash
mkdir -p ~/.oh-my-zsh/completions
devbox completion zsh > ~/.oh-my-zsh/completions/_devbox
```

If you are not using Oh My Zsh and shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:

```bash
echo "autoload -U compinit; compinit" >> ~/.zshrc
Expand Down

0 comments on commit 034a486

Please sign in to comment.