fix(sandbox): use invoked app name in help examples - #269
Merged
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
Merged
AndyW22
pushed a commit
that referenced
this pull request
Aug 7, 2026
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## sandbox@4.0.0 ### Major Changes - Add support for Vercel Managed Images and deprecate the `runtime` option in the SDK and CLI. Runtime-based creation remains supported through the legacy v2 API; image-based and default creation use the v3 API. Passing both `runtime` and `image` is an error. ([#276](#276)) Sandboxes that do not specify an image now use `vercel/sandbox/universal`. The previous default was the `node24` runtime on Amazon Linux 2023. The new default is based on Ubuntu and includes Node.js 24, Bun, Python 3.14, coding agents, and common development and debugging tools. Existing `runtime` calls continue to work, it's recommended to migrate to Vercel managed images when possible: - Not using `runtime`: omit `image` to use the new Universal image, or set `image: "vercel/sandbox/node:24"` for an Ubuntu-based Node.js equivalent to the previous default. - Using `runtime: "node22"`: use `image: "vercel/sandbox/node:22"` for an Ubuntu-based equivalent. - Using `runtime: "node24"`: use `image: "vercel/sandbox/node:24"` for an Ubuntu-based equivalent. - Using `runtime: "node26"`: use `image: "vercel/sandbox/node:26"` for an Ubuntu-based equivalent. - Using `runtime: "python3.13"`: use `image: "vercel/sandbox/python:3.14"` for an Ubuntu-based equivalent, and note the Python version upgrade. ### Patch Changes - Use the invoked app name in help examples so `vercel sandbox --help` shows `vercel sandbox ...` commands instead of the standalone `sandbox ...` form, which is not on PATH for Vercel CLI users. ([#269](#269)) - Updated dependencies [[`5c9e2d5f34f20632ed5a1de1288e811b67b95423`](5c9e2d5)]: - @vercel/sandbox@3.0.0 ## @vercel/sandbox@3.0.0 ### Major Changes - Add support for Vercel Managed Images and deprecate the `runtime` option in the SDK and CLI. Runtime-based creation remains supported through the legacy v2 API; image-based and default creation use the v3 API. Passing both `runtime` and `image` is an error. ([#276](#276)) Sandboxes that do not specify an image now use `vercel/sandbox/universal`. The previous default was the `node24` runtime on Amazon Linux 2023. The new default is based on Ubuntu and includes Node.js 24, Bun, Python 3.14, coding agents, and common development and debugging tools. Existing `runtime` calls continue to work, it's recommended to migrate to Vercel managed images when possible: - Not using `runtime`: omit `image` to use the new Universal image, or set `image: "vercel/sandbox/node:24"` for an Ubuntu-based Node.js equivalent to the previous default. - Using `runtime: "node22"`: use `image: "vercel/sandbox/node:22"` for an Ubuntu-based equivalent. - Using `runtime: "node24"`: use `image: "vercel/sandbox/node:24"` for an Ubuntu-based equivalent. - Using `runtime: "node26"`: use `image: "vercel/sandbox/node:26"` for an Ubuntu-based equivalent. - Using `runtime: "python3.13"`: use `image: "vercel/sandbox/python:3.14"` for an Ubuntu-based equivalent, and note the Python version upgrade. ## @vercel/sandbox-mock@3.0.0 ### Major Changes - Add support for Vercel Managed Images and deprecate the `runtime` option in the SDK and CLI. Runtime-based creation remains supported through the legacy v2 API; image-based and default creation use the v3 API. Passing both `runtime` and `image` is an error. ([#276](#276)) Sandboxes that do not specify an image now use `vercel/sandbox/universal`. The previous default was the `node24` runtime on Amazon Linux 2023. The new default is based on Ubuntu and includes Node.js 24, Bun, Python 3.14, coding agents, and common development and debugging tools. Existing `runtime` calls continue to work, it's recommended to migrate to Vercel managed images when possible: - Not using `runtime`: omit `image` to use the new Universal image, or set `image: "vercel/sandbox/node:24"` for an Ubuntu-based Node.js equivalent to the previous default. - Using `runtime: "node22"`: use `image: "vercel/sandbox/node:22"` for an Ubuntu-based equivalent. - Using `runtime: "node24"`: use `image: "vercel/sandbox/node:24"` for an Ubuntu-based equivalent. - Using `runtime: "node26"`: use `image: "vercel/sandbox/node:26"` for an Ubuntu-based equivalent. - Using `runtime: "python3.13"`: use `image: "vercel/sandbox/python:3.14"` for an Ubuntu-based equivalent, and note the Python version upgrade. ### Patch Changes - Updated dependencies [[`5c9e2d5f34f20632ed5a1de1288e811b67b95423`](5c9e2d5)]: - @vercel/sandbox@3.0.0 ## sandbox-image-arch@0.1.0 ### Minor Changes - Initial release of the `vercel/sandbox/*` images: `ubuntu` (base), `node` (22/24/26), `python` (3.14 with Git), `universal` (Node.js, Python, coding agents and utilities) and `arch` (with yay/AUR support). ([#276](#276)) ## sandbox-image-node@0.1.0 ### Minor Changes - Initial release of the `vercel/sandbox/*` images: `ubuntu` (base), `node` (22/24/26), `python` (3.14 with Git), `universal` (Node.js, Python, coding agents and utilities) and `arch` (with yay/AUR support). ([#276](#276)) ## sandbox-image-python@0.1.0 ### Minor Changes - Initial release of the `vercel/sandbox/*` images: `ubuntu` (base), `node` (22/24/26), `python` (3.14 with Git), `universal` (Node.js, Python, coding agents and utilities) and `arch` (with yay/AUR support). ([#276](#276)) ## sandbox-image-ubuntu@0.1.0 ### Minor Changes - Initial release of the `vercel/sandbox/*` images: `ubuntu` (base), `node` (22/24/26), `python` (3.14 with Git), `universal` (Node.js, Python, coding agents and utilities) and `arch` (with yay/AUR support). ([#276](#276)) ## sandbox-image-universal@0.1.0 ### Minor Changes - Initial release of the `vercel/sandbox/*` images: `ubuntu` (base), `node` (22/24/26), `python` (3.14 with Git), `universal` (Node.js, Python, coding agents and utilities) and `arch` (with yay/AUR support). ([#276](#276)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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
4 participants
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.