Skip to content
Simple Chainguard Sandbox SDK
Search
Ctrl K
Esc
GitHub
Menu
Get Started
Overview
Quickstart
Guides
Sandboxes
Commands
Files
Environments and Network
Errors
Authentication and Organizations
Background
Coming From Vercel, E2B or Modal
How It Works
API Reference
Overview
Python
TypeScript
Classes
CommandExitError
CommandHandle
Commands
FileNotFoundError
Filesystem
GitHubAppNotInstalledError
GitHubLinkRequiredError
InvalidPathError
LimitReachedError
NotFoundError
OutcomeUnknownError
Sandbox
SandboxBusyError
SandboxError
SandboxNotFoundError
TermsNotAcceptedError
TimeoutError
WorkspacesNotEnabledError
Interfaces
CommandResult
CommandStartOpts
ConnectOpts
EnableOpts
EntryInfo
Organization
ProcessInfo
SandboxInfo
SandboxOpts
SetupOpts
TermsDocument
WorkspacesStatus
WriteEntry
WriteInfo
Type Aliases
FileType
Variables
DEFAULT_COMMAND_TIMEOUT_MS
DEFAULT_PACKAGES
DEFAULT_WORKDIR
Functions
enableWorkspaces
environmentDocument
listOrganizations
workspacesStatus
Go
Rust
Protocol
Overview
Sessions
Exec
First Attach
Authentication and Organizations
Status Codes
Limits and Differences
GitHub
Interfaces
TermsDocument
A legal document an organization accepts.
Properties
Section titled “Properties”
id
Section titled “id”
id
:
string
label
Section titled “label”
label
:
string
url
Section titled “url”
url
:
string