summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/zoxide/README.md
diff options
context:
space:
mode:
authorPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
committerPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
commit1eb69e9a795cc19450178c07d8d382622bc7ad70 (patch)
treeb6bc60605044fe929986f31b3b6bf4fee9b56e14 /.config/zsh/oh-my-zsh/plugins/zoxide/README.md
first commit
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/zoxide/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/zoxide/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/zoxide/README.md b/.config/zsh/oh-my-zsh/plugins/zoxide/README.md
new file mode 100644
index 0000000..45f77bd
--- /dev/null
+++ b/.config/zsh/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.
+
+![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.