Sandbox

The Daytona SDK core Sandbox functionality.

Provides the main Workspace class representing a Daytona Sandbox that coordinates file system, Git, process execution, and LSP functionality. It serves as the central point for interacting with Daytona Sandboxes.

The Sandbox must be in a ‘started’ state before performing operations.

Example

// Create and initialize workspace
const daytona = new Daytona();
const workspace = await daytona.create();

// File operations
await workspace.fs.uploadFile(
  '/app/config.json',
  new File(['{"setting": "value"}'], 'config.json')
);
const contentBlob = await workspace.fs.downloadFile('/app/config.json');

// Git operations
await workspace.git.clone('https://github.com/user/repo.git');

// Process execution
const response = await workspace.process.executeCommand('ls -la');
console.log(response.result);

// LSP functionality
const lsp = workspace.createLspServer('typescript', '/workspace/project');
await lsp.didOpen('/workspace/project/src/index.ts');
const completions = await lsp.completions('/workspace/project/src/index.ts', {
  line: 10,
  character: 15
});
console.log(completions);

Workspace

[view_source]

Represents a Daytona Sandbox.

A Sandbox provides file system operations, Git operations, process execution, and LSP functionality. It serves as the main interface for interacting with a Daytona workspace.

Constructors

new Workspace()

new Workspace(
   id: string,
   instance: Workspace,
   workspaceApi: WorkspaceApi,
   toolboxApi: ToolboxApi,
   codeToolbox: WorkspaceCodeToolbox): Workspace

[view_source]

Creates a new Sandbox instance

Parameters

Returns

Workspace

Properties

Methods

createLspServer()

createLspServer(languageId: LspLanguageId, pathToProject: string): LspServer

[view_source]

Creates a new Language Server Protocol (LSP) server instance.

The LSP server provides language-specific features like code completion, diagnostics, and more.

Parameters

Returns

LspServer

A new LSP server instance configured for the specified language

Example

const lsp = workspace.createLspServer('typescript', '/workspace/project');

delete()

delete(): Promise<void>

[view_source]

Deletes the Sandbox.

Returns

Promise<void>

getWorkspaceRootDir()

getWorkspaceRootDir(): Promise<undefined | string>

[view_source]

Gets the root directory path of the Sandbox.

Returns

Promise<undefined | string>

The absolute path to the Sandbox root directory

Example

const rootDir = await workspace.getWorkspaceRootDir();
console.log(`Workspace root: ${rootDir}`);

info()

info(): Promise<WorkspaceInfo>

[view_source]

Gets structured information about the Sandbox.

Returns

Promise<WorkspaceInfo>

Detailed information about the Sandbox including its configuration, resources, and current state

Example

const info = await workspace.info();
console.log(`Workspace ${info.name}:`);
console.log(`State: ${info.state}`);
console.log(`Resources: ${info.resources.cpu} CPU, ${info.resources.memory} RAM`);

setAutostopInterval()

setAutostopInterval(interval: number): Promise<void>

[view_source]

Set the auto-stop interval for the Sandbox.

The Sandbox will automatically stop after being idle (no new events) for the specified interval. Events include any state changes or interactions with the Sandbox through the sdk. Interactions using Sandbox Previews are not included.

Parameters

Returns

Promise<void>

Throws

• Error - If interval is not a non-negative integer

Example

// Auto-stop after 1 hour
await workspace.setAutostopInterval(60);
// Or disable auto-stop
await workspace.setAutostopInterval(0);

setLabels()

setLabels(labels: Record<string, string>): Promise<void>

[view_source]

Sets labels for the Sandbox.

Labels are key-value pairs that can be used to organize and identify Sandboxes.

Parameters

Returns

Promise<void>

Example

// Set workspace labels
await workspace.setLabels({
  project: 'my-project',
  environment: 'development',
  team: 'backend'
});

start()

start(timeout?: number): Promise<void>

[view_source]

Start the Sandbox.

This method starts the Sandbox and waits for it to be ready.

Parameters

Returns

Promise<void>

Throws

• Error - If Sandbox fails to start or times out

Example

const workspace = await daytona.getCurrentWorkspace('my-workspace');
await workspace.start(40);  // Wait up to 40 seconds
console.log('Workspace started successfully');

stop()

stop(): Promise<void>

[view_source]

Stops the Sandbox.

This method stops the Sandbox and waits for it to be fully stopped.

Returns

Promise<void>

Example

const workspace = await daytona.getCurrentWorkspace('my-workspace');
await workspace.stop();
console.log('Workspace stopped successfully');

waitUntilStarted()

waitUntilStarted(timeout?: number): Promise<void>

[view_source]

Waits for the Sandbox to reach the ‘started’ state.

This method polls the Sandbox status until it reaches the ‘started’ state or encounters an error.

Parameters

Returns

Promise<void>

Throws

• Error - If timeout is negative

• Error - If Sandbox fails to start or times out

• Error - If Sandbox fails to become ready within the timeout period

waitUntilStopped()

waitUntilStopped(): Promise<void>

[view_source]

Wait for Sandbox to reach ‘stopped’ state.

This method polls the Sandbox status until it reaches the ‘stopped’ state or encounters an error. It will wait up to 60 seconds for the Sandbox to stop.

Returns

Promise<void>

Throws

• Error - If Sandbox fails to stop or times out

WorkspaceCodeToolbox

[view_source]

Interface defining methods that a code toolbox must implement WorkspaceCodeToolbox

Methods

getRunCommand()

getRunCommand(code: string): string

[view_source]

Generates a command to run the provided code

Parameters

Returns

string

WorkspaceInfo

[view_source]

Structured information about a Sandbox

This interface provides detailed information about a Sandbox’s configuration, resources, and current state.

WorkspaceInfo

Example

const workspace = await daytona.create();
const info = await workspace.info();
console.log(`Workspace ${info.name} is ${info.state}`);
console.log(`Resources: ${info.resources.cpu} CPU, ${info.resources.memory} RAM`);

Properties

WorkspaceResources

[view_source]

Resources allocated to a Sandbox

WorkspaceResources

Example

const resources: WorkspaceResources = {
  cpu: "2",
  gpu: "1",
  memory: "4Gi",
  disk: "20Gi"
};

Properties