diff options
Diffstat (limited to 'plugins/npx')
-rw-r--r-- | plugins/npx/README.md | 31 | ||||
-rw-r--r-- | plugins/npx/npx.plugin.zsh | 7 |
2 files changed, 38 insertions, 0 deletions
diff --git a/plugins/npx/README.md b/plugins/npx/README.md new file mode 100644 index 000000000..1c052930b --- /dev/null +++ b/plugins/npx/README.md @@ -0,0 +1,31 @@ +# NPX Plugin +> npx(1) -- execute npm package binaries. ([more info](https://github.com/zkat/npx)) + +This plugin automatically registers npx command-not-found handler if `npx` exists in your `$PATH`. + +## Setup + +- Add plugin to `~/.zshrc` + +```bash +plugins=(.... npx) +``` + +- Globally install npx binary (npx will be auto installed with recent versions of Node.js) +```bash +sudo npm install -g npx +``` + +## Note + +The shell auto-fallback doesn't auto-install plain packages. In order to get it to install something, you need to add `@`: + +``` +➜ jasmine@latest # or just `jasmine@` +npx: installed 13 in 1.896s +Randomized with seed 54385 +Started +``` + +It does it this way so folks using the fallback don't accidentally try to install regular typoes. + diff --git a/plugins/npx/npx.plugin.zsh b/plugins/npx/npx.plugin.zsh new file mode 100644 index 000000000..32bb67377 --- /dev/null +++ b/plugins/npx/npx.plugin.zsh @@ -0,0 +1,7 @@ +# NPX Plugin +# https://www.npmjs.com/package/npx +# Maintainer: Pooya Parsa <pooya@pi0.ir> + +(( $+commands[npx] )) && { + source <(npx --shell-auto-fallback zsh) +} |