From d5b297bb3cc67c573b18e35a545b18455df5af3a Mon Sep 17 00:00:00 2001 From: JongKyung Lee Date: Sat, 10 Oct 2026 12:15:43 +0900 Subject: [PATCH 1/2] docs: document shell completion --- docs/guide/env.md | 7 +++++++ docs/guide/run.md | 2 ++ 2 files changed, 9 insertions(+) diff --git a/docs/guide/env.md b/docs/guide/env.md index 0e6fb912c8..7ea8eb5df2 100644 --- a/docs/guide/env.md +++ b/docs/guide/env.md @@ -171,6 +171,13 @@ Only `vp env use` needs this alternate command. Other `vp env` commands work nor In CI, `vp env use` can run without shell initialization. It writes a temporary session file per runtime or package manager in the resolved state directory, such as `.session-node-version` or `.session-pnpm-version`. Later shim calls in the same job use these files to resolve the same environment. +#### Shell completion + +The global CLI supports Tab completion in Bash, Zsh, Fish, Nushell, and PowerShell. Run `vp env setup` and follow its printed shell setup instructions to enable it. Press Tab to complete commands and options, or project task names after `vp run` and `vpr`. + +- **Zsh**: Run `autoload -Uz compinit; compinit` before loading the setup script if your shell has not initialized completion. +- **Nushell**: Completion requires `fish` on `PATH`. + ### Manage - `vp env default` shows the global Node.js default and each configured package-manager version. Bare versions set Node.js; qualified specs such as `pnpm@10.18.0` set that package manager's shim default without replacing the defaults for Bun, Yarn, or npm. `--unset` clears all defaults unless scoped. diff --git a/docs/guide/run.md b/docs/guide/run.md index 384f0f3628..90d7309c8c 100644 --- a/docs/guide/run.md +++ b/docs/guide/run.md @@ -38,6 +38,8 @@ Select a task (↑/↓, Enter to run, type to search): test: jest ``` +With [shell completion](/guide/env#shell-completion) enabled, press Tab after `vp run ` or `vpr ` to complete task names from your project. + ## Built-in Commands vs Scripts `vp dev` is a built-in command. `vp run dev` is your `dev` script. Built-in commands cannot be overwritten, so adding a `dev` script does not change what `vp dev` does: From 5001e97038ca59649a082526cd0228f86f0a3133 Mon Sep 17 00:00:00 2001 From: JongKyung Lee Date: Sat, 10 Oct 2026 12:24:18 +0900 Subject: [PATCH 2/2] docs: remove broad option completion claim --- docs/guide/env.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/env.md b/docs/guide/env.md index 7ea8eb5df2..408fdcc8a4 100644 --- a/docs/guide/env.md +++ b/docs/guide/env.md @@ -173,7 +173,7 @@ In CI, `vp env use` can run without shell initialization. It writes a temporary #### Shell completion -The global CLI supports Tab completion in Bash, Zsh, Fish, Nushell, and PowerShell. Run `vp env setup` and follow its printed shell setup instructions to enable it. Press Tab to complete commands and options, or project task names after `vp run` and `vpr`. +The global CLI supports Tab completion in Bash, Zsh, Fish, Nushell, and PowerShell. Run `vp env setup` and follow its printed shell setup instructions to enable it. Press Tab to complete commands, or project task names after `vp run` and `vpr`. - **Zsh**: Run `autoload -Uz compinit; compinit` before loading the setup script if your shell has not initialized completion. - **Nushell**: Completion requires `fish` on `PATH`.