Skip to content

Commit d1d31c4

Browse files
committed
docs: add manual package-manager install path for vp
1 parent 15afbc0 commit d1d31c4

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

docs/guide/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,27 @@ After installation, open a new shell and run:
2424
vp help
2525
```
2626

27+
### Install with npm or pnpm
28+
29+
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:
30+
31+
```bash
32+
npm install -g vite-plus
33+
# or
34+
pnpm add -g vite-plus
35+
```
36+
37+
After installing, open a new shell and run `vp help`.
38+
39+
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.
40+
41+
This installation path is more manual than the install script:
42+
43+
- It does not modify your shell profile for you.
44+
- It does not automatically create the `node`, `npm`, and `npx` shims in `VITE_PLUS_HOME/bin`.
45+
- If you want Vite+ to manage those shims after installing, run `vp env setup`.
46+
- If you want to keep your system Node.js first, run `vp env off`.
47+
2748
::: info
2849
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).
2950
:::

docs/guide/upgrade.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ You can upgrade both of them independently.
1717
vp upgrade
1818
```
1919

20+
If you installed `vite-plus` globally with npm or pnpm instead of the install script, update it with the same package manager:
21+
22+
```bash
23+
npm install -g vite-plus@latest
24+
pnpm add -g vite-plus@latest
25+
```
26+
2027
## Local `vite-plus`
2128

2229
Update the project dependency with the package manager commands in Vite+:

0 commit comments

Comments
 (0)