Skip to content

Commit a058939

Browse files
connorsheaCopilotcpojerfengmk2
authored
docs: Improve docs for vpx command. (#1303)
Just making it clear that it _will_ install the package if it's not found, rather than just saying it "can" download it when needed. --------- Signed-off-by: Connor Shea <connor.james.shea@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Christoph Nakazawa <xnakazawa@pm.me> Co-authored-by: MK (fengmk2) <fengmk2@gmail.com>
1 parent 51def64 commit a058939

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/guide/vpx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Use `vpx`, `vp exec`, and `vp dlx` to run binaries without switching between loc
88

99
Use the other binary commands when you need stricter control:
1010

11-
- `vpx` resolves a package binary locally first and can download it when needed
11+
- `vpx` resolves a package binary locally first by default and downloads it if not found; with `pkg@version`, `--package/-p`, or `--shell-mode`, it runs via `vp dlx`
1212
- `vp exec` runs a binary from the current project's `node_modules/.bin`
1313
- `vp dlx` runs a package binary without adding it as a dependency
1414

@@ -22,7 +22,7 @@ vpx <pkg[@version]> [args...]
2222

2323
### Options
2424

25-
- `-p, --package <name>` installs one or more packages before running the command
25+
- `-p, --package <name>` installs one or more additional packages before running the command
2626
- `-c, --shell-mode` executes the command inside a shell
2727
- `-s, --silent` suppresses Vite+ output and only shows the command output
2828

0 commit comments

Comments
 (0)