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
JavaScriptdeepagentsindexLocalShellBackendOptions
Interface●Since v1.8

LocalShellBackendOptions

Options for creating a LocalShellBackend instance.

Copy
interface LocalShellBackendOptions

Properties

property
env: Record<string, string>

Environment variables for shell commands. If undefined, starts with an empty environment (unless inheritEnv is true).

property
inheritEnv: boolean

Whether to inherit the parent process's environment variables. When false, only variables in env dict are available. When true, inherits all process.env variables and applies env overrides.

property
initialFiles: Record<string, string>

Files to create on disk during create(). Keys are file paths (resolved via the backend's path handling), values are string content.

property
maxOutputBytes: number

Maximum number of bytes to capture from command output. Output exceeding this limit will be truncated.

property
rootDir: string

Working directory for both filesystem operations and shell commands.

property
timeout: number

Maximum time in seconds to wait for shell command execution. Commands exceeding this timeout will be terminated.

property
virtualMode: boolean

Enable virtual path mode for filesystem operations. When true, treats rootDir as a virtual root filesystem. Does NOT restrict shell commands.

View source on GitHub