Skip to content

feat(sandbox): store default sandbox in profile #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ramon Nogueira (ramon-langchain) wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(sandbox): store default sandbox in profile #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3abd481
feat(sandbox): store default sandbox in profile
ramon-langchain May 28, 2026
5751613
refactor(sandbox): rename default sandbox field
ramon-langchain May 28, 2026
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
1 change: 1 addition & 0 deletions internal/cmd/sandbox.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Common workflows:

# Run a command inside the sandbox
langsmith sandbox exec my-vm -- uname -a
langsmith sandbox exec -- uname -a

# Open an interactive shell
langsmith sandbox console my-vm
Expand Down
131 changes: 105 additions & 26 deletions internal/cmd/sandbox_box.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"github.com/langchain-ai/langsmith-cli/internal/client"
"github.com/langchain-ai/langsmith-cli/internal/cmdutil"
lsconfig "github.com/langchain-ai/langsmith-cli/internal/config"
"github.com/langchain-ai/langsmith-cli/internal/structured"
"github.com/langchain-ai/langsmith-go"
"github.com/spf13/cobra"
Expand Down Expand Up @@ -101,6 +102,45 @@ func sandboxCreateParams(name string, in *sandboxCreateInput) (langsmith.Sandbox
return params, nil
}

func resolveSandboxName(cmd *cobra.Command, args []string) (string, error) {
if len(args) > 0 {
return args[0], nil
}
return defaultSandboxName(cmd)
}

func defaultSandboxName(cmd *cobra.Command) (string, error) {
cfg, err := lsconfig.Load()
if err != nil {
return "", err
}
profileName, profile, ok := cfg.ResolveProfile(flagProfile, profileEnvName())
if !ok || profile.DefaultSandboxName == "" {
if profileName != "" {
return "", fmt.Errorf("no sandbox specified and profile %q has no default sandbox", profileName)
}
return "", fmt.Errorf("no sandbox specified and no default profile is selected")
}
return profile.DefaultSandboxName, nil
}

func setDefaultSandboxName(cmd *cobra.Command, name string) error {
if name == "" {
return nil
}
cfg, err := lsconfig.Load()
if err != nil {
return err
}
profileName, profile, ok := cfg.ResolveProfile(flagProfile, profileEnvName())
if !ok {
return nil
}
profile.DefaultSandboxName = name
cfg.Profiles[profileName] = profile
return cfg.Save()
}

var sandboxCreateCommand = structured.Command[*sandboxCreateInput]{
Use: "create [name]",
Short: "Create a sandbox VM",
Expand Down Expand Up @@ -167,6 +207,13 @@ Examples:
if err != nil {
return nil, fmt.Errorf("creating sandbox: %w", err)
}
defaultName := resp.Name
if defaultName == "" {
defaultName = resp.ID
}
if err := setDefaultSandboxName(cmd, defaultName); err != nil {
return nil, fmt.Errorf("setting default sandbox: %w", err)
}
Comment on lines +214 to +216
Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration Bot May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 sandbox create returns error and hides successful creation when config write fails

In sandboxCreateCommand.Action, after the sandbox is successfully created on the server via c.SDK.Sandboxes.Boxes.New(), the code calls setDefaultSandboxName() to persist the default sandbox name to the config file. If this config write fails (e.g., read-only filesystem, disk full, corrupted config), the action returns (nil, err). Because the structured.Command framework at internal/structured/command.go:28-29 checks if err != nil { return err } before rendering, the successfully created sandbox's details (name, ID, status) are never shown to the user. The user sees only an error like setting default sandbox: ... and may not realize the sandbox was created, potentially retrying and creating duplicates or leaving an orphaned sandbox they can't identify.

Suggested change
if err := setDefaultSandboxName(cmd, defaultName); err != nil {
return nil, fmt.Errorf("setting default sandbox: %w", err)
}
if err := setDefaultSandboxName(cmd, defaultName); err != nil {
fmt.Fprintf(os.Stderr, "warning: could not set default sandbox: %v\n", err)
}
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


return resp, nil
},
Expand All @@ -185,7 +232,7 @@ var sandboxServiceURLRender = structured.PropertyList{
}

var sandboxServiceURLCommand = structured.Command[*sandboxServiceURLInput]{
Use: "service-url <name> --port <port>",
Use: "service-url [name] --port <port>",
Short: "Generate an authenticated URL for a sandbox HTTP service",
Long: `Generate an authenticated URL for an HTTP service running inside a sandbox.

Expand All @@ -195,7 +242,7 @@ the browser URL directly.
Examples:
langsmith sandbox service-url my-vm --port 8000
langsmith sandbox service-url my-vm --port 8000 --expires-in-seconds 3600`,
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Input: func(cmd *cobra.Command) *sandboxServiceURLInput {
in := &sandboxServiceURLInput{}
cmd.Flags().IntVar(&in.Port, "port", in.Port, "Port inside the sandbox")
Expand All @@ -215,6 +262,10 @@ Examples:
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

params := langsmith.SandboxBoxGenerateServiceURLParams{
Port: langsmith.F(int64(in.Port)),
Expand All @@ -223,7 +274,7 @@ Examples:
params.ExpiresInSeconds = langsmith.F(in.ExpiresInSeconds)
}

resp, err := c.SDK.Sandboxes.Boxes.GenerateServiceURL(ctx, args[0], params)
resp, err := c.SDK.Sandboxes.Boxes.GenerateServiceURL(ctx, name, params)
if err != nil {
return nil, fmt.Errorf("generating service URL: %w", err)
}
Expand Down Expand Up @@ -263,16 +314,20 @@ var sandboxListCommand = structured.Command[struct{}]{
}

var sandboxGetCommand = structured.Command[struct{}]{
Use: "get <name>",
Use: "get [name]",
Short: "Get a sandbox by name",
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Action: func(ctx context.Context, cmd *cobra.Command, in struct{}, args []string) (any, error) {
c, err := cmdutil.GetClient(cmd)
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

resp, err := c.SDK.Sandboxes.Boxes.Get(ctx, args[0])
resp, err := c.SDK.Sandboxes.Boxes.Get(ctx, name)
if err != nil {
return nil, fmt.Errorf("getting sandbox: %w", err)
}
Expand All @@ -290,7 +345,7 @@ type sandboxUpdateInput struct {
}

var sandboxUpdateCommand = structured.Command[*sandboxUpdateInput]{
Use: "update <name>",
Use: "update [name]",
Short: "Update sandbox resources (takes effect on next start)",
Long: `Update sandbox resources or proxy configuration.

Expand All @@ -299,7 +354,7 @@ Proxy config changes take effect immediately.

The --proxy-config flag accepts inline JSON or @file.json. See "create --help"
for the proxy config JSON format.`,
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Input: func(cmd *cobra.Command) *sandboxUpdateInput {
in := &sandboxUpdateInput{}
cmd.Flags().IntVar(&in.VCPUs, "vcpus", in.VCPUs, "Number of vCPU cores")
Expand All @@ -313,6 +368,10 @@ for the proxy config JSON format.`,
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

params := langsmith.SandboxBoxUpdateParams{}
if cmd.Flags().Changed("vcpus") {
Expand Down Expand Up @@ -344,7 +403,7 @@ for the proxy config JSON format.`,
return nil, fmt.Errorf("nothing to update (use --vcpus, --memory, --rootfs-capacity, or --proxy-config)")
}

resp, err := c.SDK.Sandboxes.Boxes.Update(ctx, args[0], params)
resp, err := c.SDK.Sandboxes.Boxes.Update(ctx, name, params)
if err != nil {
return nil, fmt.Errorf("updating sandbox: %w", err)
}
Expand All @@ -355,63 +414,75 @@ for the proxy config JSON format.`,
}

var sandboxDeleteCommand = structured.Command[struct{}]{
Use: "delete <name>",
Use: "delete [name]",
Short: "Delete a sandbox",
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Action: func(ctx context.Context, cmd *cobra.Command, in struct{}, args []string) (any, error) {
c, err := cmdutil.GetClient(cmd)
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

if err := c.SDK.Sandboxes.Boxes.Delete(ctx, args[0]); err != nil {
if err := c.SDK.Sandboxes.Boxes.Delete(ctx, name); err != nil {
return nil, fmt.Errorf("deleting sandbox: %w", err)
}

return sandboxMessage{Name: args[0], Message: "Sandbox deleted."}, nil
return sandboxMessage{Name: name, Message: fmt.Sprintf("Sandbox %s deleted.", name)}, nil
},
Render: structured.Template(`{{.Message}}
`),
}

var sandboxStartCommand = structured.Command[struct{}]{
Use: "start <name>",
Use: "start [name]",
Short: "Start a stopped sandbox",
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Action: func(ctx context.Context, cmd *cobra.Command, in struct{}, args []string) (any, error) {
c, err := cmdutil.GetClient(cmd)
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

if _, err := c.SDK.Sandboxes.Boxes.Start(ctx, args[0]); err != nil {
if _, err := c.SDK.Sandboxes.Boxes.Start(ctx, name); err != nil {
return nil, fmt.Errorf("starting sandbox: %w", err)
}

if _, err := waitForBoxReady(ctx, c, args[0]); err != nil {
if _, err := waitForBoxReady(ctx, c, name); err != nil {
return nil, err
}
return sandboxMessage{Name: args[0], Message: fmt.Sprintf("Sandbox %s started", args[0])}, nil
return sandboxMessage{Name: name, Message: fmt.Sprintf("Sandbox %s started", name)}, nil
},
Render: structured.Template(`{{.Message}}
`),
}

var sandboxStopCommand = structured.Command[struct{}]{
Use: "stop <name>",
Use: "stop [name]",
Short: "Stop a running sandbox (preserves data)",
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Action: func(ctx context.Context, cmd *cobra.Command, in struct{}, args []string) (any, error) {
c, err := cmdutil.GetClient(cmd)
if err != nil {
return nil, err
}
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}

if err := c.SDK.Sandboxes.Boxes.Stop(ctx, args[0]); err != nil {
if err := c.SDK.Sandboxes.Boxes.Stop(ctx, name); err != nil {
return nil, fmt.Errorf("stopping sandbox: %w", err)
}

return sandboxMessage{Name: args[0], Message: "Sandbox stopped."}, nil
return sandboxMessage{Name: name, Message: fmt.Sprintf("Sandbox %s stopped.", name)}, nil
},
Render: structured.Template(`{{.Message}}
`),
Expand All @@ -420,7 +491,7 @@ var sandboxStopCommand = structured.Command[struct{}]{
type sandboxExecInput struct{}

var sandboxExecCommand = structured.Command[sandboxExecInput]{
Use: "exec <name> -- <command>",
Use: "exec [name] -- <command>",
Short: "Execute a command inside a sandbox",
Long: `Execute a one-off command inside a running sandbox and print its output.

Expand All @@ -432,11 +503,19 @@ Examples:
Input: func(cmd *cobra.Command) sandboxExecInput { return sandboxExecInput{} },
CustomOutput: true,
Action: func(ctx context.Context, cmd *cobra.Command, in sandboxExecInput, args []string) (any, error) {
name := args[0]

cmdArgs := cmd.ArgsLenAtDash()
if cmdArgs < 0 || cmdArgs >= len(args) {
return nil, fmt.Errorf("usage: langsmith sandbox exec <name> -- <command>")
return nil, fmt.Errorf("usage: langsmith sandbox exec [name] -- <command>")
}
var name string
var err error
if cmdArgs == 0 {
name, err = defaultSandboxName(cmd)
} else {
name = args[0]
}
if err != nil {
return nil, err
}
command := args[cmdArgs:]
if len(command) == 0 {
Expand Down
10 changes: 7 additions & 3 deletions internal/cmd/sandbox_console.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type sandboxConsoleInput struct {
}

var sandboxConsoleCommand = structured.Command[*sandboxConsoleInput]{
Use: "console <name>",
Use: "console [name]",
Short: "Open an interactive shell inside a sandbox",
Long: `Open an interactive terminal session inside a running sandbox.

Expand All @@ -34,7 +34,7 @@ Examples:
langsmith sandbox console my-vm
langsmith sandbox console my-vm --shell /bin/sh
langsmith sandbox console my-vm --forward-ssh-agent`,
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
Input: func(cmd *cobra.Command) *sandboxConsoleInput {
in := &sandboxConsoleInput{}
cmd.Flags().StringVar(&in.Shell, "shell", in.Shell, "Shell to use (default: sandbox default, usually /bin/bash)")
Expand All @@ -43,7 +43,11 @@ Examples:
},
CustomOutput: true,
Action: func(ctx context.Context, cmd *cobra.Command, in *sandboxConsoleInput, args []string) (any, error) {
return nil, runConsole(args[0], in.Shell, in.ForwardSSHAgent)
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}
return nil, runConsole(name, in.Shell, in.ForwardSSHAgent)
},
}

Expand Down
10 changes: 7 additions & 3 deletions internal/cmd/sandbox_console_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@ import (
)

var sandboxConsoleCommand = structured.Command[struct{}]{
Use: "console <name>",
Use: "console [name]",
Short: "Open an interactive shell inside a sandbox (not supported on Windows)",
Args: cobra.ExactArgs(1),
Args: cobra.MaximumNArgs(1),
CustomOutput: true,
Action: func(ctx context.Context, cmd *cobra.Command, in struct{}, args []string) (any, error) {
return nil, fmt.Errorf("sandbox console is not supported on Windows; use SSH instead: langsmith sandbox ssh-setup %s", args[0])
name, err := resolveSandboxName(cmd, args)
if err != nil {
return nil, err
}
return nil, fmt.Errorf("sandbox console is not supported on Windows; use SSH instead: langsmith sandbox ssh-setup %s", name)
},
}

Expand Down
10 changes: 7 additions & 3 deletions internal/cmd/sandbox_snapshot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,18 @@ fresh checkpoint from the running VM's current state.
Args: cobra.ExactArgs(1),
Input: func(cmd *cobra.Command) *snapshotCaptureInput {
in := &snapshotCaptureInput{}
cmd.Flags().StringVar(&in.BoxName, "box", in.BoxName, "Sandbox name to capture from (required)")
cmd.Flags().StringVar(&in.BoxName, "box", in.BoxName, "Sandbox name to capture from (defaults to profile default sandbox)")
cmd.Flags().StringVar(&in.Checkpoint, "checkpoint", in.Checkpoint, "Checkpoint timestamp to use (omit for fresh checkpoint)")
return in
},
Action: func(ctx context.Context, cmd *cobra.Command, in *snapshotCaptureInput, args []string) (any, error) {
name := args[0]
if in.BoxName == "" {
return nil, fmt.Errorf("--box is required")
boxName, err := defaultSandboxName(cmd)
if err != nil {
return nil, err
}
in.BoxName = boxName
}

c, err := cmdutil.GetClient(cmd)
Expand Down Expand Up @@ -225,7 +229,7 @@ var snapshotDeleteCommand = structured.Command[struct{}]{
return nil, fmt.Errorf("deleting snapshot: %w", err)
}

return sandboxMessage{Name: args[0], Message: "Snapshot deleted."}, nil
return sandboxMessage{Name: args[0], Message: fmt.Sprintf("Snapshot %s deleted.", args[0])}, nil
},
Render: structured.Template(`{{.Message}}
`),
Expand Down
Loading
Loading