Skip to content

docs: Improve docs for vpx command. #1303

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
connorshea wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

docs: Improve docs for vpx command. #1303

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4d2544
docs: Improve docs for vpx command.
connorshea Apr 5, 2026
5c20419
Update docs/guide/vpx.md
connorshea Apr 5, 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
4 changes: 2 additions & 2 deletions docs/guide/vpx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Use `vpx`, `vp exec`, and `vp dlx` to run binaries without switching between loc

Use the other binary commands when you need stricter control:

- `vpx` resolves a package binary locally first and can download it when needed
- `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`
- `vp exec` runs a binary from the current project's `node_modules/.bin`
- `vp dlx` runs a package binary without adding it as a dependency

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

### Options

- `-p, --package <name>` installs one or more packages before running the command
- `-p, --package <name>` installs one or more additional packages before running the command
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

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

The updated --package/-p description says “additional packages”, but vpx supports using --package to specify the package that provides the command when the binary name differs from the package name (e.g. vpx --package @pnpm/meta-updater meta-updater --help). Calling these “additional” can be misleading; consider rewording to “installs one or more packages before running the command” (or similar) so it covers both primary and extra packages.

Suggested change
- `-p, --package <name>` installs one or more additional packages before running the command
- `-p, --package <name>` installs one or more packages before running the command

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

@connorshea connorshea Apr 5, 2026

Choose a reason for hiding this comment

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

I'm actually not sure why the previous docs were written this way about -p/--package if this is true? Were these docs AI-generated or is Copilot wrong 😅

- `-c, --shell-mode` executes the command inside a shell
- `-s, --silent` suppresses Vite+ output and only shows the command output

Expand Down
Loading