diff options
Diffstat (limited to 'home/.oh-my-zsh/plugins/zoxide/README.md')
| -rw-r--r-- | home/.oh-my-zsh/plugins/zoxide/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/zoxide/README.md b/home/.oh-my-zsh/plugins/zoxide/README.md new file mode 100644 index 0000000..45f77bd --- /dev/null +++ b/home/.oh-my-zsh/plugins/zoxide/README.md @@ -0,0 +1,17 @@ +# zoxide plugin + +Initializes [zoxide](https://github.com/ajeetdsouza/zoxide), a smarter cd +command for your terminal. + + + +To use it, add `zoxide` to the plugins array in your `.zshrc` file: + +```zsh +plugins=(... zoxide) +``` +## Overriding `z` Alias + +You can set the `ZOXIDE_CMD_OVERRIDE`, which will be passed to the `--cmd` flag of `zoxide init`. This allows you to set your `z` command to a default of `cd`. + +**Note:** you have to [install zoxide](https://github.com/ajeetdsouza/zoxide#step-1-install-zoxide) first. |