fix(sandbox): use invoked app name in help examples - #269
Open
erulkey wants to merge 1 commit into
Open
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
marc-vercel
approved these changes
Jul 30, 2026
QuiiBz
approved these changes
Jul 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The CLI can run under two names: standalone
sandbox, or embedded in the Vercel CLI asvercel sandbox(the embedding passesappName: 'vercel sandbox'tocreateApp). The usage line respects that name, but the top-level help examples are hardcoded to the standalone form. Sovercel sandbox --helpprints:For Vercel CLI users there is no
sandboxbinary on PATH, so copy-pasting the CLI's own examples fails withzsh: command not found: sandbox. Hit this today on a fresh first run (Vercel CLI 56.2.0).Fix
Build the example commands from the same
appNamethe usage line already uses. Standalone output is unchanged.Verified against the built package:
createApp({ appName: "vercel sandbox" })help now shows$ vercel sandbox shetc.createApp({ appName: "sandbox" })output is identical to before.Not covered here
Subcommand-level examples (
create.ts,fork.ts) and runtime hints (format-error.ts,snapshot.ts,args/sandbox-name.ts,logout.ts,cp.ts) also hardcodesandbox .... Those strings are built at module import time, beforecreateAppreceives the name, so fixing them needs a small refactor (shared accessor or command factories). Happy to follow up with that if you want it.