diff --git a/docs/guide/implode.md b/docs/guide/implode.md index 02a019f5f6..0cd7752e68 100644 --- a/docs/guide/implode.md +++ b/docs/guide/implode.md @@ -6,6 +6,13 @@ Use `vp implode` to remove `vp` and all related Vite+ data from your machine. `vp implode` is the cleanup command for removing a Vite+ installation and its managed data. Use it if you no longer want Vite+ to manage your runtime, package manager, and related local tooling state. +If you installed `vite-plus` globally with npm or pnpm, `vp implode` does not remove that package-manager installation. In that case, uninstall it with the same package manager you used to install it: + +```bash +npm uninstall -g vite-plus +pnpm remove -g vite-plus +``` + ::: info If you decide Vite+ is not for you, please [share your feedback with us](https://discord.gg/cAnsqHh5PX). ::: diff --git a/docs/guide/index.md b/docs/guide/index.md index d2568d0847..e564842628 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -24,6 +24,26 @@ After installation, open a new shell and run: vp help ``` +### Install with npm or pnpm + +If you prefer not to pipe a remote script into your shell, you can install the published `vite-plus` package globally with a package manager instead: + +```bash +npm install -g vite-plus +# or +pnpm add -g vite-plus +``` + +After installing, open a new shell and run `vp help`. + +If your shell cannot find `vp`, make sure your package manager's global bin directory is on your `PATH`. For `pnpm`, you may need to run `pnpm setup` first. + +This installation path is more manual than the install script: + +- It does not modify your shell profile for you. +- It does not create the Vite+-managed installation layout under `VITE_PLUS_HOME` that the install script uses. +- `vp implode` does not uninstall npm/pnpm global installs. Use `npm uninstall -g vite-plus` or `pnpm remove -g vite-plus` if you installed it this way. + ::: info Vite+ will manage your global Node.js runtime and package manager. If you'd like to opt out of this behavior, run `vp env off`. If you realize Vite+ is not for you, type `vp implode`, but please [share your feedback with us](https://discord.gg/cAnsqHh5PX). ::: diff --git a/docs/guide/upgrade.md b/docs/guide/upgrade.md index d066158f0a..7bec589ae1 100644 --- a/docs/guide/upgrade.md +++ b/docs/guide/upgrade.md @@ -17,6 +17,13 @@ You can upgrade both of them independently. vp upgrade ``` +If you installed `vite-plus` globally with npm or pnpm instead of the install script, update it with the same package manager: + +```bash +npm install -g vite-plus@latest +pnpm add -g vite-plus@latest +``` + ## Local `vite-plus` Update the project dependency with the package manager commands in Vite+: