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]23a9298252cc
diff --git a/.changeset/four-numbers-drive.md b/.changeset/four-numbers-drive.md
deleted file mode 100644
index 75e713ded..000000000
--- a/.changeset/four-numbers-drive.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'@e2b/cli': minor
----
-
-Add ready command for template build
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/auth/page.mdx
new file mode 100644
index 000000000..2c82afa69
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/auth/page.mdx
@@ -0,0 +1,58 @@
+## e2b auth
+
+
+authentication commands
+
+### Usage
+
+```bash
+e2b auth [options] [command]
+```
+## e2b auth login
+
+
+log in to CLI
+
+### Usage
+
+```bash
+e2b auth login [options]
+```
+
+
+## e2b auth logout
+
+
+log out of CLI
+
+### Usage
+
+```bash
+e2b auth logout [options]
+```
+
+
+## e2b auth info
+
+
+get information about the current user
+
+### Usage
+
+```bash
+e2b auth info [options]
+```
+
+
+## e2b auth configure
+
+
+configure user
+
+### Usage
+
+```bash
+e2b auth configure [options]
+```
+
+
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/sandbox/page.mdx
new file mode 100644
index 000000000..53c9a5b35
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/sandbox/page.mdx
@@ -0,0 +1,89 @@
+## e2b sandbox
+
+
+work with sandboxes
+
+### Usage
+
+```bash
+e2b sandbox [options] [command]
+```
+## e2b sandbox connect
+
+
+connect terminal to already running sandbox
+
+### Usage
+
+```bash
+e2b sandbox connect [options] <sandboxID>
+```
+
+
+## e2b sandbox list
+
+
+list all running sandboxes
+
+### Usage
+
+```bash
+e2b sandbox list [options]
+```
+
+
+## e2b sandbox kill
+
+
+kill sandbox
+
+### Usage
+
+```bash
+e2b sandbox kill [options] [sandboxID]
+```
+
+### Options
+
+
+ - `-a, --all: kill all running sandboxes `
+
+
+## e2b sandbox spawn
+
+
+spawn sandbox and connect terminal to it
+
+### Usage
+
+```bash
+e2b sandbox spawn [options] [template]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
+
+
+## e2b sandbox logs
+
+
+show logs for sandbox
+
+### Usage
+
+```bash
+e2b sandbox logs [options] <sandboxID>
+```
+
+### Options
+
+
+ - `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`
+ - `-f, --follow: keep streaming logs until the sandbox is closed `
+ - `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`
+ - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `
+
+
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/template/page.mdx
new file mode 100644
index 000000000..d41cd8537
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.5.0/template/page.mdx
@@ -0,0 +1,134 @@
+## e2b template
+
+
+manage sandbox templates
+
+### Usage
+
+```bash
+e2b template [options] [command]
+```
+## e2b template build
+
+
+build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config.
+
+### Usage
+
+```bash
+e2b template build [options] [template]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+ - `-d, --dockerfile <file>: specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. `
+ - `-n, --name <template-name>: specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. `
+ - `-c, --cmd <start-command>: specify command that will be executed when the sandbox is started. `
+ - `--ready-cmd <ready-command>: specify command that will need to exit 0 for the template to be ready. `
+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `
+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
+ - `--cpu-count <cpu-count>: specify the number of CPUs that will be used to run the sandbox. The default value is 2. `
+ - `--memory-mb <memory-mb>: specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. `
+ - `--build-arg <args...>: specify additional build arguments for the build command. The format should be <varname>=<value>. `
+ - `--no-cache: skip cache when building the template. `
+
+
+## e2b template list
+
+
+list sandbox templates
+
+### Usage
+
+```bash
+e2b template list [options]
+```
+
+### Options
+
+
+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `
+
+
+## e2b template init
+
+
+create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile
+
+### Usage
+
+```bash
+e2b template init [options]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+
+
+## e2b template delete
+
+
+delete sandbox template and e2b.toml config
+
+### Usage
+
+```bash
+e2b template delete [options] [template]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
+ - `-s, --select: select sandbox template from interactive list `
+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `
+ - `-y, --yes: skip manual delete confirmation `
+
+
+## e2b template publish
+
+
+publish sandbox template
+
+### Usage
+
+```bash
+e2b template publish [options] [template]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
+ - `-s, --select: select sandbox template from interactive list `
+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `
+ - `-y, --yes: skip manual publish confirmation `
+
+
+## e2b template unpublish
+
+
+unpublish sandbox template
+
+### Usage
+
+```bash
+e2b template unpublish [options] [template]
+```
+
+### Options
+
+
+ - `-p, --path <path>: change root directory where command is executed to <path> directory `
+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
+ - `-s, --select: select sandbox template from interactive list `
+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `
+ - `-y, --yes: skip manual unpublish confirmation `
+
+
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/page.mdx
new file mode 100644
index 000000000..896ddd559
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/page.mdx
@@ -0,0 +1,579 @@
+### Sandbox
+
+#### Properties
+
+| Property | Modifier | Type | Default value |
+| ------ | ------ | ------ | ------ |
+| `display` | `public` | `string` | `':0'` |
+| `stream` | `public` | `VNCServer` | `undefined` |
+
+#### Methods
+
+### doubleClick()
+
+```ts
+doubleClick(x?: number, y?: number): Promise<void>
+```
+
+Double left click on the mouse position.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `x`? | `number` |
+| `y`? | `number` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### drag()
+
+```ts
+drag(from: [number, number], to: [number, number]): Promise<void>
+```
+
+Drag the mouse from the given position to the given position.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `from` | [`number`, `number`] | The starting position. |
+| `to` | [`number`, `number`] | The ending position. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### getApplicationWindows()
+
+```ts
+getApplicationWindows(application: string): Promise<string[]>
+```
+
+Get the window ID of the window with the given title.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `application` | `string` |
+
+###### Returns
+
+`Promise`\<`string`[]\>
+
+The ID of the window.
+
+### getCurrentWindowId()
+
+```ts
+getCurrentWindowId(): Promise<string>
+```
+
+Get the current window ID.
+
+###### Returns
+
+`Promise`\<`string`\>
+
+The ID of the current window.
+
+### getCursorPosition()
+
+```ts
+getCursorPosition(): Promise<CursorPosition>
+```
+
+Get the current cursor position.
+
+###### Returns
+
+`Promise`\<`CursorPosition`\>
+
+A object with the x and y coordinates
+
+###### Throws
+
+Error if cursor position cannot be determined
+
+### getScreenSize()
+
+```ts
+getScreenSize(): Promise<ScreenSize>
+```
+
+Get the current screen size.
+
+###### Returns
+
+`Promise`\<`ScreenSize`\>
+
+An ScreenSize object
+
+###### Throws
+
+Error if screen size cannot be determined
+
+### getWindowTitle()
+
+```ts
+getWindowTitle(windowId: string): Promise<string>
+```
+
+Get the title of the window with the given ID.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `windowId` | `string` | The ID of the window. |
+
+###### Returns
+
+`Promise`\<`string`\>
+
+The title of the window.
+
+### launch()
+
+```ts
+launch(application: string, uri?: string): Promise<void>
+```
+
+Launch an application.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `application` | `string` | The application to launch. |
+| `uri`? | `string` | The URI to open in the application. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### leftClick()
+
+```ts
+leftClick(x?: number, y?: number): Promise<void>
+```
+
+Left click on the mouse position.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `x`? | `number` |
+| `y`? | `number` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### middleClick()
+
+```ts
+middleClick(x?: number, y?: number): Promise<void>
+```
+
+Middle click on the mouse position.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `x`? | `number` |
+| `y`? | `number` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### mousePress()
+
+```ts
+mousePress(button: "left" | "right" | "middle"): Promise<void>
+```
+
+Press the mouse button.
+
+###### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### mouseRelease()
+
+```ts
+mouseRelease(button: "left" | "right" | "middle"): Promise<void>
+```
+
+Release the mouse button.
+
+###### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### moveMouse()
+
+```ts
+moveMouse(x: number, y: number): Promise<void>
+```
+
+Move the mouse to the given coordinates.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `x` | `number` | The x coordinate. |
+| `y` | `number` | The y coordinate. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### open()
+
+```ts
+open(fileOrUrl: string): Promise<void>
+```
+
+Open a file or a URL in the default application.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `fileOrUrl` | `string` | The file or URL to open. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### press()
+
+```ts
+press(key: string | string[]): Promise<void>
+```
+
+Press a key.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### rightClick()
+
+```ts
+rightClick(x?: number, y?: number): Promise<void>
+```
+
+Right click on the mouse position.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `x`? | `number` |
+| `y`? | `number` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### screenshot()
+
+###### screenshot()
+
+```ts
+screenshot(): Promise<Uint8Array<ArrayBufferLike>>
+```
+
+Take a screenshot and save it to the given name.
+
+###### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+A Uint8Array bytes representation of the screenshot.
+
+###### screenshot(format)
+
+```ts
+screenshot(format: "bytes"): Promise<Uint8Array<ArrayBufferLike>>
+```
+
+Take a screenshot and save it to the given name.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `format` | `"bytes"` | The format of the screenshot. |
+
+###### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+A Uint8Array bytes representation of the screenshot.
+
+###### screenshot(format)
+
+```ts
+screenshot(format: "blob"): Promise<Blob>
+```
+
+Take a screenshot and save it to the given name.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `format` | `"blob"` |
+
+###### Returns
+
+`Promise`\<`Blob`\>
+
+A Blob representation of the screenshot.
+
+###### screenshot(format)
+
+```ts
+screenshot(format: "stream"): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
+```
+
+Take a screenshot and save it to the given name.
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `format` | `"stream"` |
+
+###### Returns
+
+`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>
+
+A ReadableStream of bytes representation of the screenshot.
+
+### scroll()
+
+```ts
+scroll(direction: "down" | "up", amount: number): Promise<void>
+```
+
+Scroll the mouse wheel by the given amount.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". |
+| `amount` | `number` | `1` | The amount to scroll. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### wait()
+
+```ts
+wait(ms: number): Promise<void>
+```
+
+Wait for the given amount of time.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `ms` | `number` | The amount of time to wait in milliseconds. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### waitAndVerify()
+
+```ts
+waitAndVerify(
+ cmd: string,
+ onResult: (result: CommandResult) => boolean,
+ timeout: number,
+interval: number): Promise<boolean>
+```
+
+Wait for a command to return a specific result.
+
+###### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `cmd` | `string` | `undefined` | The command to run. |
+| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. |
+| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. |
+| `interval` | `number` | `0.5` | The interval to wait between checks. |
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the command returned the result within the timeout, otherwise `false`.
+
+### write()
+
+```ts
+write(text: string, options: object): Promise<void>
+```
+
+Write the given text at the current cursor position.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `text` | `string` | The text to write. |
+| `options` | `object` | An object containing the chunk size and delay between each chunk of text. |
+| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. |
+| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+### create()
+
+###### create(this, opts)
+
+```ts
+static create<S>(this: S, opts?: SandboxOpts): Promise<InstanceType<S>>
+```
+
+Create a new sandbox from the default `desktop` 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
+
+## Interfaces
+
+### SandboxOpts
+
+Configuration options for the Sandbox environment.
+ SandboxOpts
+
+#### Properties
+
+### display?
+
+```ts
+optional display: string;
+```
+
+Display identifier.
+
+### dpi?
+
+```ts
+optional dpi: number;
+```
+
+Dots per inch (DPI) setting for the display.
+
+### resolution?
+
+```ts
+optional resolution: [number, number];
+```
+
+The screen resolution in pixels, specified as [width, height].
diff --git a/apps/web/src/app/(docs)/docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/page.mdx
new file mode 100644
index 000000000..b0dccd78d
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/page.mdx
@@ -0,0 +1,302 @@
+
+
+
+
+
+## Sandbox
+
+```python
+class Sandbox(SandboxBase)
+```
+
+
+### \_\_init\_\_
+
+```python
+def __init__(resolution: Optional[Tuple[int, int]] = None,
+ dpi: Optional[int] = None,
+ display: Optional[str] = None,
+ template: Optional[str] = None,
+ timeout: Optional[int] = None,
+ metadata: Optional[Dict[str, str]] = None,
+ envs: Optional[Dict[str, str]] = None,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ sandbox_id: Optional[str] = None,
+ request_timeout: Optional[float] = None,
+ proxy: Optional[ProxyTypes] = None)
+```
+
+Create a new desktop sandbox.
+
+By default, the sandbox is created from the `desktop` template.
+
+**Arguments**:
+
+- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768)
+- `dpi`: Startup the desktop with custom DPI. Defaults to 96
+- `display`: Startup the desktop with custom display. Defaults to ":0"
+- `template`: Sandbox template name or ID
+- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users
+- `metadata`: Custom metadata for the sandbox
+- `envs`: Custom environment variables for the sandbox
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable
+- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable
+- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable
+- `request_timeout`: Timeout for the request in **seconds**
+- `proxy`: Proxy to use for the request and for the requests made to the returned sandbox
+
+**Returns**:
+
+sandbox instance for the new sandbox
+
+
+### screenshot
+
+```python
+@overload
+def screenshot(format: Literal["stream"]) -> Iterator[bytes]
+```
+
+Take a screenshot and return it as a stream of bytes.
+
+
+### screenshot
+
+```python
+@overload
+def screenshot(format: Literal["bytes"]) -> bytearray
+```
+
+Take a screenshot and return it as a bytearray.
+
+
+### screenshot
+
+```python
+def screenshot(format: Literal["bytes", "stream"] = "bytes")
+```
+
+Take a screenshot and return it in the specified format.
+
+**Arguments**:
+
+- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'.
+
+**Returns**:
+
+The screenshot in the specified format.
+
+
+### left\_click
+
+```python
+def left_click(x: Optional[int] = None, y: Optional[int] = None)
+```
+
+Left click on the mouse position.
+
+
+### double\_click
+
+```python
+def double_click(x: Optional[int] = None, y: Optional[int] = None)
+```
+
+Double left click on the mouse position.
+
+
+### middle\_click
+
+```python
+def middle_click(x: Optional[int] = None, y: Optional[int] = None)
+```
+
+Middle click on the mouse position.
+
+
+### scroll
+
+```python
+def scroll(direction: Literal["up", "down"] = "down", amount: int = 1)
+```
+
+Scroll the mouse wheel by the given amount.
+
+**Arguments**:
+
+- `direction`: The direction to scroll. Can be "up" or "down".
+- `amount`: The amount to scroll.
+
+
+### move\_mouse
+
+```python
+def move_mouse(x: int, y: int)
+```
+
+Move the mouse to the given coordinates.
+
+**Arguments**:
+
+- `x`: The x coordinate.
+- `y`: The y coordinate.
+
+
+### mouse\_press
+
+```python
+def mouse_press(button: Literal["left", "right", "middle"] = "left")
+```
+
+Press the mouse button.
+
+
+### mouse\_release
+
+```python
+def mouse_release(button: Literal["left", "right", "middle"] = "left")
+```
+
+Release the mouse button.
+
+
+### get\_cursor\_position
+
+```python
+def get_cursor_position() -> tuple[int, int]
+```
+
+Get the current cursor position.
+
+**Raises**:
+
+- `RuntimeError`: If the cursor position cannot be determined
+
+**Returns**:
+
+A tuple with the x and y coordinates
+
+
+### get\_screen\_size
+
+```python
+def get_screen_size() -> tuple[int, int]
+```
+
+Get the current screen size.
+
+**Raises**:
+
+- `RuntimeError`: If the screen size cannot be determined
+
+**Returns**:
+
+A tuple with the width and height
+
+
+### write
+
+```python
+def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None
+```
+
+Write the given text at the current cursor position.
+
+**Arguments**:
+
+- `text`: The text to write.
+- `chunk_size`: The size of each chunk of text to write.
+- `delay_in_ms`: The delay between each chunk of text.
+
+
+### press
+
+```python
+def press(key: Union[str, list[str]])
+```
+
+Press a key.
+
+**Arguments**:
+
+- `key`: The key to press (e.g. "enter", "space", "backspace", etc.).
+
+
+### drag
+
+```python
+def drag(fr: tuple[int, int], to: tuple[int, int])
+```
+
+Drag the mouse from the given position to the given position.
+
+**Arguments**:
+
+- `from`: The starting position.
+- `to`: The ending position.
+
+
+### wait
+
+```python
+def wait(ms: int)
+```
+
+Wait for the given amount of time.
+
+**Arguments**:
+
+- `ms`: The amount of time to wait in milliseconds.
+
+
+### open
+
+```python
+def open(file_or_url: str)
+```
+
+Open a file or a URL in the default application.
+
+**Arguments**:
+
+- `file_or_url`: The file or URL to open.
+
+
+### get\_current\_window\_id
+
+```python
+def get_current_window_id() -> str
+```
+
+Get the current window ID.
+
+
+### get\_application\_windows
+
+```python
+def get_application_windows(application: str) -> list[str]
+```
+
+Get the window IDs of all windows for the given application.
+
+
+### get\_window\_title
+
+```python
+def get_window_title(window_id: str) -> str
+```
+
+Get the title of the window with the given ID.
+
+
+### launch
+
+```python
+def launch(application: str, uri: Optional[str] = None)
+```
+
+Launch an application.
+
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 9677eabf7..a96e34151 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@e2b/cli",
- "version": "1.4.3",
+ "version": "1.5.0",
"description": "CLI for managing e2b sandbox templates",
"homepage": "https://e2b.dev",
"license": "MIT",