summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/zoxide
diff options
context:
space:
mode:
Diffstat (limited to 'home/.oh-my-zsh/plugins/zoxide')
-rw-r--r--home/.oh-my-zsh/plugins/zoxide/README.md17
-rw-r--r--home/.oh-my-zsh/plugins/zoxide/zoxide.plugin.zsh5
2 files changed, 22 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.
+
+![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.
diff --git a/home/.oh-my-zsh/plugins/zoxide/zoxide.plugin.zsh b/home/.oh-my-zsh/plugins/zoxide/zoxide.plugin.zsh
new file mode 100644
index 0000000..25d2e83
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/zoxide/zoxide.plugin.zsh
@@ -0,0 +1,5 @@
+if (( $+commands[zoxide] )); then
+ eval "$(zoxide init --cmd ${ZOXIDE_CMD_OVERRIDE:-z} zsh)"
+else
+ echo '[oh-my-zsh] zoxide not found, please install it from https://github.com/ajeetdsouza/zoxide'
+fi