Visitar URL original
Filesystem backend with unrestricted local shell command execution.
This backend extends FilesystemBackend to add shell command execution capabilities. Commands are executed directly on the host system without any sandboxing, process isolation, or security restrictions.
Security Warning: This backend grants agents BOTH direct filesystem access AND unrestricted shell execution on your local machine. Use with extreme caution and only in appropriate environments.
Appropriate use cases:
Inappropriate use cases:
Use StateBackend, StoreBackend, or extend BaseSandbox for production.
class LocalShellBackendimport { LocalShellBackend } from "@langchain/deepagents";
// Create backend with explicit environment
const backend = new LocalShellBackend({
rootDir: "/home/user/project",
virtualMode: true,
env: { PATH: "/usr/bin:/bin" },
});
// Execute shell commands (runs directly on host)
const result = await backend.execute("ls -la");
console.log(result.output);
console.log(result.exitCode);
// Use filesystem operations (inherited from FilesystemBackend)
const content = await backend.read("/README.md");
await backend.write("/output.txt", "Hello world");
// Inherit all environment variables
const backend2 = new LocalShellBackend({
rootDir: "/home/user/project",
virtualMode: true,
inheritEnv: true,
});Unique identifier for the sandbox backend instance
Mark the backend as no longer running.
For local shell backends there is no remote resource to tear down,
so this simply flips the isRunning / isInitialized flag.
Delete a file or directory from the filesystem.
Files are unlinked. Directories are removed recursively along with all of their contents. Symlinks are removed as links and never followed into their targets.
Download multiple files from the filesystem.
Edit a file, adapting error messages to the standard sandbox format.
Execute a shell command directly on the host system.
Commands are executed directly on your host system using spawn()
with shell: true. There is NO sandboxing, isolation, or security
restrictions. The command runs with your user's full permissions.
The command is executed using the system shell with the working directory
set to the backend's rootDir. Stdout and stderr are combined into a single
output stream, with stderr lines prefixed with [stderr].
Glob matching that returns relative paths and includes directories.
Search for a literal text pattern in files.
Uses ripgrep if available, falling back to substring search.
Initialize the backend by ensuring the rootDir exists.
Creates the rootDir (and any parent directories) if it does not already
exist. Safe to call on an existing directory. Must be called before
execute(), or use the static LocalShellBackend.create() factory.
List directory contents, returning paths relative to rootDir.
Read a file, adapting error messages to the standard sandbox format.
Read file content as raw FileData.
Upload multiple files to the filesystem.
Write content to a file, creating it or overwriting it if it already exists. Returns WriteResult. External storage sets filesUpdate=null.
Create and initialize a new LocalShellBackend in one step.
This is the recommended way to create a backend when the rootDir may not exist yet. It combines construction and initialization (ensuring rootDir exists) into a single async operation.
Delete a file or directory from the filesystem.
Download multiple files from the filesystem.
Edit a file by replacing string occurrences.
Structured glob matching returning FileInfo objects.
Search for a literal text pattern in files.
List files and directories in the specified directory (non-recursive).
Read file content with line numbers.
Read file content as raw FileData.
Upload multiple files to the filesystem.
Write content to a file, creating it or overwriting it if it already exists.