summaryrefslogtreecommitdiff
path: root/plugins/rtx
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/rtx')
-rw-r--r--plugins/rtx/README.md30
-rw-r--r--plugins/rtx/rtx.plugin.zsh18
2 files changed, 48 insertions, 0 deletions
diff --git a/plugins/rtx/README.md b/plugins/rtx/README.md
new file mode 100644
index 000000000..c6436d3a7
--- /dev/null
+++ b/plugins/rtx/README.md
@@ -0,0 +1,30 @@
+## rtx
+
+
+Adds integration with [rtx](https://github.com/jdx/rtx), a runtime executor compatible with npm, nodenv, pyenv, etc. rtx is written in rust and is very fast. 20x-200x faster than asdf. With that being said, rtx is compatible with asdf plugins and .tool-versions files. It can be used as a drop-in replacement.
+
+### Installation
+
+1. [Download & install rtx](https://github.com/jdx/rtx#installation) by running the following:
+
+ ```
+ curl https://rtx.pub/install.sh | sh
+ ```
+
+
+2. [Enable rtx](https://github.com/jdx/rtx#quickstart) by adding it to your `plugins` definition in `~/.zshrc`.
+
+ ```
+ plugins=(rtx)
+ ```
+
+### Usage
+
+See the [rtx readme](https://github.com/jdx/rtx#table-of-contents) for information on how to use rtx. Here are a few examples:
+
+```
+rtx install node Install the current version specified in .tool-versions/.rtx.toml
+rtx use -g node@system Use system node as global default
+rtx install node@20.0.0 Install a specific version number
+rtx use -g node@20 Use node-20.x as global default
+```
diff --git a/plugins/rtx/rtx.plugin.zsh b/plugins/rtx/rtx.plugin.zsh
new file mode 100644
index 000000000..a01828afd
--- /dev/null
+++ b/plugins/rtx/rtx.plugin.zsh
@@ -0,0 +1,18 @@
+# rtx needs to be in $PATH
+if (( ! ${+commands[rtx]} )); then
+ return
+fi
+
+# Load rtx hooks
+eval "$(rtx activate zsh)"
+
+# If the completion file doesn't exist yet, we need to autoload it and
+# bind it to `rtx`. Otherwise, compinit will have already done that.
+if [[ ! -f "$ZSH_CACHE_DIR/completions/_rtx" ]]; then
+ typeset -g -A _comps
+ autoload -Uz _rtx
+ _comps[rtx]=_rtx
+fi
+
+# Generate and load rtx completion
+rtx completion zsh >! "$ZSH_CACHE_DIR/completions/_rtx" &|