summaryrefslogtreecommitdiff
path: root/plugins/starship
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/starship')
-rw-r--r--plugins/starship/README.md21
-rw-r--r--plugins/starship/starship.plugin.zsh8
2 files changed, 29 insertions, 0 deletions
diff --git a/plugins/starship/README.md b/plugins/starship/README.md
new file mode 100644
index 000000000..0e66c5294
--- /dev/null
+++ b/plugins/starship/README.md
@@ -0,0 +1,21 @@
+# starship plugin
+
+Initializes [starship prompt](https://starship.rs) - a minimal, blazing-fast and infinitely customizable cross-shell prompt.
+
+[Demo](https://user-images.githubusercontent.com/62098008/169764279-50b48262-9506-4651-ba89-f6611a88ebf0.mp4)
+
+[External repository](https://github.com/axieax/zsh-starship) for this zsh plugin.
+
+# Installation
+
+**Note:** you have to [install starship](https://starship.rs/guide/#%F0%9F%9A%80-installation) first.
+
+## [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh)
+
+Add `starship` to the plugins array in your `.zshrc` file:
+
+```zsh
+plugins=(... starship)
+```
+
+## ⚠️ ENABLING THIS PLUGIN WILL UNSET YOUR ZSH_THEME VARIABLE
diff --git a/plugins/starship/starship.plugin.zsh b/plugins/starship/starship.plugin.zsh
new file mode 100644
index 000000000..8c5d9135e
--- /dev/null
+++ b/plugins/starship/starship.plugin.zsh
@@ -0,0 +1,8 @@
+# ignore oh-my-zsh theme
+unset ZSH_THEME
+
+if (( $+commands[starship] )); then
+ eval "$(starship init zsh)"
+else
+ echo '[oh-my-zsh] starship not found, please install it from https://starship.rs'
+fi