summaryrefslogtreecommitdiff
path: root/plugins/zoxide/README.md
blob: 45f77bdf584e5cb5741651d005d25c37da1bb3fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# zoxide plugin

Initializes [zoxide](https://github.com/ajeetdsouza/zoxide), a smarter cd
command for your terminal.

![Tutorial](https://raw.githubusercontent.com/ajeetdsouza/zoxide/97dc08347d9dbf5b5a4516b79e0ac27366b962ce/contrib/tutorial.webp)

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.