Skip to content

docs: add manual package-manager install path for vp #1116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yash27-lab wants to merge 2 commits into
base: main
Choose a base branch
from
+34 −0
Open

docs: add manual package-manager install path for vp #1116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1d31c4
docs: add manual package-manager install path for vp
yash27-lab Mar 23, 2026
b1d23ec
docs: clarify package-manager install caveats
yash27-lab Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/guide/implode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
Expand Down
20 changes: 20 additions & 0 deletions docs/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

@fengmk2 fengmk2 Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the vp cli from vite-plus's package we call it Local CLI. It is not recommended to install this Local CLI globally through a package manager, as its features differ from those of the Global CLI, such as the lack of node runtime manager(e.g.: vp env command is missing) and package manager functionalities.

Copy link
Author

@yash27-lab yash27-lab Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that makes sense.

I misunderstood the published vite-plus package as a supported global installation path for the full vp CLI. I’ll avoid documenting it that way.

Would you prefer this PR to be reshaped to clarify that:

  • the install script is the supported way to install the global vp CLI
  • the published vite-plus package is the project-local CLI and should not be installed globally


```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).
:::
Expand Down
7 changes: 7 additions & 0 deletions docs/guide/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+:
Expand Down
Loading