sbx: clarify sandbox auto-naming in docs#25074
Merged
Merged
Conversation
Document the <agent>-<directory> auto-naming rule and use concrete names that match it in examples. Where --name is shown, keep a custom-looking value so the flag's purpose is visible.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
shivaylamba
reviewed
May 16, 2026
shivaylamba
left a comment
shivaylamba
left a comment
There was a problem hiding this comment.
Amazing PR - makes a lot of sense and makes it super simple to understand!
Revert changes to usage.md and other sandbox docs; keep only the get-started.md naming clarification.
dvdksn
pushed a commit
to dvdksn/docs
that referenced
this pull request
May 29, 2026
## Description Running `sbx run claude` from `~/my-pro` produces a sandbox named `claude-my-pro`, but the docs tell you to clean up with `sbx rm my-sandbox` and never explain where that name came from. This PR documents the `<agent>-<directory>` and updates examples across the sandbox docs to use names that match the rule, so the flow lines up with what users actually see in `sbx ls`. <img width="1391" height="703" alt="Screenshot 2026-05-16 at 2 48 30 PM" src="https://github.com/user-attachments/assets/b0357bb5-32ea-48f4-ab5d-8494431e2772" /> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [x] Technical review - [ ] Editorial review - [ ] Product review
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
3 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.
Description
Running
sbx run claudefrom~/my-proproduces a sandbox namedclaude-my-pro, but the docs tell you to clean up withsbx rm my-sandboxand never explain where that name came from.This PR documents the
<agent>-<directory>and updates examples across the sandbox docs to use names that match the rule, so the flow lines up with what users actually see insbx ls.Reviews