Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/agent-help-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"sandbox": patch
---

Show a coding agent launch example first in the top-level CLI help.
4 changes: 4 additions & 0 deletions packages/sandbox/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Commands:

Examples:

– Start a coding agent in a sandbox

$ sandbox create opencode

– Create a sandbox on a Secure Compute network (requires an Enterprise plan)

$ sandbox create --network-id your_network_id_here
Expand Down
4 changes: 4 additions & 0 deletions packages/sandbox/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ export const app = (opts?: { withoutAuth?: boolean; appName?: string }) => {
}),
},
examples: [
{
description: "Start a coding agent in a sandbox",
command: `${appName} create opencode`,
},
{
description:
"Create a sandbox on a Secure Compute network (requires an Enterprise plan)",
Expand Down
14 changes: 14 additions & 0 deletions skills/sandbox/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -987,6 +987,12 @@ sandbox create --region <region> # Defaults to iad1; any Vercel regi
sandbox create --failover-regions <region>,<region> # Comma-separated
sandbox create --failover-regions none # No failover, overrides the project default

# Start a coding agent (interactive terminal required)
sandbox create opencode
sandbox create pi
sandbox create claude
sandbox create codex

# Fork an existing sandbox (inherits config, incl. env; --env replaces it)
sandbox fork <source>
sandbox fork <source> --name my-fork --vcpus 4 --env FOO=1
Expand Down Expand Up @@ -1047,6 +1053,14 @@ sandbox config network-policy <name> --network-policy deny-all
sandbox config tags <name> --tag env=prod
```

Agent shortcuts use the universal image and require an interactive terminal.
Do not combine them with `--image`, `--runtime`, or `--snapshot`. Configure
authentication for the agent separately from `sandbox login`.

Exiting the agent leaves the sandbox running. Unless you pass `--silent`, the CLI
prints reconnect and stop commands. Follow any environment-variable reminder
printed with the reconnect command.

## Common Patterns

### Dev Server Pattern (Persistent)
Expand Down
Loading