Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

[skip ci] Release new versions

github-actions[bot]86cc7edb6971
diff --git a/.changeset/green-adults-hug.md b/.changeset/green-adults-hug.md
deleted file mode 100644
index 3ced6e897..000000000
--- a/.changeset/green-adults-hug.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'e2b': patch
----
-
-Add writeFiles function to sync with Python SDK
diff --git a/apps/web/package.json b/apps/web/package.json
index 16f8ee233..851d9d925 100644
--- a/apps/web/package.json
+++ b/apps/web/package.json
@@ -42,7 +42,7 @@
"autoprefixer": "^10.4.7",
"class-variance-authority": "^0.7.0",
"clsx": "^1.2.1",
- "e2b": "^2.10.3",
+ "e2b": "^2.10.4",
"fast-glob": "^3.3.0",
"fast-xml-parser": "4.4.1",
"flexsearch": "^0.7.31",
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/commands/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/commands/page.mdx
new file mode 100644
index 000000000..6187a90f2
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/commands/page.mdx
@@ -0,0 +1,549 @@
+### Commands
+
+Module for starting and interacting with commands in the sandbox.
+
+#### Constructors
+
+```ts
+new Commands(
+ transport: Transport,
+ connectionConfig: ConnectionConfig,
+ metadata: object): Commands
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `transport` | `Transport` |
+| `connectionConfig` | `ConnectionConfig` |
+| `metadata` | `object` |
+| `metadata.version` | `string` |
+
+###### Returns
+
+`Commands`
+
+#### Methods
+
+### connect()
+
+```ts
+connect(pid: number, opts?: CommandConnectOpts): Promise<CommandHandle>
+```
+
+Connect to a running command.
+You can use CommandHandle.wait to wait for the command to finish and get execution results.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. |
+| `opts`? | `CommandConnectOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`CommandHandle`\>
+
+`CommandHandle` handle to interact with the running command.
+
+### kill()
+
+```ts
+kill(pid: number, opts?: CommandRequestOpts): Promise<boolean>
+```
+
+Kill a running command specified by its process ID.
+It uses `SIGKILL` signal to kill the command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. |
+| `opts`? | `CommandRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the command was killed, `false` if the command was not found.
+
+### list()
+
+```ts
+list(opts?: CommandRequestOpts): Promise<ProcessInfo[]>
+```
+
+List all running commands and PTY sessions.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `CommandRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`ProcessInfo`[]\>
+
+list of running commands and PTY sessions.
+
+### run()
+
+###### run(cmd, opts)
+
+```ts
+run(cmd: string, opts?: CommandStartOpts & object): Promise<CommandResult>
+```
+
+Start a new command and wait until it finishes executing.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cmd` | `string` | command to execute. |
+| `opts`? | `CommandStartOpts` & `object` | options for starting the command. |
+
+###### Returns
+
+`Promise`\<`CommandResult`\>
+
+`CommandResult` result of the command execution.
+
+###### run(cmd, opts)
+
+```ts
+run(cmd: string, opts: CommandStartOpts & object): Promise<CommandHandle>
+```
+
+Start a new command in the background.
+You can use CommandHandle.wait to wait for the command to finish and get its result.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cmd` | `string` | command to execute. |
+| `opts` | `CommandStartOpts` & `object` | options for starting the command |
+
+###### Returns
+
+`Promise`\<`CommandHandle`\>
+
+`CommandHandle` handle to interact with the running command.
+
+###### run(cmd, opts)
+
+```ts
+run(cmd: string, opts?: CommandStartOpts & object): Promise<CommandResult | CommandHandle>
+```
+
+Start a new command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cmd` | `string` | command to execute. |
+| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` |
+
+###### Returns
+
+`Promise`\<`CommandResult` \| `CommandHandle`\>
+
+Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`).
+
+### sendStdin()
+
+```ts
+sendStdin(
+ pid: number,
+ data: string,
+opts?: CommandRequestOpts): Promise<void>
+```
+
+Send data to command stdin.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. |
+| `data` | `string` | data to send to the command. |
+| `opts`? | `CommandRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### Pty
+
+Module for interacting with PTYs (pseudo-terminals) in the sandbox.
+
+#### Constructors
+
+```ts
+new Pty(
+ transport: Transport,
+ connectionConfig: ConnectionConfig,
+ metadata: object): Pty
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `transport` | `Transport` |
+| `connectionConfig` | `ConnectionConfig` |
+| `metadata` | `object` |
+| `metadata.version` | `string` |
+
+###### Returns
+
+`Pty`
+
+#### Methods
+
+### connect()
+
+```ts
+connect(pid: number, opts?: PtyConnectOpts): Promise<CommandHandle>
+```
+
+Connect to a running PTY.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the PTY to connect to. You can get the list of running PTYs using Commands.list. |
+| `opts`? | `PtyConnectOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`CommandHandle`\>
+
+handle to interact with the PTY.
+
+### create()
+
+```ts
+create(opts: PtyCreateOpts): Promise<CommandHandle>
+```
+
+Create a new PTY (pseudo-terminal).
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts` | `PtyCreateOpts` | options for creating the PTY. |
+
+###### Returns
+
+`Promise`\<`CommandHandle`\>
+
+handle to interact with the PTY.
+
+### kill()
+
+```ts
+kill(pid: number, opts?: Pick<ConnectionOpts, "requestTimeoutMs">): Promise<boolean>
+```
+
+Kill a running PTY specified by process ID.
+It uses `SIGKILL` signal to kill the PTY.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the PTY. |
+| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the PTY was killed, `false` if the PTY was not found.
+
+### resize()
+
+```ts
+resize(
+ pid: number,
+ size: object,
+opts?: Pick<ConnectionOpts, "requestTimeoutMs">): Promise<void>
+```
+
+Resize PTY.
+Call this when the terminal window is resized and the number of columns and rows has changed.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the PTY. |
+| `size` | `object` | new size of the PTY. |
+| `size.cols` | `number` | - |
+| `size.rows`? | `number` | - |
+| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### sendInput()
+
+```ts
+sendInput(
+ pid: number,
+ data: Uint8Array,
+opts?: Pick<ConnectionOpts, "requestTimeoutMs">): Promise<void>
+```
+
+Send input to a PTY.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `pid` | `number` | process ID of the PTY. |
+| `data` | `Uint8Array` | input data to send to the PTY. |
+| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+## Interfaces
+
+### CommandRequestOpts
+
+Options for sending a command request.
+
+#### Extended by
+
+- `CommandStartOpts`
+
+#### Properties
+
+### requestTimeoutMs?
+
+```ts
+optional requestTimeoutMs: number;
+```
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+***
+
+### CommandStartOpts
+
+Options for starting a new command.
+
+#### Properties
+
+### background?
+
+```ts
+optional background: boolean;
+```
+
+If true, starts command in the background and the method returns immediately.
+You can use CommandHandle.wait to wait for the command to finish.
+
+### cwd?
+
+```ts
+optional cwd: string;
+```
+
+Working directory for the command.
+
+###### Default
+
+```ts
+// home directory of the user used to start the command
+```
+
+### envs?
+
+```ts
+optional envs: Record<string, string>;
+```
+
+Environment variables used for the command.
+
+This overrides the default environment variables from `Sandbox` constructor.
+
+###### Default
+
+`{}`
+
+### onStderr()?
+
+```ts
+optional onStderr: (data: string) => void | Promise<void>;
+```
+
+Callback for command stderr output.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `string` |
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+### onStdout()?
+
+```ts
+optional onStdout: (data: string) => void | Promise<void>;
+```
+
+Callback for command stdout output.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `string` |
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+### requestTimeoutMs?
+
+```ts
+optional requestTimeoutMs: number;
+```
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### stdin?
+
+```ts
+optional stdin: boolean;
+```
+
+If true, command stdin is kept open and you can send data to it using Commands.sendStdin or CommandHandle.sendStdin.
+
+###### Default
+
+```ts
+false
+```
+
+### timeoutMs?
+
+```ts
+optional timeoutMs: number;
+```
+
+Timeout for the command in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### user?
+
+```ts
+optional user: string;
+```
+
+User to run the command as.
+
+###### Default
+
+`default Sandbox user (as specified in the template)`
+
+***
+
+### ProcessInfo
+
+Information about a command, PTY session or start command running in the sandbox as process.
+
+#### Properties
+
+### args
+
+```ts
+args: string[];
+```
+
+Command arguments.
+
+### cmd
+
+```ts
+cmd: string;
+```
+
+Command that was executed.
+
+### cwd?
+
+```ts
+optional cwd: string;
+```
+
+Executed command working directory.
+
+### envs
+
+```ts
+envs: Record<string, string>;
+```
+
+Environment variables used for the command.
+
+### pid
+
+```ts
+pid: number;
+```
+
+Process ID.
+
+### tag?
+
+```ts
+optional tag: string;
+```
+
+Custom tag used for identifying special commands like start command in the custom template.
+
+## Type Aliases
+
+### CommandConnectOpts
+
+```ts
+type CommandConnectOpts: Pick<CommandStartOpts, "onStderr" | "onStdout" | "timeoutMs"> & CommandRequestOpts;
+```
+
+Options for connecting to a command.
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/errors/page.mdx
new file mode 100644
index 000000000..a267c059e
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/errors/page.mdx
@@ -0,0 +1,266 @@
+### AuthenticationError
+
+Thrown when authentication fails.
+
+#### Constructors
+
+```ts
+new AuthenticationError(message: string): AuthenticationError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+
+###### Returns
+
+`AuthenticationError`
+
+***
+
+### BuildError
+
+Thrown when the build fails.
+
+#### Extended by
+
+- `FileUploadError`
+
+#### Constructors
+
+```ts
+new BuildError(message: string, stackTrace?: string): BuildError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`BuildError`
+
+***
+
+### FileUploadError
+
+Thrown when the file upload fails.
+
+#### Constructors
+
+```ts
+new FileUploadError(message: string, stackTrace?: string): FileUploadError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`FileUploadError`
+
+***
+
+### InvalidArgumentError
+
+Thrown when an invalid argument is provided.
+
+#### Constructors
+
+```ts
+new InvalidArgumentError(message: string, stackTrace?: string): InvalidArgumentError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`InvalidArgumentError`
+
+***
+
+### NotEnoughSpaceError
+
+Thrown when there is not enough disk space.
+
+#### Constructors
+
+```ts
+new NotEnoughSpaceError(message: string, stackTrace?: string): NotEnoughSpaceError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`NotEnoughSpaceError`
+
+***
+
+### NotFoundError
+
+Thrown when a resource is not found.
+
+#### Constructors
+
+```ts
+new NotFoundError(message: string, stackTrace?: string): NotFoundError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`NotFoundError`
+
+***
+
+### RateLimitError
+
+Thrown when the API rate limit is exceeded.
+
+#### Constructors
+
+```ts
+new RateLimitError(message: string): RateLimitError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+
+###### Returns
+
+`RateLimitError`
+
+***
+
+### SandboxError
+
+Base class for all sandbox errors.
+
+Thrown when general sandbox errors occur.
+
+#### Extended by
+
+- `TimeoutError`
+- `InvalidArgumentError`
+- `NotEnoughSpaceError`
+- `NotFoundError`
+- `TemplateError`
+- `RateLimitError`
+
+#### Constructors
+
+```ts
+new SandboxError(message?: string, stackTrace?: string): SandboxError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message`? | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`SandboxError`
+
+***
+
+### TemplateError
+
+Thrown when the template uses old envd version. It isn't compatible with the new SDK.
+
+#### Constructors
+
+```ts
+new TemplateError(message: string, stackTrace?: string): TemplateError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`TemplateError`
+
+***
+
+### TimeoutError
+
+Thrown when a timeout error occurs.
+
+The [unavailable] error type is caused by sandbox timeout.
+
+The [canceled] error type is caused by exceeding request timeout.
+
+The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc.
+
+The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.
+
+#### Constructors
+
+```ts
+new TimeoutError(message: string, stackTrace?: string): TimeoutError
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `stackTrace`? | `string` |
+
+###### Returns
+
+`TimeoutError`
+
+## Functions
+
+### formatSandboxTimeoutError()
+
+```ts
+function formatSandboxTimeoutError(message: string): TimeoutError
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+
+#### Returns
+
+`TimeoutError`
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/filesystem/page.mdx
new file mode 100644
index 000000000..b23d35552
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/filesystem/page.mdx
@@ -0,0 +1,649 @@
+### FileType
+
+Sandbox filesystem object type.
+
+#### Enumeration Members
+
+| Enumeration Member | Value | Description |
+| ------ | ------ | ------ |
+| `DIR` | `"dir"` | Filesystem object is a directory. |
+| `FILE` | `"file"` | Filesystem object is a file. |
+
+## Classes
+
+### Filesystem
+
+Module for interacting with the sandbox filesystem.
+
+#### Constructors
+
+```ts
+new Filesystem(
+ transport: Transport,
+ envdApi: EnvdApiClient,
+ connectionConfig: ConnectionConfig): Filesystem
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `transport` | `Transport` |
+| `envdApi` | `EnvdApiClient` |
+| `connectionConfig` | `ConnectionConfig` |
+
+###### Returns
+
+`Filesystem`
+
+#### Methods
+
+### exists()
+
+```ts
+exists(path: string, opts?: FilesystemRequestOpts): Promise<boolean>
+```
+
+Check if a file or a directory exists.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to a file or a directory |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the file or directory exists, `false` otherwise
+
+### getInfo()
+
+```ts
+getInfo(path: string, opts?: FilesystemRequestOpts): Promise<EntryInfo>
+```
+
+Get information about a file or directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to a file or directory. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+information about the file or directory like name, type, and path.
+
+### list()
+
+```ts
+list(path: string, opts?: FilesystemListOpts): Promise<EntryInfo[]>
+```
+
+List entries in a directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the directory. |
+| `opts`? | `FilesystemListOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`EntryInfo`[]\>
+
+list of entries in the sandbox filesystem directory.
+
+### makeDir()
+
+```ts
+makeDir(path: string, opts?: FilesystemRequestOpts): Promise<boolean>
+```
+
+Create a new directory and all directories along the way if needed on the specified path.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the directory was created, `false` if it already exists.
+
+### read()
+
+###### read(path, opts)
+
+```ts
+read(path: string, opts?: FilesystemRequestOpts & object): Promise<string>
+```
+
+Read file content as a `string`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the file. |
+| `opts`? | `FilesystemRequestOpts` & `object` | connection options. |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+file content as string
+
+###### read(path, opts)
+
+```ts
+read(path: string, opts?: FilesystemRequestOpts & object): Promise<Uint8Array>
+```
+
+Read file content as a `Uint8Array`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the file. |
+| `opts`? | `FilesystemRequestOpts` & `object` | connection options. |
+
+###### Returns
+
+`Promise`\<`Uint8Array`\>
+
+file content as `Uint8Array`
+
+###### read(path, opts)
+
+```ts
+read(path: string, opts?: FilesystemRequestOpts & object): Promise<Blob>
+```
+
+Read file content as a `Blob`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the file. |
+| `opts`? | `FilesystemRequestOpts` & `object` | connection options. |
+
+###### Returns
+
+`Promise`\<`Blob`\>
+
+file content as `Blob`
+
+###### read(path, opts)
+
+```ts
+read(path: string, opts?: FilesystemRequestOpts & object): Promise<ReadableStream<Uint8Array>>
+```
+
+Read file content as a `ReadableStream`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the file. |
+| `opts`? | `FilesystemRequestOpts` & `object` | connection options. |
+
+###### Returns
+
+`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+file content as `ReadableStream`
+
+### remove()
+
+```ts
+remove(path: string, opts?: FilesystemRequestOpts): Promise<void>
+```
+
+Remove a file or directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to a file or directory. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### rename()
+
+```ts
+rename(
+ oldPath: string,
+ newPath: string,
+opts?: FilesystemRequestOpts): Promise<EntryInfo>
+```
+
+Rename a file or directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `oldPath` | `string` | path to the file or directory to rename. |
+| `newPath` | `string` | new path for the file or directory. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+information about renamed file or directory.
+
+### watchDir()
+
+```ts
+watchDir(
+ path: string,
+ onEvent: (event: FilesystemEvent) => void | Promise<void>,
+opts?: WatchOpts & object): Promise<WatchHandle>
+```
+
+Start watching a directory for filesystem events.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to directory to watch. |
+| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. |
+| `opts`? | `WatchOpts` & `object` | connection options. |
+
+###### Returns
+
+`Promise`\<`WatchHandle`\>
+
+`WatchHandle` object for stopping watching directory.
+
+### write()
+
+###### write(path, data, opts)
+
+```ts
+write(
+ path: string,
+ data: string | ArrayBuffer | Blob | ReadableStream<any>,
+opts?: FilesystemRequestOpts): Promise<WriteInfo>
+```
+
+Write content to a file.
+
+Writing to a file that doesn't exist creates the file.
+
+Writing to a file that already exists overwrites the file.
+
+Writing to a file at path that doesn't exist creates the necessary directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to file. |
+| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`WriteInfo`\>
+
+information about the written file
+
+###### write(files, opts)
+
+```ts
+write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise<WriteInfo[]>
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `files` | `WriteEntry`[] |
+| `opts`? | `FilesystemRequestOpts` |
+
+###### Returns
+
+`Promise`\<`WriteInfo`[]\>
+
+### writeFiles()
+
+```ts
+writeFiles(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise<WriteInfo[]>
+```
+
+Write multiple files.
+
+Writing to a file that doesn't exist creates the file.
+
+Writing to a file that already exists overwrites the file.
+
+Writing to a file at path that doesn't exist creates the necessary directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `files` | `WriteEntry`[] | list of files to write as `WriteEntry` objects, each containing `path` and `data`. |
+| `opts`? | `FilesystemRequestOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`WriteInfo`[]\>
+
+information about the written files
+
+## Interfaces
+
+### EntryInfo
+
+Sandbox filesystem object information.
+
+#### Properties
+
+### group
+
+```ts
+group: string;
+```
+
+Group owner of the filesystem object.
+
+### mode
+
+```ts
+mode: number;
+```
+
+File mode and permission bits.
+
+### modifiedTime?
+
+```ts
+optional modifiedTime: Date;
+```
+
+Last modification time of the filesystem object.
+
+### name
+
+```ts
+name: string;
+```
+
+Name of the filesystem object.
+
+### owner
+
+```ts
+owner: string;
+```
+
+Owner of the filesystem object.
+
+### path
+
+```ts
+path: string;
+```
+
+Path to the filesystem object.
+
+### permissions
+
+```ts
+permissions: string;
+```
+
+String representation of file permissions (e.g. 'rwxr-xr-x').
+
+### size
+
+```ts
+size: number;
+```
+
+Size of the filesystem object in bytes.
+
+### symlinkTarget?
+
+```ts
+optional symlinkTarget: string;
+```
+
+If the filesystem object is a symlink, this is the target of the symlink.
+
+### type?
+
+```ts
+optional type: FileType;
+```
+
+Type of the filesystem object.
+
+***
+
+### FilesystemListOpts
+
+Options for the sandbox filesystem operations.
+
+#### Properties
+
+### depth?
+
+```ts
+optional depth: number;
+```
+
+Depth of the directory to list.
+
+### requestTimeoutMs?
+
+```ts
+optional requestTimeoutMs: number;
+```
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### user?
+
+```ts
+optional user: string;
+```
+
+User to use for the operation in the sandbox.
+This affects the resolution of relative paths and ownership of the created filesystem objects.
+
+***
+
+### FilesystemRequestOpts
+
+Options for the sandbox filesystem operations.
+
+#### Extended by
+
+- `FilesystemListOpts`
+- `WatchOpts`
+
+#### Properties
+
+### requestTimeoutMs?
+
+```ts
+optional requestTimeoutMs: number;
+```
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### user?
+
+```ts
+optional user: string;
+```
+
+User to use for the operation in the sandbox.
+This affects the resolution of relative paths and ownership of the created filesystem objects.
+
+***
+
+### WatchOpts
+
+Options for watching a directory.
+
+#### Properties
+
+### onExit()?
+
+```ts
+optional onExit: (err?: Error) => void | Promise<void>;
+```
+
+Callback to call when the watch operation stops.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `err`? | `Error` |
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+### recursive?
+
+```ts
+optional recursive: boolean;
+```
+
+Watch the directory recursively
+
+### requestTimeoutMs?
+
+```ts
+optional requestTimeoutMs: number;
+```
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### timeoutMs?
+
+```ts
+optional timeoutMs: number;
+```
+
+Timeout for the watch operation in **milliseconds**.
+You can pass `0` to disable the timeout.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+### user?
+
+```ts
+optional user: string;
+```
+
+User to use for the operation in the sandbox.
+This affects the resolution of relative paths and ownership of the created filesystem objects.
+
+***
+
+### WriteInfo
+
+Sandbox filesystem object information.
+
+#### Extended by
+
+- `EntryInfo`
+
+#### Properties
+
+### name
+
+```ts
+name: string;
+```
+
+Name of the filesystem object.
+
+### path
+
+```ts
+path: string;
+```
+
+Path to the filesystem object.
+
+### type?
+
+```ts
+optional type: FileType;
+```
+
+Type of the filesystem object.
+
+## Type Aliases
+
+### WriteEntry
+
+```ts
+type WriteEntry: object;
+```
+
+#### Type declaration
+
+| Name | Type |
+| ------ | ------ |
+| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` |
+| `path` | `string` |
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/sandbox/page.mdx
new file mode 100644
index 000000000..afd10b84d
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/sandbox/page.mdx
@@ -0,0 +1,706 @@
+### Sandbox
+
+E2B cloud sandbox is a secure and isolated cloud environment.
+
+The sandbox allows you to:
+- Access Linux OS
+- Create, list, and delete files and directories
+- Run commands
+- Run isolated code
+- Access the internet
+
+Check docs here.
+
+Use Sandbox.create to create a new sandbox.
+
+#### Example
+
+```ts
+import { Sandbox } from 'e2b'
+
+const sandbox = await Sandbox.create()
+```
+
+#### Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox |
+| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem |
+| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals |
+| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. |
+| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. |
+| `trafficAccessToken?` | `readonly` | `string` | Traffic access token for accessing sandbox services with restricted public traffic. |
+
+#### Methods
+
+### betaPause()
+
+```ts
+betaPause(opts?: ConnectionOpts): Promise<boolean>
+```
+
+**`Beta`**
+
+This feature is in beta and may change in the future.
+
+Pause a sandbox by its ID.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `ConnectionOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+sandbox ID that can be used to resume the sandbox.
+
+### connect()
+
+```ts
+connect(opts?: SandboxBetaCreateOpts): Promise<Sandbox>
+```
+
+Connect to a sandbox. If the sandbox is paused, it will be automatically resumed.
+Sandbox must be either running or be paused.
+
+With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `SandboxBetaCreateOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`Sandbox`\>
+
+A running sandbox instance
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+await sandbox.betaPause()
+
+// Connect to the same sandbox.
+const sameSandbox = await sandbox.connect()
+```
+
+### downloadUrl()
+
+```ts
+downloadUrl(path: string, opts?: SandboxUrlOpts): Promise<string>
+```
+
+Get the URL to download a file from the sandbox.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | path to the file in the sandbox. |
+| `opts`? | `SandboxUrlOpts` | download url options. |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+URL for downloading file.
+
+### getHost()
+
+```ts
+getHost(port: number): string
+```
+
+Get the host address for the specified sandbox port.
+You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `port` | `number` | number of the port in the sandbox. |
+
+###### Returns
+
+`string`
+
+host address of the sandbox port.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+// Start an HTTP server
+await sandbox.commands.exec('python3 -m http.server 3000')
+// Get the hostname of the HTTP server
+const serverURL = sandbox.getHost(3000)
+```
+
+### getInfo()
+
+```ts
+getInfo(opts?: Pick<SandboxOpts, "requestTimeoutMs">): Promise<SandboxInfo>
+```
+
+Get sandbox information like sandbox ID, template, metadata, started at/end at date.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`SandboxInfo`\>
+
+information about the sandbox
+
+### getMcpToken()
+
+```ts
+getMcpToken(): Promise<undefined | string>
+```
+
+Get the MCP token for the sandbox.
+
+###### Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+MCP token for the sandbox, or undefined if MCP is not enabled.
+
+### getMcpUrl()
+
+```ts
+getMcpUrl(): string
+```
+
+Get the MCP URL for the sandbox.
+
+###### Returns
+
+`string`
+
+MCP URL for the sandbox.
+
+### getMetrics()
+
+```ts
+getMetrics(opts?: SandboxMetricsOpts): Promise<SandboxMetrics[]>
+```
+
+Get the metrics of the sandbox.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `SandboxMetricsOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`SandboxMetrics`[]\>
+
+List of sandbox metrics containing CPU, memory and disk usage information.
+
+### isRunning()
+
+```ts
+isRunning(opts?: Pick<ConnectionOpts, "requestTimeoutMs">): Promise<boolean>
+```
+
+Check if the sandbox is running.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the sandbox is running, `false` otherwise.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+await sandbox.isRunning() // Returns true
+
+await sandbox.kill()
+await sandbox.isRunning() // Returns false
+```
+
+### kill()
+
+```ts
+kill(opts?: Pick<SandboxOpts, "requestTimeoutMs">): Promise<void>
+```
+
+Kill the sandbox.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### setTimeout()
+
+```ts
+setTimeout(timeoutMs: number, opts?: Pick<SandboxOpts, "requestTimeoutMs">): Promise<void>
+```
+
+Set the timeout of the sandbox.
+
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`.
+Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `timeoutMs` | `number` | timeout in **milliseconds**. |
+| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### uploadUrl()
+
+```ts
+uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise<string>
+```
+
+Get the URL to upload a file to the sandbox.
+
+You have to send a POST request to this URL with the file as multipart/form-data.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path`? | `string` | path to the file in the sandbox. |
+| `opts`? | `SandboxUrlOpts` | download url options. |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+URL for uploading file.
+
+### betaCreate()
+
+###### betaCreate(this, opts)
+
+```ts
+static betaCreate<S>(this: S, opts?: SandboxBetaCreateOpts): Promise<InstanceType<S>>
+```
+
+**`Beta`**
+
+This feature is in beta and may change in the future.
+
+Create a new sandbox from the default `base` sandbox template.
+
+###### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `S` *extends* *typeof* `Sandbox` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `this` | `S` | - |
+| `opts`? | `SandboxBetaCreateOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.betaCreate()
+```
+
+###### Constructs
+
+Sandbox
+
+###### betaCreate(this, template, opts)
+
+```ts
+static betaCreate<S>(
+ this: S,
+ template: string,
+opts?: SandboxBetaCreateOpts): Promise<InstanceType<S>>
+```
+
+**`Beta`**
+
+This feature is in beta and may change in the future.
+
+Create a new sandbox from the specified sandbox template.
+
+###### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `S` *extends* *typeof* `Sandbox` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `this` | `S` | - |
+| `template` | `string` | sandbox template name or ID. |
+| `opts`? | `SandboxBetaCreateOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.betaCreate('<template-name-or-id>')
+```
+
+###### Constructs
+
+Sandbox
+
+### betaPause()
+
+```ts
+static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise<boolean>
+```
+
+Pause the sandbox specified by sandbox ID.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sandboxId` | `string` | sandbox ID. |
+| `opts`? | `SandboxApiOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the sandbox got paused, `false` if the sandbox was already paused.
+
+### connect()
+
+```ts
+static connect<S>(
+ this: S,
+ sandboxId: string,
+opts?: SandboxConnectOpts): Promise<InstanceType<S>>
+```
+
+Connect to a sandbox. If the sandbox is paused, it will be automatically resumed.
+Sandbox must be either running or be paused.
+
+With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+
+###### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `S` *extends* *typeof* `Sandbox` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `this` | `S` | - |
+| `sandboxId` | `string` | sandbox ID. |
+| `opts`? | `SandboxConnectOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+A running sandbox instance
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+const sandboxId = sandbox.sandboxId
+
+// Connect to the same sandbox.
+const sameSandbox = await Sandbox.connect(sandboxId)
+```
+
+### create()
+
+###### create(this, opts)
+
+```ts
+static create<S>(this: S, opts?: SandboxOpts): Promise<InstanceType<S>>
+```
+
+Create a new sandbox from the default `base` sandbox template.
+
+###### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `S` *extends* *typeof* `Sandbox` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `this` | `S` | - |
+| `opts`? | `SandboxOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+```
+
+###### Constructs
+
+Sandbox
+
+###### create(this, template, opts)
+
+```ts
+static create<S>(
+ this: S,
+ template: string,
+opts?: SandboxOpts): Promise<InstanceType<S>>
+```
+
+Create a new sandbox from the specified sandbox template.
+
+###### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `S` *extends* *typeof* `Sandbox` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `this` | `S` | - |
+| `template` | `string` | sandbox template name or ID. |
+| `opts`? | `SandboxOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create('<template-name-or-id>')
+```
+
+###### Constructs
+
+Sandbox
+
+### getFullInfo()
+
+```ts
+static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise<object>
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sandboxId` | `string` |
+| `opts`? | `SandboxApiOpts` |
+
+###### Returns
+
+`Promise`\<`object`\>
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| `cpuCount` | `number` | res.data.cpuCount |
+| `endAt` | `Date` | - |
+| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken |
+| `envdVersion` | `string` | res.data.envdVersion |
+| `memoryMB` | `number` | res.data.memoryMB |
+| `metadata` | `object` | - |
+| `name`? | `string` | res.data.alias |
+| `sandboxDomain` | `undefined` \| `string` | - |
+| `sandboxId` | `string` | res.data.sandboxID |
+| `startedAt` | `Date` | - |
+| `state` | `"running"` \| `"paused"` | res.data.state |
+| `templateId` | `string` | res.data.templateID |
+
+### getInfo()
+
+```ts
+static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise<SandboxInfo>
+```
+
+Get sandbox information like sandbox ID, template, metadata, started at/end at date.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sandboxId` | `string` | sandbox ID. |
+| `opts`? | `SandboxApiOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`SandboxInfo`\>
+
+sandbox information.
+
+### getMetrics()
+
+```ts
+static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise<SandboxMetrics[]>
+```
+
+Get the metrics of the sandbox.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sandboxId` | `string` | sandbox ID. |
+| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. |
+
+###### Returns
+
+`Promise`\<`SandboxMetrics`[]\>
+
+List of sandbox metrics containing CPU, memory and disk usage information.
+
+### kill()
+
+```ts
+static kill(sandboxId: string, opts?: SandboxApiOpts): Promise<boolean>
+```
+
+Kill the sandbox specified by sandbox ID.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sandboxId` | `string` | sandbox ID. |
+| `opts`? | `SandboxApiOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the sandbox was found and killed, `false` otherwise.
+
+### list()
+
+```ts
+static list(opts?: SandboxListOpts): SandboxPaginator
+```
+
+List all sandboxes.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `opts`? | `SandboxListOpts` | connection options. |
+
+###### Returns
+
+`SandboxPaginator`
+
+paginator for listing sandboxes.
+
+### setTimeout()
+
+```ts
+static setTimeout(
+ sandboxId: string,
+ timeoutMs: number,
+opts?: SandboxApiOpts): Promise<void>
+```
+
+Set the timeout of the specified sandbox.
+After the timeout expires the sandbox will be automatically killed.
+
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout.
+
+Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sandboxId` | `string` | sandbox ID. |
+| `timeoutMs` | `number` | timeout in **milliseconds**. |
+| `opts`? | `SandboxApiOpts` | connection options. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+## Interfaces
+
+### SandboxUrlOpts
+
+Options for sandbox upload/download URL generation.
+
+#### Properties
+
+### user?
+
+```ts
+optional user: string;
+```
+
+User that will be used to access the file.
+
+### useSignatureExpiration?
+
+```ts
+optional useSignatureExpiration: number;
+```
+
+Use signature expiration for the URL.
+Optional parameter to set the expiration time for the signature in seconds.
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/logger/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/logger/page.mdx
new file mode 100644
index 000000000..950551c97
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/logger/page.mdx
@@ -0,0 +1,191 @@
+### LogEntry
+
+Represents a single log entry from the template build process.
+
+#### Extended by
+
+- `LogEntryStart`
+- `LogEntryEnd`
+
+#### Constructors
+
+```ts
+new LogEntry(
+ timestamp: Date,
+ level: LogEntryLevel,
+ message: string): LogEntry
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `timestamp` | `Date` |
+| `level` | `LogEntryLevel` |
+| `message` | `string` |
+
+###### Returns
+
+`LogEntry`
+
+#### Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| `level` | `readonly` | `LogEntryLevel` |
+| `message` | `readonly` | `string` |
+| `timestamp` | `readonly` | `Date` |
+
+#### Methods
+
+### toString()
+
+```ts
+toString(): string
+```
+
+###### Returns
+
+`string`
+
+***
+
+### LogEntryEnd
+
+Special log entry indicating the end of a build process.
+
+#### Constructors
+
+```ts
+new LogEntryEnd(timestamp: Date, message: string): LogEntryEnd
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `timestamp` | `Date` |
+| `message` | `string` |
+
+###### Returns
+
+`LogEntryEnd`
+
+#### Properties
+
+| Property | Modifier | Type | Inherited from |
+| ------ | ------ | ------ | ------ |
+| `level` | `readonly` | `LogEntryLevel` | `LogEntry`.`level` |
+| `message` | `readonly` | `string` | `LogEntry`.`message` |
+| `timestamp` | `readonly` | `Date` | `LogEntry`.`timestamp` |
+
+#### Methods
+
+### toString()
+
+```ts
+toString(): string
+```
+
+###### Returns
+
+`string`
+
+***
+
+### LogEntryStart
+
+Special log entry indicating the start of a build process.
+
+#### Constructors
+
+```ts
+new LogEntryStart(timestamp: Date, message: string): LogEntryStart
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `timestamp` | `Date` |
+| `message` | `string` |
+
+###### Returns
+
+`LogEntryStart`
+
+#### Properties
+
+| Property | Modifier | Type | Inherited from |
+| ------ | ------ | ------ | ------ |
+| `level` | `readonly` | `LogEntryLevel` | `LogEntry`.`level` |
+| `message` | `readonly` | `string` | `LogEntry`.`message` |
+| `timestamp` | `readonly` | `Date` | `LogEntry`.`timestamp` |
+
+#### Methods
+
+### toString()
+
+```ts
+toString(): string
+```
+
+###### Returns
+
+`string`
+
+## Type Aliases
+
+### LogEntryLevel
+
+```ts
+type LogEntryLevel: "debug" | "info" | "warn" | "error";
+```
+
+Log entry severity levels.
+
+## Functions
+
+### defaultBuildLogger()
+
+```ts
+function defaultBuildLogger(options?: object): (logEntry: LogEntry) => void
+```
+
+Create a default build logger with animated timer display.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options`? | `object` | Logger configuration options |
+| `options.minLevel`? | `LogEntryLevel` | Minimum log level to display (default: 'info') |
+
+#### Returns
+
+`Function`
+
+Logger function that accepts LogEntry instances
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `logEntry` | `LogEntry` |
+
+### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { Template, defaultBuildLogger } from 'e2b'
+
+const template = Template().fromPythonImage()
+
+await Template.build(template, {
+ alias: 'my-template',
+ onBuildLogs: defaultBuildLogger({ minLevel: 'debug' })
+})
+```
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/page.mdx
new file mode 100644
index 000000000..d2d56d6f7
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/page.mdx
@@ -0,0 +1,2079 @@
+### TemplateBase
+
+Base class for building E2B sandbox templates.
+
+#### Implements
+
+- `TemplateFromImage`
+- `TemplateBuilder`
+- `TemplateFinal`
+
+#### Constructors
+
+```ts
+new TemplateBase(options?: TemplateOptions): TemplateBase
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | `TemplateOptions` |
+
+###### Returns
+
+`TemplateBase`
+
+#### Methods
+
+### addMcpServer()
+
+```ts
+addMcpServer(servers: keyof McpServer | keyof McpServer[]): TemplateBuilder
+```
+
+Install MCP servers using mcp-gateway.
+Note: Requires a base image with mcp-gateway pre-installed (e.g., mcp-gateway).
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `servers` | keyof McpServer \| keyof McpServer[] | MCP server name(s) |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Throws
+
+If the base template is not mcp-gateway
+
+###### Example
+
+```ts
+template.addMcpServer('exa')
+template.addMcpServer(['brave', 'firecrawl', 'duckduckgo'])
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`addMcpServer`
+
+### aptInstall()
+
+```ts
+aptInstall(packages: string | string[], options?: object): TemplateBuilder
+```
+
+Install Debian/Ubuntu packages using apt-get.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages` | `string` \| `string`[] | Package name(s) |
+| `options`? | `object` | - |
+| `options.noInstallRecommends`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.aptInstall('vim')
+template.aptInstall(['git', 'curl', 'wget'])
+template.aptInstall(['vim'], { noInstallRecommends: true })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`aptInstall`
+
+### betaDevContainerPrebuild()
+
+```ts
+betaDevContainerPrebuild(devcontainerDirectory: string): TemplateBuilder
+```
+
+Prebuild a devcontainer from the specified directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devcontainerDirectory` | `string` | Path to the devcontainer directory |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .betaDevContainerPrebuild('/my-devcontainer')
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`betaDevContainerPrebuild`
+
+### betaSetDevContainerStart()
+
+```ts
+betaSetDevContainerStart(devcontainerDirectory: string): TemplateFinal
+```
+
+Start a devcontainer from the specified directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devcontainerDirectory` | `string` | Path to the devcontainer directory |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .startDevcontainer('/my-devcontainer')
+
+// Prebuild and start
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .betaDevContainerPrebuild('/my-devcontainer')
+ // Other instructions...
+ .betaSetDevContainerStart('/my-devcontainer')
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`betaSetDevContainerStart`
+
+### bunInstall()
+
+```ts
+bunInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Bun packages using bun.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for package.json |
+| `options`? | `object` | Install options |
+| `options.dev`? | `boolean` | - |
+| `options.g`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.bunInstall('express')
+template.bunInstall(['lodash', 'axios'])
+template.bunInstall('tsx', { g: true })
+template.bunInstall('typescript', { dev: true })
+template.bunInstall() // Installs from package.json
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`bunInstall`
+
+### copy()
+
+```ts
+copy(
+ src: PathLike | PathLike[],
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Copy files or directories into the template.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` \| `PathLike`[] | Source path(s) |
+| `dest` | `PathLike` | Destination path |
+| `options`? | `object` | Copy options |
+| `options.forceUpload`? | `true` | - |
+| `options.mode`? | `number` | - |
+| `options.resolveSymlinks`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.copy('requirements.txt', '/home/user/')
+template.copy(['app.ts', 'config.ts'], '/app/', { mode: 0o755 })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`copy`
+
+### copyItems()
+
+```ts
+copyItems(items: CopyItem[]): TemplateBuilder
+```
+
+Copy multiple items with individual options.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `items` | `CopyItem`[] | Array of copy items |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.copyItems([
+ { src: 'app.ts', dest: '/app/' },
+ { src: 'config.ts', dest: '/app/', mode: 0o644 }
+])
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`copyItems`
+
+### fromAWSRegistry()
+
+```ts
+fromAWSRegistry(image: string, credentials: object): TemplateBuilder
+```
+
+Start from a Docker image in AWS ECR.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `image` | `string` | Full ECR image path |
+| `credentials` | `object` | AWS credentials |
+| `credentials.accessKeyId` | `string` | - |
+| `credentials.region` | `string` | - |
+| `credentials.secretAccessKey` | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromAWSRegistry(
+ '123456789.dkr.ecr.us-west-2.amazonaws.com/myimage:latest',
+ {
+ accessKeyId: 'AKIA...',
+ secretAccessKey: '...',
+ region: 'us-west-2'
+ }
+)
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromAWSRegistry`
+
+### fromBaseImage()
+
+```ts
+fromBaseImage(): TemplateBuilder
+```
+
+Start from E2B's default base image (e2bdev/base:latest).
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromBaseImage()
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromBaseImage`
+
+### fromBunImage()
+
+```ts
+fromBunImage(variant: string): TemplateBuilder
+```
+
+Start from a Bun-based Docker image.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `variant` | `string` | `'latest'` | Bun variant (default: 'latest') |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromBunImage('1.3')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromBunImage`
+
+### fromDebianImage()
+
+```ts
+fromDebianImage(variant: string): TemplateBuilder
+```
+
+Start from a Debian-based Docker image.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `variant` | `string` | `'stable'` | Debian variant (default: 'stable') |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromDebianImage('bookworm')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromDebianImage`
+
+### fromDockerfile()
+
+```ts
+fromDockerfile(dockerfileContentOrPath: string): TemplateBuilder
+```
+
+Parse a Dockerfile and convert it to Template SDK format.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `dockerfileContentOrPath` | `string` | Dockerfile content or path |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromDockerfile('Dockerfile')
+Template().fromDockerfile('FROM python:3\nRUN pip install numpy')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromDockerfile`
+
+### fromGCPRegistry()
+
+```ts
+fromGCPRegistry(image: string, credentials: object): TemplateBuilder
+```
+
+Start from a Docker image in Google Container Registry.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `image` | `string` | Full GCR/GAR image path |
+| `credentials` | `object` | GCP service account credentials |
+| `credentials.serviceAccountJSON` | `string` \| `object` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromGCPRegistry(
+ 'gcr.io/myproject/myimage:latest',
+ { serviceAccountJSON: 'path/to/service-account.json' }
+)
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromGCPRegistry`
+
+### fromImage()
+
+```ts
+fromImage(baseImage: string, credentials?: object): TemplateBuilder
+```
+
+Start from a custom Docker image.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `baseImage` | `string` | Docker image name |
+| `credentials`? | `object` | Optional credentials for private registries |
+| `credentials.password`? | `string` | - |
+| `credentials.username`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromImage('python:3')
+
+// With credentials (optional)
+Template().fromImage('myregistry.com/myimage:latest', {
+ username: 'user',
+ password: 'pass'
+})
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromImage`
+
+### fromNodeImage()
+
+```ts
+fromNodeImage(variant: string): TemplateBuilder
+```
+
+Start from a Node.js-based Docker image.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `variant` | `string` | `'lts'` | Node.js variant (default: 'lts') |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromNodeImage('24')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromNodeImage`
+
+### fromPythonImage()
+
+```ts
+fromPythonImage(version: string): TemplateBuilder
+```
+
+Start from a Python-based Docker image.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `version` | `string` | `'3'` | Python version (default: '3') |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromPythonImage('3')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromPythonImage`
+
+### fromTemplate()
+
+```ts
+fromTemplate(template: string): TemplateBuilder
+```
+
+Start from an existing E2B template.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | `string` | E2B template ID or alias |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromTemplate('my-base-template')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromTemplate`
+
+### fromUbuntuImage()
+
+```ts
+fromUbuntuImage(variant: string): TemplateBuilder
+```
+
+Start from an Ubuntu-based Docker image.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `variant` | `string` | `'latest'` | Ubuntu variant (default: 'latest') |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+Template().fromUbuntuImage('24.04')
+```
+
+###### Implementation of
+
+`TemplateFromImage.fromUbuntuImage`
+
+### gitClone()
+
+```ts
+gitClone(
+ url: string,
+ path?: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Clone a Git repository.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `url` | `string` | Repository URL |
+| `path`? | `PathLike` | Optional destination path |
+| `options`? | `object` | Clone options |
+| `options.branch`? | `string` | - |
+| `options.depth`? | `number` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.gitClone('https://github.com/user/repo.git', '/app/repo')
+template.gitClone('https://github.com/user/repo.git', undefined, {
+ branch: 'main',
+ depth: 1
+})
+template.gitClone('https://github.com/user/repo.git', '/app/repo', {
+ user: 'root'
+})
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`gitClone`
+
+### makeDir()
+
+```ts
+makeDir(path: PathLike | PathLike[], options?: object): TemplateBuilder
+```
+
+Create directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `PathLike` \| `PathLike`[] | Directory path(s) |
+| `options`? | `object` | Directory options |
+| `options.mode`? | `number` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.makeDir('/app/data', { mode: 0o755 })
+template.makeDir(['/app/logs', '/app/cache'])
+template.makeDir('/app/data', { mode: 0o755, user: 'root' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`makeDir`
+
+### makeSymlink()
+
+```ts
+makeSymlink(
+ src: PathLike,
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Create a symbolic link.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` | Source path (target) |
+| `dest` | `PathLike` | Destination path (symlink location) |
+| `options`? | `object` | Symlink options |
+| `options.force`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python')
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python', { user: 'root' })
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python', { force: true })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`makeSymlink`
+
+### npmInstall()
+
+```ts
+npmInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Node.js packages using npm.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for package.json |
+| `options`? | `object` | Install options |
+| `options.dev`? | `boolean` | - |
+| `options.g`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.npmInstall('express')
+template.npmInstall(['lodash', 'axios'])
+template.npmInstall('tsx', { g: true })
+template.npmInstall('typescript', { dev: true })
+template.npmInstall() // Installs from package.json
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`npmInstall`
+
+### pipInstall()
+
+```ts
+pipInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Python packages using pip.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for current directory |
+| `options`? | `object` | Install options |
+| `options.g`? | `boolean` | Install globally as root (default: true). Set to false for user-only installation with --user flag |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.pipInstall('numpy') // Installs globally (default)
+template.pipInstall(['pandas', 'scikit-learn'])
+template.pipInstall('numpy', { g: false }) // Install for user only
+template.pipInstall() // Installs from current directory
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`pipInstall`
+
+### remove()
+
+```ts
+remove(path: PathLike | PathLike[], options?: object): TemplateBuilder
+```
+
+Remove files or directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `PathLike` \| `PathLike`[] | Path(s) to remove |
+| `options`? | `object` | Remove options |
+| `options.force`? | `boolean` | - |
+| `options.recursive`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.remove('/tmp/cache', { recursive: true, force: true })
+template.remove('/tmp/cache', { recursive: true, force: true, user: 'root' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`remove`
+
+### rename()
+
+```ts
+rename(
+ src: PathLike,
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Rename or move a file or directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` | Source path |
+| `dest` | `PathLike` | Destination path |
+| `options`? | `object` | Rename options |
+| `options.force`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.rename('/tmp/old.txt', '/tmp/new.txt')
+template.rename('/tmp/old.txt', '/tmp/new.txt', { user: 'root' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`rename`
+
+### runCmd()
+
+###### runCmd(command, options)
+
+```ts
+runCmd(command: string, options?: object): TemplateBuilder
+```
+
+Run a shell command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `command` | `string` | Command string |
+| `options`? | `object` | Command options |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.runCmd('apt-get update')
+template.runCmd(['pip install numpy', 'pip install pandas'])
+template.runCmd('apt-get install vim', { user: 'root' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`runCmd`
+
+###### runCmd(commands, options)
+
+```ts
+runCmd(commands: string[], options?: object): TemplateBuilder
+```
+
+Run a shell command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `commands` | `string`[] | - |
+| `options`? | `object` | Command options |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.runCmd('apt-get update')
+template.runCmd(['pip install numpy', 'pip install pandas'])
+template.runCmd('apt-get install vim', { user: 'root' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`runCmd`
+
+### setEnvs()
+
+```ts
+setEnvs(envs: Record<string, string>): TemplateBuilder
+```
+
+Set environment variables.
+Note: Environment variables defined here are available only during template build.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `envs` | `Record`\<`string`, `string`\> | Environment variables |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setEnvs({ NODE_ENV: 'production', PORT: '8080' })
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`setEnvs`
+
+### setReadyCmd()
+
+```ts
+setReadyCmd(readyCommand: string | ReadyCmd): TemplateFinal
+```
+
+Set or update the ready check command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `readyCommand` | `string` \| `ReadyCmd` | Command to check readiness |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+// Using a string command
+template.setReadyCmd('curl http://localhost:8000/health')
+
+// Using ReadyCmd helpers
+import { waitForPort, waitForFile, waitForProcess } from 'e2b'
+
+template.setReadyCmd(waitForPort(3000))
+
+template.setReadyCmd(waitForFile('/tmp/ready'))
+
+template.setReadyCmd(waitForProcess('nginx'))
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`setReadyCmd`
+
+### setStartCmd()
+
+```ts
+setStartCmd(startCommand: string, readyCommand: string | ReadyCmd): TemplateFinal
+```
+
+Set the start command and ready check.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `startCommand` | `string` | Command to run on startup |
+| `readyCommand` | `string` \| `ReadyCmd` | Command to check readiness |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+// Using a string command
+template.setStartCmd(
+ 'node app.js',
+ 'curl http://localhost:8000/health'
+)
+
+// Using ReadyCmd helpers
+import { waitForPort, waitForURL } from 'e2b'
+
+template.setStartCmd(
+ 'python -m http.server 8000',
+ waitForPort(8000)
+)
+
+template.setStartCmd(
+ 'npm start',
+ waitForURL('http://localhost:3000/health', 200)
+)
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`setStartCmd`
+
+### setUser()
+
+```ts
+setUser(user: string): TemplateBuilder
+```
+
+Set the user for subsequent commands.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | `string` | Username |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setUser('root')
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`setUser`
+
+### setWorkdir()
+
+```ts
+setWorkdir(workdir: PathLike): TemplateBuilder
+```
+
+Set the working directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workdir` | `PathLike` | Working directory path |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setWorkdir('/app')
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`setWorkdir`
+
+### skipCache()
+
+```ts
+skipCache(): this
+```
+
+Skip cache for all subsequent build instructions from this point.
+
+###### Returns
+
+`this`
+
+###### Example
+
+```ts
+Template().skipCache().fromPythonImage('3')
+```
+
+###### Implementation of
+
+`TemplateBuilder`.`skipCache`
+
+### aliasExists()
+
+```ts
+static aliasExists(alias: string, options?: ConnectionOpts): Promise<boolean>
+```
+
+Check if a template with the given alias exists.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `alias` | `string` | Template alias to check |
+| `options`? | `ConnectionOpts` | Authentication options |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+True if the alias exists, false otherwise
+
+###### Example
+
+```ts
+const exists = await Template.aliasExists('my-python-env')
+if (exists) {
+ console.log('Template exists!')
+}
+```
+
+### build()
+
+```ts
+static build(template: TemplateClass, options: BuildOptions): Promise<BuildInfo>
+```
+
+Build and deploy a template to E2B infrastructure.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | `TemplateClass` | The template to build |
+| `options` | `BuildOptions` | Build configuration options |
+
+###### Returns
+
+`Promise`\<`BuildInfo`\>
+
+###### Example
+
+```ts
+const template = Template().fromPythonImage('3')
+await Template.build(template, {
+ alias: 'my-python-env',
+ cpuCount: 2,
+ memoryMB: 1024
+})
+```
+
+### buildInBackground()
+
+```ts
+static buildInBackground(template: TemplateClass, options: BuildOptions): Promise<BuildInfo>
+```
+
+Build and deploy a template to E2B infrastructure.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | `TemplateClass` | The template to build |
+| `options` | `BuildOptions` | Build configuration options |
+
+###### Returns
+
+`Promise`\<`BuildInfo`\>
+
+###### Example
+
+```ts
+const template = Template().fromPythonImage('3')
+const data = await Template.buildInBackground(template, {
+ alias: 'my-python-env',
+ cpuCount: 2,
+ memoryMB: 1024
+})
+```
+
+### getBuildStatus()
+
+```ts
+static getBuildStatus(data: Pick<BuildInfo, "templateId" | "buildId">, options?: GetBuildStatusOptions): Promise<object>
+```
+
+Get the status of a build.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `Pick`\<`BuildInfo`, `"templateId"` \| `"buildId"`\> | Build identifiers |
+| `options`? | `GetBuildStatusOptions` | Authentication options |
+
+###### Returns
+
+`Promise`\<`object`\>
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| `buildID` | `string` | **Description** Identifier of the build |
+| `logEntries` | `object`[] | **Description** Build logs structured **Default** `[]` |
+| `logs` | `string`[] | **Description** Build logs **Default** `[]` |
+| `reason`? | `object` | - |
+| `reason.logEntries`? | `object`[] | **Description** Log entries related to the status reason **Default** `[]` |
+| `reason.message` | `string` | **Description** Message with the status reason, currently reporting only for error status |
+| `reason.step`? | `string` | **Description** Step that failed |
+| `status` | `"error"` \| `"ready"` \| `"building"` \| `"waiting"` | - |
+| `templateID` | `string` | **Description** Identifier of the template |
+
+###### Example
+
+```ts
+const status = await Template.getBuildStatus(data, { logsOffset: 0 })
+```
+
+### toDockerfile()
+
+```ts
+static toDockerfile(template: TemplateClass): string
+```
+
+Convert a template to Dockerfile format.
+Note: Templates based on other E2B templates cannot be converted to Dockerfile.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | `TemplateClass` | The template to convert |
+
+###### Returns
+
+`string`
+
+Dockerfile string representation
+
+###### Throws
+
+Error if the template is based on another E2B template
+
+### toJSON()
+
+```ts
+static toJSON(template: TemplateClass, computeHashes: boolean): Promise<string>
+```
+
+Convert a template to JSON representation.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `template` | `TemplateClass` | `undefined` | The template to convert |
+| `computeHashes` | `boolean` | `true` | Whether to compute file hashes for cache invalidation |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+JSON string representation of the template
+
+## Interfaces
+
+### TemplateBuilder
+
+Main builder state for constructing templates.
+Provides methods for customizing the template environment.
+
+#### Methods
+
+### addMcpServer()
+
+```ts
+addMcpServer(servers: keyof McpServer | keyof McpServer[]): TemplateBuilder
+```
+
+Install MCP servers using mcp-gateway.
+Note: Requires a base image with mcp-gateway pre-installed (e.g., mcp-gateway).
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `servers` | keyof McpServer \| keyof McpServer[] | MCP server name(s) |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Throws
+
+If the base template is not mcp-gateway
+
+###### Example
+
+```ts
+template.addMcpServer('exa')
+template.addMcpServer(['brave', 'firecrawl', 'duckduckgo'])
+```
+
+### aptInstall()
+
+```ts
+aptInstall(packages: string | string[], options?: object): TemplateBuilder
+```
+
+Install Debian/Ubuntu packages using apt-get.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages` | `string` \| `string`[] | Package name(s) |
+| `options`? | `object` | - |
+| `options.noInstallRecommends`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.aptInstall('vim')
+template.aptInstall(['git', 'curl', 'wget'])
+template.aptInstall(['vim'], { noInstallRecommends: true })
+```
+
+### betaDevContainerPrebuild()
+
+```ts
+betaDevContainerPrebuild(devcontainerDirectory: string): TemplateBuilder
+```
+
+Prebuild a devcontainer from the specified directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devcontainerDirectory` | `string` | Path to the devcontainer directory |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .betaDevContainerPrebuild('/my-devcontainer')
+```
+
+### betaSetDevContainerStart()
+
+```ts
+betaSetDevContainerStart(devcontainerDirectory: string): TemplateFinal
+```
+
+Start a devcontainer from the specified directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `devcontainerDirectory` | `string` | Path to the devcontainer directory |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .startDevcontainer('/my-devcontainer')
+
+// Prebuild and start
+template
+ .gitClone('https://myrepo.com/project.git', '/my-devcontainer')
+ .betaDevContainerPrebuild('/my-devcontainer')
+ // Other instructions...
+ .betaSetDevContainerStart('/my-devcontainer')
+```
+
+### bunInstall()
+
+```ts
+bunInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Bun packages using bun.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for package.json |
+| `options`? | `object` | Install options |
+| `options.dev`? | `boolean` | - |
+| `options.g`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.bunInstall('express')
+template.bunInstall(['lodash', 'axios'])
+template.bunInstall('tsx', { g: true })
+template.bunInstall('typescript', { dev: true })
+template.bunInstall() // Installs from package.json
+```
+
+### copy()
+
+```ts
+copy(
+ src: PathLike | PathLike[],
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Copy files or directories into the template.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` \| `PathLike`[] | Source path(s) |
+| `dest` | `PathLike` | Destination path |
+| `options`? | `object` | Copy options |
+| `options.forceUpload`? | `true` | - |
+| `options.mode`? | `number` | - |
+| `options.resolveSymlinks`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.copy('requirements.txt', '/home/user/')
+template.copy(['app.ts', 'config.ts'], '/app/', { mode: 0o755 })
+```
+
+### copyItems()
+
+```ts
+copyItems(items: CopyItem[]): TemplateBuilder
+```
+
+Copy multiple items with individual options.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `items` | `CopyItem`[] | Array of copy items |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.copyItems([
+ { src: 'app.ts', dest: '/app/' },
+ { src: 'config.ts', dest: '/app/', mode: 0o644 }
+])
+```
+
+### gitClone()
+
+```ts
+gitClone(
+ url: string,
+ path?: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Clone a Git repository.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `url` | `string` | Repository URL |
+| `path`? | `PathLike` | Optional destination path |
+| `options`? | `object` | Clone options |
+| `options.branch`? | `string` | - |
+| `options.depth`? | `number` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.gitClone('https://github.com/user/repo.git', '/app/repo')
+template.gitClone('https://github.com/user/repo.git', undefined, {
+ branch: 'main',
+ depth: 1
+})
+template.gitClone('https://github.com/user/repo.git', '/app/repo', {
+ user: 'root'
+})
+```
+
+### makeDir()
+
+```ts
+makeDir(path: PathLike | PathLike[], options?: object): TemplateBuilder
+```
+
+Create directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `PathLike` \| `PathLike`[] | Directory path(s) |
+| `options`? | `object` | Directory options |
+| `options.mode`? | `number` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.makeDir('/app/data', { mode: 0o755 })
+template.makeDir(['/app/logs', '/app/cache'])
+template.makeDir('/app/data', { mode: 0o755, user: 'root' })
+```
+
+### makeSymlink()
+
+```ts
+makeSymlink(
+ src: PathLike,
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Create a symbolic link.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` | Source path (target) |
+| `dest` | `PathLike` | Destination path (symlink location) |
+| `options`? | `object` | Symlink options |
+| `options.force`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python')
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python', { user: 'root' })
+template.makeSymlink('/usr/bin/python3', '/usr/bin/python', { force: true })
+```
+
+### npmInstall()
+
+```ts
+npmInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Node.js packages using npm.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for package.json |
+| `options`? | `object` | Install options |
+| `options.dev`? | `boolean` | - |
+| `options.g`? | `boolean` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.npmInstall('express')
+template.npmInstall(['lodash', 'axios'])
+template.npmInstall('tsx', { g: true })
+template.npmInstall('typescript', { dev: true })
+template.npmInstall() // Installs from package.json
+```
+
+### pipInstall()
+
+```ts
+pipInstall(packages?: string | string[], options?: object): TemplateBuilder
+```
+
+Install Python packages using pip.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `packages`? | `string` \| `string`[] | Package name(s) or undefined for current directory |
+| `options`? | `object` | Install options |
+| `options.g`? | `boolean` | Install globally as root (default: true). Set to false for user-only installation with --user flag |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.pipInstall('numpy') // Installs globally (default)
+template.pipInstall(['pandas', 'scikit-learn'])
+template.pipInstall('numpy', { g: false }) // Install for user only
+template.pipInstall() // Installs from current directory
+```
+
+### remove()
+
+```ts
+remove(path: PathLike | PathLike[], options?: object): TemplateBuilder
+```
+
+Remove files or directories.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `PathLike` \| `PathLike`[] | Path(s) to remove |
+| `options`? | `object` | Remove options |
+| `options.force`? | `boolean` | - |
+| `options.recursive`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.remove('/tmp/cache', { recursive: true, force: true })
+template.remove('/tmp/cache', { recursive: true, force: true, user: 'root' })
+```
+
+### rename()
+
+```ts
+rename(
+ src: PathLike,
+ dest: PathLike,
+ options?: object): TemplateBuilder
+```
+
+Rename or move a file or directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `src` | `PathLike` | Source path |
+| `dest` | `PathLike` | Destination path |
+| `options`? | `object` | Rename options |
+| `options.force`? | `boolean` | - |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.rename('/tmp/old.txt', '/tmp/new.txt')
+template.rename('/tmp/old.txt', '/tmp/new.txt', { user: 'root' })
+```
+
+### runCmd()
+
+###### runCmd(command, options)
+
+```ts
+runCmd(command: string, options?: object): TemplateBuilder
+```
+
+Run a shell command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `command` | `string` | Command string |
+| `options`? | `object` | Command options |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.runCmd('apt-get update')
+template.runCmd(['pip install numpy', 'pip install pandas'])
+template.runCmd('apt-get install vim', { user: 'root' })
+```
+
+###### runCmd(commands, options)
+
+```ts
+runCmd(commands: string[], options?: object): TemplateBuilder
+```
+
+Run multiple shell commands.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `commands` | `string`[] | Array of command strings |
+| `options`? | `object` | Command options |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### runCmd(commandOrCommands, options)
+
+```ts
+runCmd(commandOrCommands: string | string[], options?: object): TemplateBuilder
+```
+
+Run command(s).
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `commandOrCommands` | `string` \| `string`[] | Command or commands |
+| `options`? | `object` | Command options |
+| `options.user`? | `string` | - |
+
+###### Returns
+
+`TemplateBuilder`
+
+### setEnvs()
+
+```ts
+setEnvs(envs: Record<string, string>): TemplateBuilder
+```
+
+Set environment variables.
+Note: Environment variables defined here are available only during template build.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `envs` | `Record`\<`string`, `string`\> | Environment variables |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setEnvs({ NODE_ENV: 'production', PORT: '8080' })
+```
+
+### setReadyCmd()
+
+```ts
+setReadyCmd(readyCommand: string | ReadyCmd): TemplateFinal
+```
+
+Set or update the ready check command.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `readyCommand` | `string` \| `ReadyCmd` | Command to check readiness |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+// Using a string command
+template.setReadyCmd('curl http://localhost:8000/health')
+
+// Using ReadyCmd helpers
+import { waitForPort, waitForFile, waitForProcess } from 'e2b'
+
+template.setReadyCmd(waitForPort(3000))
+
+template.setReadyCmd(waitForFile('/tmp/ready'))
+
+template.setReadyCmd(waitForProcess('nginx'))
+```
+
+### setStartCmd()
+
+```ts
+setStartCmd(startCommand: string, readyCommand: string | ReadyCmd): TemplateFinal
+```
+
+Set the start command and ready check.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `startCommand` | `string` | Command to run on startup |
+| `readyCommand` | `string` \| `ReadyCmd` | Command to check readiness |
+
+###### Returns
+
+`TemplateFinal`
+
+###### Example
+
+```ts
+// Using a string command
+template.setStartCmd(
+ 'node app.js',
+ 'curl http://localhost:8000/health'
+)
+
+// Using ReadyCmd helpers
+import { waitForPort, waitForURL } from 'e2b'
+
+template.setStartCmd(
+ 'python -m http.server 8000',
+ waitForPort(8000)
+)
+
+template.setStartCmd(
+ 'npm start',
+ waitForURL('http://localhost:3000/health', 200)
+)
+```
+
+### setUser()
+
+```ts
+setUser(user: string): TemplateBuilder
+```
+
+Set the user for subsequent commands.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `user` | `string` | Username |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setUser('root')
+```
+
+### setWorkdir()
+
+```ts
+setWorkdir(workdir: PathLike): TemplateBuilder
+```
+
+Set the working directory.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workdir` | `PathLike` | Working directory path |
+
+###### Returns
+
+`TemplateBuilder`
+
+###### Example
+
+```ts
+template.setWorkdir('/app')
+```
+
+### skipCache()
+
+```ts
+skipCache(): this
+```
+
+Skip cache for all subsequent build instructions from this point.
+
+###### Returns
+
+`this`
+
+###### Example
+
+```ts
+template.skipCache().runCmd('apt-get update')
+```
+
+## Type Aliases
+
+### AliasExistsOptions
+
+```ts
+type AliasExistsOptions: ConnectionOpts;
+```
+
+Options for checking if a template alias exists.
+
+***
+
+### BuildInfo
+
+```ts
+type BuildInfo: object;
+```
+
+Information about a built template.
+
+#### Type declaration
+
+| Name | Type |
+| ------ | ------ |
+| `alias` | `string` |
+| `buildId` | `string` |
+| `templateId` | `string` |
+
+***
+
+### BuildOptions
+
+```ts
+type BuildOptions: ConnectionOpts & BasicBuildOptions;
+```
+
+Options for building a template with authentication.
+
+***
+
+### CopyItem
+
+```ts
+type CopyItem: object;
+```
+
+Configuration for a single file/directory copy operation.
+
+#### Type declaration
+
+| Name | Type |
+| ------ | ------ |
+| `dest` | `PathLike` |
+| `forceUpload`? | `true` |
+| `mode`? | `number` |
+| `resolveSymlinks`? | `boolean` |
+| `src` | `PathLike` \| `PathLike`[] |
+| `user`? | `string` |
+
+***
+
+### GetBuildStatusOptions
+
+```ts
+type GetBuildStatusOptions: ConnectionOpts & object;
+```
+
+Response from getting build status.
+
+#### Type declaration
+
+| Name | Type |
+| ------ | ------ |
+| `logsOffset`? | `number` |
+
+***
+
+### McpServerName
+
+```ts
+type McpServerName: keyof McpServer;
+```
+
+MCP server names that can be installed.
+
+***
+
+### TemplateClass
+
+```ts
+type TemplateClass: TemplateBuilder | TemplateFinal;
+```
+
+Type representing a template in any state (builder or final).
+
+## Functions
+
+### Template()
+
+```ts
+function Template(options?: TemplateOptions): TemplateFromImage
+```
+
+Create a new E2B template builder instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options`? | `TemplateOptions` | Optional configuration for the template builder |
+
+#### Returns
+
+`TemplateFromImage`
+
+A new template builder instance
+
+#### Example
+
+```ts
+import { Template } from 'e2b'
+
+const template = Template()
+ .fromPythonImage('3')
+ .copy('requirements.txt', '/app/')
+ .pipInstall()
+
+await Template.build(template, { alias: 'my-python-app' })
+```
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/readycmd/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/readycmd/page.mdx
new file mode 100644
index 000000000..d9f157dbf
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v2.10.4/template/readycmd/page.mdx
@@ -0,0 +1,197 @@
+### ReadyCmd
+
+Class for ready check commands.
+
+#### Constructors
+
+```ts
+new ReadyCmd(cmd: string): ReadyCmd
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `cmd` | `string` |
+
+###### Returns
+
+`ReadyCmd`
+
+#### Methods
+
+### getCmd()
+
+```ts
+getCmd(): string
+```
+
+###### Returns
+
+`string`
+
+## Functions
+
+### waitForFile()
+
+```ts
+function waitForFile(filename: string): ReadyCmd
+```
+
+Wait for a file to exist.
+Uses shell test command to check file existence.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filename` | `string` | Path to the file to wait for |
+
+#### Returns
+
+`ReadyCmd`
+
+ReadyCmd that checks for the file
+
+#### Example
+
+```ts
+import { Template, waitForFile } from 'e2b'
+
+const template = Template()
+ .fromBaseImage()
+ .setStartCmd('./init.sh', waitForFile('/tmp/ready'))
+```
+
+***
+
+### waitForPort()
+
+```ts
+function waitForPort(port: number): ReadyCmd
+```
+
+Wait for a port to be listening.
+Uses `ss` command to check if a port is open and listening.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `port` | `number` | Port number to wait for |
+
+#### Returns
+
+`ReadyCmd`
+
+ReadyCmd that checks for the port
+
+#### Example
+
+```ts
+import { Template, waitForPort } from 'e2b'
+
+const template = Template()
+ .fromPythonImage()
+ .setStartCmd('python -m http.server 8000', waitForPort(8000))
+```
+
+***
+
+### waitForProcess()
+
+```ts
+function waitForProcess(processName: string): ReadyCmd
+```
+
+Wait for a process with a specific name to be running.
+Uses `pgrep` to check if a process exists.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `processName` | `string` | Name of the process to wait for |
+
+#### Returns
+
+`ReadyCmd`
+
+ReadyCmd that checks for the process
+
+#### Example
+
+```ts
+import { Template, waitForProcess } from 'e2b'
+
+const template = Template()
+ .fromBaseImage()
+ .setStartCmd('./my-daemon', waitForProcess('my-daemon'))
+```
+
+***
+
+### waitForTimeout()
+
+```ts
+function waitForTimeout(timeout: number): ReadyCmd
+```
+
+Wait for a specified timeout before considering the sandbox ready.
+Uses `sleep` command to wait for a fixed duration.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `timeout` | `number` | Time to wait in milliseconds (minimum: 1000ms / 1 second) |
+
+#### Returns
+
+`ReadyCmd`
+
+ReadyCmd that waits for the specified duration
+
+#### Example
+
+```ts
+import { Template, waitForTimeout } from 'e2b'
+
+const template = Template()
+ .fromNodeImage()
+ .setStartCmd('npm start', waitForTimeout(5000)) // Wait 5 seconds
+```
+
+***
+
+### waitForURL()
+
+```ts
+function waitForURL(url: string, statusCode: number): ReadyCmd
+```
+
+Wait for a URL to return a specific HTTP status code.
+Uses `curl` to make HTTP requests and check the response status.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `url` | `string` | `undefined` | URL to check (e.g., 'http://localhost:3000/health') |
+| `statusCode` | `number` | `200` | Expected HTTP status code (default: 200) |
+
+#### Returns
+
+`ReadyCmd`
+
+ReadyCmd that checks the URL
+
+#### Example
+
+```ts
+import { Template, waitForURL } from 'e2b'
+
+const template = Template()
+ .fromNodeImage()
+ .setStartCmd('npm start', waitForURL('http://localhost:3000/health'))
+```
diff --git a/packages/js-sdk/package.json b/packages/js-sdk/package.json
index 804eadfd0..b070cd989 100644
--- a/packages/js-sdk/package.json
+++ b/packages/js-sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "e2b",
- "version": "2.10.3",
+ "version": "2.10.4",
"description": "E2B SDK that give agents cloud environments",
"homepage": "https://e2b.dev",
"license": "MIT",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 2841be068..97c662fca 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -118,8 +118,8 @@ importers:
specifier: ^1.2.1
version: 1.2.1
e2b:
- specifier: ^2.10.3
- version: 2.10.3
+ specifier: ^2.10.4
+ version: 2.10.4
fast-glob:
specifier: ^3.3.0
version: 3.3.1
@@ -4055,8 +4055,8 @@ packages:
resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==}
engines: {node: '>= 0.4'}
- resolution: {integrity: sha512-HYSfI+Sfl+lI3OTnGEUgGoZ6Oe06j/qZC8RuxUDC9vWHTaoemDQ4COirWIoBQ8uWjmhVEfRsexUweFrc1HUa+g==}
+ resolution: {integrity: sha512-yLJ/aBpGymfHIsgLIuFwBiNGwUNApzp5Xse86hWmPd/jH3Qjl6Gr7ibQZj9VxP+oFxDCDP1Che7wQyNRTbY2xA==}
engines: {node: '>=20'}
@@ -7031,11 +7031,6 @@ packages:
engines: {node: '>=18'}
deprecated: Old versions of tar are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exhorbitant rates) by contacting [email protected]
- resolution: {integrity: sha512-ENg5JUHUm2rDD7IvKNFGzyElLXNjachNLp6RaGf4+JOgxXHkqA+gq81ZAMCUmtMtqBsoU62lcp6S27g1LCYGGQ==}
- engines: {node: '>=18'}
- deprecated: Old versions of tar are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exhorbitant rates) by contacting [email protected]
-
resolution: {integrity: sha512-AN04xbWGrSTDmVwlI4/GTlIIwMFk/XEv7uL8aa57zuvRy6s4hdBed+lVq2fAZ89XDa7Us3ANXcE3Tvqvja1kTA==}
engines: {node: '>=18'}
@@ -11926,7 +11921,7 @@ snapshots:
es-errors: 1.3.0
gopd: 1.2.0
dependencies:
'@bufbuild/protobuf': 2.6.2
'@connectrpc/connect': 2.0.0-rc.3(@bufbuild/[email protected])
@@ -11937,7 +11932,7 @@ snapshots:
glob: 11.1.0
openapi-fetch: 0.14.1
platform: 1.3.6
- tar: 7.5.3
+ tar: 7.5.4
dependencies:
@@ -15659,14 +15654,6 @@ snapshots:
minizlib: 3.1.0
yallist: 5.0.0
- dependencies:
- '@isaacs/fs-minipass': 4.0.1
- chownr: 3.0.0
- minipass: 7.1.2
- minizlib: 3.1.0
- yallist: 5.0.0
-
dependencies:
'@isaacs/fs-minipass': 4.0.1