LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Agent
  • Middleware
  • Backends
  • Sandboxes
  • Skills
  • Subagents
  • Configuration
  • Types
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
  • Vitest
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewAgentMiddlewareBackendsSandboxesSkillsSubagentsConfigurationTypes
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
Vitest
Language
Theme
JavaScriptdeepagentsbackendsSandboxBackendProtocolV2
Interface●Since v1.8

SandboxBackendProtocolV2

Copy
interface SandboxBackendProtocolV2

Bases

BackendProtocolV2

Properties

Methods

Inherited fromBackendProtocolV2

Properties

PdownloadFiles: (paths: string[])PuploadFiles: (files: [string, Uint8Array<ArrayBufferLike>][])

Methods

Medit→ Promise<EditResult>
—

Edit a file by replacing string occurrences.

M
View source on GitHub
glob
→ Promise<GlobResult>
—

Structured glob matching returning FileInfo objects.

Mgrep→ Promise<GrepResult>
—

Search for a literal text pattern in files using grep.

Mls→ Promise<LsResult>
—

List files and directories in the specified directory (non-recursive).

Mread→ Promise<ReadResult>
—

Read file content with line numbers.

MreadRaw→ Promise<ReadRawResult>
—

Read file content as raw FileData.

Mwrite→ Promise<WriteResult>
—

Create a new file with content.

property
downloadFiles: (paths: string[]) => MaybePromise<FileDownloadResponse[]>
property
id: string
property
uploadFiles: (files: [string, Uint8Array<ArrayBufferLike>][]) => MaybePromise<FileUploadResponse[]>
method
edit→ Promise<EditResult>
method
execute→ MaybePromise<ExecuteResponse>
method
glob→ Promise<GlobResult>
method
grep→ Promise<GrepResult>
method
ls→ Promise<LsResult>
method
read→ Promise<ReadResult>
method
readRaw→ Promise<ReadRawResult>
method
write→ Promise<WriteResult>

Protocol for sandboxed backends with isolated runtime.

Key differences from SandboxBackendProtocol:

  • Extends BackendProtocolV2 instead of BackendProtocol
  • All methods return structured Result types for consistent error handling

Unique identifier for the sandbox backend

Edit a file by replacing string occurrences.

Uses downloadFiles() to read, performs string replacement in TypeScript, then uploadFiles() to write back. No runtime needed on the sandbox host.

Memory-conscious: releases intermediate references early so the GC can reclaim buffers before the next large allocation is made.

Execute a command in the sandbox. This is the only method concrete implementations must provide.

Structured glob matching returning FileInfo objects.

Uses pure POSIX shell (find + stat) via execute() to list all files, then applies glob-to-regex matching in TypeScript. No Python or Node.js needed on the sandbox host.

Glob patterns are matched against paths relative to the search base:

  • * matches any characters except /
  • ** matches any characters including / (recursive)
  • ? matches a single character except /
  • [...] character classes

Search for a literal text pattern in files using grep.

List files and directories in the specified directory (non-recursive).

Uses pure POSIX shell (find + stat) via execute() — works on any Linux including Alpine. No Python or Node.js needed.

Read file content with line numbers.

Uses pure POSIX shell (awk) via execute() — only the requested slice is returned over the wire, making this efficient for large files. Works on any Linux including Alpine (no Python or Node.js needed).

Read file content as raw FileData.

Uses downloadFiles() directly — no runtime needed on the sandbox host.

Create a new file with content.

Uses downloadFiles() to check existence and uploadFiles() to write. No runtime needed on the sandbox host.