Skip to content

armgit / E2B

Public Imported from GitHub
0

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

[squashed many commits] GH actions workflow for API ref autogen

0divfa90994e4926
diff --git a/.github/scripts/is_new_api_ref.sh b/.github/scripts/is_new_api_ref.sh
new file mode 100755
index 000000000..9e2400285
--- /dev/null
+++ b/.github/scripts/is_new_api_ref.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# This script checks for diffs in the packages directory.
+# If there are diffs, it means we need to generate a new API references.
+if git diff --name-only HEAD^ | grep -q '^packages/'; then
+ echo "true"
+else
+ echo "false"
+fi
diff --git a/.github/workflows/generate_api_ref.yml b/.github/workflows/generate_api_ref.yml
new file mode 100644
index 000000000..93428b5cd
--- /dev/null
+++ b/.github/workflows/generate_api_ref.yml
@@ -0,0 +1,109 @@
+name: Generate SDK API references
+
+on:
+ workflow_dispatch:
+ push:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+ contents: write
+
+jobs:
+ is_new_api_ref:
+ name: Is new API reference?
+ runs-on: ubuntu-latest
+ outputs:
+ new_api_ref: ${{ steps.sdk-changes.outputs.new_api_ref }}
+ steps:
+ - name: Checkout Repo
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 2
+
+ - name: Check if SDK changes
+ id: sdk-changes
+ run: |
+ IS_NEW_API_REF=$(./.github/scripts/is_new_api_ref.sh)
+ echo "new_api_ref=$IS_NEW_API_REF" >> "$GITHUB_OUTPUT"
+
+ sdk-changes:
+ name: SDK changes
+ needs: [is_new_api_ref]
+ if: always()
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - name: Install pnpm
+ uses: pnpm/action-setup@v3
+ id: pnpm-install
+ with:
+ version: 9.5
+
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: "18.x"
+ registry-url: "https://registry.npmjs.org"
+ cache: pnpm
+ cache-dependency-path: pnpm-lock.yaml
+
+ - name: Configure pnpm
+ run: |
+ pnpm config set auto-install-peers true
+ pnpm config set exclude-links-from-lockfile true
+
+ - name: Install dependencies
+ run: pnpm install --frozen-lockfile
+
+ - name: Set up Python
+ id: setup-python
+ uses: actions/setup-python@v5
+ with:
+ python-version: "3.8"
+
+ - name: Install and configure Poetry
+ uses: snok/install-poetry@v1
+ with:
+ version: 1.5.1
+ virtualenvs-create: true
+ virtualenvs-in-project: true
+ installer-parallel: true
+
+ - name: Install dependencies
+ working-directory: ./packages/python-sdk
+ run: poetry install --no-interaction --no-root
+
+ - name: Generate Python SDK API reference
+ id: python-sdk-api-ref
+ working-directory: ./packages/python-sdk
+ run: |
+ source .venv/bin/activate
+ ./scripts/generate_api_ref.sh
+
+ - name: Generate JS SDK API reference
+ id: js-sdk-api-ref
+ working-directory: packages/js-sdk
+ run: ./scripts/generate_api_ref.sh
+
+ - name: Generate CLI API reference
+ id: cli-api-ref
+ working-directory: packages/cli
+ run: ./scripts/generate_api_ref.sh
+
+ - name: Show docs file structure
+ run: tree apps/web/src/app/\(docs\)/docs/api-reference
+
+ - name: Commit new SDK API reference versions
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ git config user.name "github-actions[bot]"
+ git config user.email "github-actions[bot]@users.noreply.github.com"
+ git add apps/web/src/app/\(docs\)/docs/api-reference
+ git commit -m "[skip ci] Release new SDK API reference doc versions"
+ git push
\ No newline at end of file
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index bb1cee5e8..604210e8c 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -115,7 +115,7 @@ jobs:
secrets: inherit
release:
- needs: [python-tests, js-tests, cli-tests]
+ needs: [is_release, python-tests, js-tests, cli-tests]
if: always() && !contains(needs.*.result, 'failure') && needs.is_release.outputs.release == 'true'
name: Release
runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
index 8e12639e8..d2dd8fc7e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -287,3 +287,6 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
+
+# API reference artifacts
+api_ref/
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/auth/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/auth/page.mdx
new file mode 100644
index 000000000..5e547262c
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/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/api-reference/cli/v0.5.8/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/sandbox/page.mdx
new file mode 100644
index 000000000..060e6969c
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/sandbox/page.mdx
@@ -0,0 +1,84 @@
+# 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>
+```
+
+
+# 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. The available loggers are process, filesystem, terminal, network, file. Specify multiple loggers by separating them with a comma. [default: process,filesystem]`
+
+
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/template/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/template/page.mdx
new file mode 100644
index 000000000..48d3dcb2e
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.8/template/page.mdx
@@ -0,0 +1,90 @@
+# 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. `
+ - `-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>. `
+
+
+# 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 `
+
+
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/errors/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/errors/page.mdx
new file mode 100644
index 000000000..5f2546641
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/errors/page.mdx
@@ -0,0 +1,206 @@
+# errors
+
+## Classes
+
+### AuthenticationError
+
+Thrown when authentication fails.
+
+#### Constructors
+
+##### new AuthenticationError()
+
+> **new AuthenticationError**(`message`): `AuthenticationError`
+
+###### Parameters
+
+• **message**: `any`
+
+###### Returns
+
+`AuthenticationError`
+
+###### Defined in
+
+errors.ts:72
+
+***
+
+### InvalidArgumentError
+
+Thrown when an invalid argument is provided.
+
+#### Constructors
+
+##### new InvalidArgumentError()
+
+> **new InvalidArgumentError**(`message`): `InvalidArgumentError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`InvalidArgumentError`
+
+###### Defined in
+
+errors.ts:42
+
+***
+
+### NotEnoughSpaceError
+
+Thrown when there is not enough disk space.
+
+#### Constructors
+
+##### new NotEnoughSpaceError()
+
+> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`NotEnoughSpaceError`
+
+###### Defined in
+
+errors.ts:52
+
+***
+
+### NotFoundError
+
+Thrown when a resource is not found.
+
+#### Constructors
+
+##### new NotFoundError()
+
+> **new NotFoundError**(`message`): `NotFoundError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`NotFoundError`
+
+###### Defined in
+
+errors.ts:62
+
+***
+
+### SandboxError
+
+Thrown when a sandbox error occurs.
+
+Base class for all sandbox errors.
+
+#### Extended by
+
+- `TimeoutError`
+- `InvalidArgumentError`
+- `NotEnoughSpaceError`
+- `NotFoundError`
+- `AuthenticationError`
+- `TemplateError`
+
+#### Constructors
+
+##### new SandboxError()
+
+> **new SandboxError**(`message`): `SandboxError`
+
+###### Parameters
+
+• **message**: `any`
+
+###### Returns
+
+`SandboxError`
+
+###### Defined in
+
+errors.ts:14
+
+***
+
+### TemplateError
+
+Thrown when the template uses old envd version. It isn't compatible with the new SDK.
+
+#### Constructors
+
+##### new TemplateError()
+
+> **new TemplateError**(`message`): `TemplateError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`TemplateError`
+
+###### Defined in
+
+errors.ts:82
+
+***
+
+### 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 process, watch, etc.
+
+The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.
+
+#### Constructors
+
+##### new TimeoutError()
+
+> **new TimeoutError**(`message`): `TimeoutError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`TimeoutError`
+
+###### Defined in
+
+errors.ts:32
+
+## Functions
+
+### formatSandboxTimeoutError()
+
+> **formatSandboxTimeoutError**(`message`): `TimeoutError`
+
+#### Parameters
+
+• **message**: `string`
+
+#### Returns
+
+`TimeoutError`
+
+#### Defined in
+
+errors.ts:2
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/filesystem/page.mdx
new file mode 100644
index 000000000..0cc2ef1d2
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/filesystem/page.mdx
@@ -0,0 +1,359 @@
+# sandbox/filesystem
+
+## Enumerations
+
+### FileType
+
+#### Enumeration Members
+
+##### DIR
+
+> **DIR**: `"dir"`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:32
+
+##### FILE
+
+> **FILE**: `"file"`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:31
+
+## Classes
+
+### Filesystem
+
+#### Constructors
+
+##### new Filesystem()
+
+> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem`
+
+###### Parameters
+
+• **transport**: `Transport`
+
+• **envdApi**: `EnvdApiClient`
+
+• **connectionConfig**: `ConnectionConfig`
+
+###### Returns
+
+`Filesystem`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:58
+
+#### Methods
+
+##### exists()
+
+> **exists**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:212
+
+##### list()
+
+> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`[]\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:130
+
+##### makeDir()
+
+> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:157
+
+##### read()
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`string`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`string`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:66
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`Uint8Array`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:67
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Blob`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`Blob`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:68
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:69
+
+##### remove()
+
+> **remove**(`path`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:201
+
+##### rename()
+
+> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\>
+
+###### Parameters
+
+• **oldPath**: `string`
+
+• **newPath**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:176
+
+##### watch()
+
+> **watch**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **onEvent**
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`WatchHandle`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:231
+
+##### write()
+
+> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\>
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:96
+
+## Interfaces
+
+### EntryInfo
+
+#### Properties
+
+##### name
+
+> **name**: `string`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:25
+
+##### path
+
+> **path**: `string`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:27
+
+##### type
+
+> **type**: `FileType`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:26
+
+***
+
+### FilesystemRequestOpts
+
+#### Extended by
+
+- `WatchOpts`
+
+#### Properties
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:11
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:45
+
+***
+
+### WatchOpts
+
+#### Properties
+
+##### onExit()?
+
+> `optional` **onExit**: (`err`) => `void`
+
+###### Parameters
+
+• **err**: `Error`
+
+###### Returns
+
+`void`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:50
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:11
+
+##### timeout?
+
+> `optional` **timeout**: `number`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:49
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:45
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/process/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/process/page.mdx
new file mode 100644
index 000000000..354462a37
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/process/page.mdx
@@ -0,0 +1,23 @@
+# sandbox/process
+
+## References
+
+### Process
+
+Re-exports Process
+
+### ProcessConnectOpts
+
+Re-exports ProcessConnectOpts
+
+### ProcessInfo
+
+Re-exports ProcessInfo
+
+### ProcessRequestOpts
+
+Re-exports ProcessRequestOpts
+
+### ProcessStartOpts
+
+Re-exports ProcessStartOpts
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/pty/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/pty/page.mdx
new file mode 100644
index 000000000..0b4bc9bd5
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/pty/page.mdx
@@ -0,0 +1,165 @@
+# sandbox/pty
+
+## Classes
+
+### Pty
+
+#### Constructors
+
+##### new Pty()
+
+> **new Pty**(`transport`, `connectionConfig`): `Pty`
+
+###### Parameters
+
+• **transport**: `Transport`
+
+• **connectionConfig**: `ConnectionConfig`
+
+###### Returns
+
+`Pty`
+
+###### Defined in
+
+sandbox/pty.ts:29
+
+#### Methods
+
+##### create()
+
+> **create**(`opts`): `Promise`\<`ProcessHandle`\>
+
+###### Parameters
+
+• **opts**: `PtyCreateOpts`
+
+###### Returns
+
+`Promise`\<`ProcessHandle`\>
+
+###### Defined in
+
+sandbox/pty.ts:33
+
+##### resize()
+
+> **resize**(`pid`, `size`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **pid**: `number`
+
+• **size**
+
+• **size.cols**: `number`
+
+• **size.rows?**: `number`
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:100
+
+##### sendInput()
+
+> **sendInput**(`pid`, `data`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **pid**: `number`
+
+• **data**: `Uint8Array`
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:77
+
+## Interfaces
+
+### PtyCreateOpts
+
+#### Properties
+
+##### cols
+
+> **cols**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:17
+
+##### cwd?
+
+> `optional` **cwd**: `string`
+
+###### Defined in
+
+sandbox/pty.ts:23
+
+##### envs?
+
+> `optional` **envs**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/pty.ts:22
+
+##### onData()
+
+> **onData**: (`data`) => `void` \| `Promise`\<`void`\>
+
+###### Parameters
+
+• **data**: `Uint8Array`
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:19
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:11
+
+##### rows
+
+> **rows**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:18
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:20
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/pty.ts:21
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/sandbox/page.mdx
new file mode 100644
index 000000000..ae11c69f2
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.51/sandbox/page.mdx
@@ -0,0 +1,367 @@
+# sandbox
+
+## Classes
+
+### Sandbox
+
+#### Constructors
+
+##### new Sandbox()
+
+> **new Sandbox**(`opts`): `Sandbox`
+
+###### Parameters
+
+• **opts**: `Omit`\<`SandboxOpts`, `"metadata"` \| `"envs"` \| `"timeoutMs"`\> & `object`
+
+###### Returns
+
+`Sandbox`
+
+###### Defined in
+
+sandbox/index.ts:33
+
+#### Properties
+
+##### commands
+
+> `readonly` **commands**: `Process`
+
+###### Defined in
+
+sandbox/index.ts:22
+
+##### files
+
+> `readonly` **files**: `Filesystem`
+
+###### Defined in
+
+sandbox/index.ts:21
+
+##### pty
+
+> `readonly` **pty**: `Pty`
+
+###### Defined in
+
+sandbox/index.ts:23
+
+##### sandboxId
+
+> `readonly` **sandboxId**: `string`
+
+###### Defined in
+
+sandbox/index.ts:25
+
+#### Methods
+
+##### downloadUrl()
+
+> **downloadUrl**(`path`): `string`
+
+###### Parameters
+
+• **path**: `string`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:125
+
+##### getHost()
+
+> **getHost**(`port`): `string`
+
+###### Parameters
+
+• **port**: `number`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:76
+
+##### isRunning()
+
+> **isRunning**(`opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/index.ts:84
+
+##### kill()
+
+> **kill**(`opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:112
+
+##### setTimeout()
+
+> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **timeoutMs**: `number`
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:103
+
+##### uploadUrl()
+
+> **uploadUrl**(`path`?): `string`
+
+###### Parameters
+
+• **path?**: `string`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:121
+
+##### connect()
+
+> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **sandboxId**: `string`
+
+• **opts?**: `Omit`\<`SandboxOpts`, `"metadata"` \| `"envs"` \| `"timeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:69
+
+##### create()
+
+###### create(this, opts)
+
+> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **opts?**: `SandboxOpts`
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:52
+
+###### create(this, template, opts)
+
+> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **template**: `string`
+
+• **opts?**: `SandboxOpts`
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:53
+
+##### kill()
+
+> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\>
+
+Kills sandbox specified by sandbox ID.
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+Sandbox ID.
+
+• **opts?**: `SandboxApiOpts`
+
+Connection options.
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:47
+
+##### list()
+
+> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\>
+
+###### Parameters
+
+• **opts?**: `SandboxApiOpts`
+
+###### Returns
+
+`Promise`\<`SandboxInfo`[]\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:72
+
+##### setTimeout()
+
+> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+• **timeoutMs**: `number`
+
+• **opts?**: `SandboxApiOpts`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:94
+
+## Interfaces
+
+### SandboxOpts
+
+#### Properties
+
+##### accessToken?
+
+> `optional` **accessToken**: `string`
+
+###### Defined in
+
+connectionConfig.ts:8
+
+##### apiKey?
+
+> `optional` **apiKey**: `string`
+
+###### Defined in
+
+connectionConfig.ts:7
+
+##### debug?
+
+> `optional` **debug**: `boolean`
+
+###### Defined in
+
+connectionConfig.ts:10
+
+##### domain?
+
+> `optional` **domain**: `string`
+
+###### Defined in
+
+connectionConfig.ts:9
+
+##### envs?
+
+> `optional` **envs**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/index.ts:13
+
+##### logger?
+
+> `optional` **logger**: `Logger`
+
+###### Defined in
+
+connectionConfig.ts:12
+
+##### metadata?
+
+> `optional` **metadata**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/index.ts:12
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:11
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+###### Defined in
+
+sandbox/index.ts:14
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/exceptions/page.mdx
new file mode 100644
index 000000000..b0b6e6089
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/exceptions/page.mdx
@@ -0,0 +1,75 @@
+
+
+
+## SandboxException Objects
+
+```python
+class SandboxException(Exception)
+```
+
+Raised when a sandbox exception occurs.
+
+Base class for all sandbox errors.
+
+
+## TimeoutException Objects
+
+```python
+class TimeoutException(SandboxException)
+```
+
+Raised when a timeout occurs.
+
+The [unavailable] exception type is caused by sandbox timeout.
+
+The [canceled] exception type is caused by exceeding request timeout.
+
+The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc.
+
+The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly.
+
+
+## NotEnoughSpaceException Objects
+
+```python
+class NotEnoughSpaceException(SandboxException)
+```
+
+Raised when there is not enough disk space.
+
+
+## NotFoundException Objects
+
+```python
+class NotFoundException(SandboxException)
+```
+
+Raised when a resource is not found.
+
+
+## InvalidArgumentException Objects
+
+```python
+class InvalidArgumentException(SandboxException)
+```
+
+Raised when an invalid argument is provided.
+
+
+## AuthenticationException Objects
+
+```python
+class AuthenticationException(SandboxException)
+```
+
+Raised when authentication fails.
+
+
+## TemplateException Objects
+
+```python
+class TemplateException(SandboxException)
+```
+
+Exception raised when the template uses old envd version. It isn't compatible with the new SDK.
+
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx
new file mode 100644
index 000000000..c30a981d6
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx
@@ -0,0 +1,337 @@
+
+
+
+## Filesystem Objects
+
+```python
+class Filesystem()
+```
+
+
+#### read
+
+```python
+async def read(path: str,
+ format: Literal["text", "bytes", "stream"] = "text",
+ user: Username = "user",
+ request_timeout: Optional[float] = None)
+```
+
+Read from file
+
+
+#### write
+
+```python
+async def write(path: str,
+ data: Union[str, bytes, IO],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
+```
+
+Write to file
+When writing to a file that doesn't exist, the file will get created.
+When writing to a file that already exists, the file will get overwritten.
+When writing to a file that's in a directory that doesn't exist, you'll get an error.
+
+
+#### list
+
+```python
+async def list(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> List[EntryInfo]
+```
+
+List directory
+
+
+#### exists
+
+```python
+async def exists(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
+```
+
+Check if file exists.
+
+
+#### remove
+
+```python
+async def remove(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> None
+```
+
+Remove file
+
+
+#### rename
+
+```python
+async def rename(old_path: str,
+ new_path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
+```
+
+Rename file
+
+
+#### make\_dir
+
+```python
+async def make_dir(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
+```
+
+Create directory and all parent directories
+
+
+#### watch
+
+```python
+async def watch(path: str,
+ on_event: OutputHandler[FilesystemEvent],
+ on_exit: Optional[OutputHandler[Exception]] = None,
+ user: Username = "user",
+ request_timeout: Optional[float] = None,
+ timeout: Optional[float] = 60)
+```
+
+Watch directory for changes
+
+
+
+
+
+
+
+
+## Process Objects
+
+```python
+class Process()
+```
+
+
+#### list
+
+```python
+async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
+```
+
+List processes
+
+
+#### kill
+
+```python
+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+```
+
+Kill process
+
+
+#### send\_stdin
+
+```python
+async def send_stdin(pid: int,
+ data: str,
+ request_timeout: Optional[float] = None)
+```
+
+Send stdin
+
+
+#### run
+
+```python
+async def run(cmd: str,
+ background: Union[bool, None] = None,
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: Optional[OutputHandler[Stdout]] = None,
+ on_stderr: Optional[OutputHandler[Stderr]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None)
+```
+
+Run command
+
+
+
+
+
+
+## Pty Objects
+
+```python
+class Pty()
+```
+
+
+#### kill
+
+```python
+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+```
+
+Kill process by PID
+
+
+#### send\_stdin
+
+```python
+async def send_stdin(pid: int,
+ data: bytes,
+ request_timeout: Optional[float] = None)
+```
+
+Send data to process stdin
+
+
+#### create
+
+```python
+async def create(
+ size: PtySize,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_data: Optional[Callable[[bytes], None]] = None,
+ envs: Optional[Dict[str, str]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> AsyncProcessHandle
+```
+
+Create new PTY process
+
+
+#### resize
+
+```python
+async def resize(pid: int,
+ size: PtySize,
+ request_timeout: Optional[float] = None)
+```
+
+Resize PTY
+
+
+
+
+
+
+## AsyncSandbox Objects
+
+```python
+class AsyncSandbox(SandboxSetup, SandboxApi)
+```
+
+
+#### files
+
+```python
+@property
+def files() -> Filesystem
+```
+
+Get a Filesystem Object
+
+
+#### commands
+
+```python
+@property
+def commands() -> Process
+```
+
+Get a Process Object
+
+
+#### sandbox\_id
+
+```python
+@property
+def sandbox_id() -> str
+```
+
+Get the sandbox ID
+
+
+#### envd\_api\_url
+
+```python
+@property
+def envd_api_url() -> str
+```
+
+Get the sanbox API URL
+
+
+#### connection\_config
+
+```python
+@property
+def connection_config() -> ConnectionConfig
+```
+
+Get the ConnectionConfig Object
+
+
+#### \_\_init\_\_
+
+```python
+def __init__(**opts: Unpack[AsyncSandboxOpts])
+```
+
+Instantiate sandbox
+
+
+#### is\_running
+
+```python
+async def is_running(request_timeout: Optional[float] = None) -> bool
+```
+
+Check if sandbox is running
+
+
+#### connect
+
+```python
+@classmethod
+async def connect(cls,
+ sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None)
+```
+
+Connect to a running sandbox
+
+
+#### kill
+
+```python
+@class_method_variant("_cls_kill")
+async def kill(request_timeout: Optional[float] = None) -> bool
+```
+
+Kill sandbox
+
+
+#### set\_timeout
+
+```python
+@class_method_variant("_cls_set_timeout")
+async def set_timeout(timeout: int,
+ request_timeout: Optional[float] = None) -> None
+```
+
+Configure request timeout
+
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_sync/page.mdx
new file mode 100644
index 000000000..ef5f237b7
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_sync/page.mdx
@@ -0,0 +1,347 @@
+
+
+
+## Filesystem Objects
+
+```python
+class Filesystem()
+```
+
+
+#### read
+
+```python
+def read(path: str,
+ format: Literal["text", "bytes", "stream"] = "text",
+ user: Username = "user",
+ request_timeout: Optional[float] = None)
+```
+
+Read from file
+
+
+#### write
+
+```python
+def write(path: str,
+ data: Union[str, bytes, IO],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
+```
+
+Write to file
+When writing to a file that doesn't exist, the file will get created.
+When writing to a file that already exists, the file will get overwritten.
+When writing to a file that's in a directory that doesn't exist, you'll get an error.
+
+
+#### list
+
+```python
+def list(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> List[EntryInfo]
+```
+
+List directory
+
+
+#### exists
+
+```python
+def exists(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
+```
+
+Check if file exists.
+
+
+#### remove
+
+```python
+def remove(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> None
+```
+
+Remove file
+
+
+#### rename
+
+```python
+def rename(old_path: str,
+ new_path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
+```
+
+Rename file
+
+
+#### make\_dir
+
+```python
+def make_dir(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
+```
+
+Create directory and all parent directories
+
+
+#### watch
+
+```python
+def watch(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None,
+ timeout: Optional[float] = 60)
+```
+
+Watch directory for changes.
+
+
+
+
+
+
+
+
+## Process Objects
+
+```python
+class Process()
+```
+
+
+#### list
+
+```python
+def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
+```
+
+List processes
+
+
+#### kill
+
+```python
+def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+```
+
+Kill process
+
+
+#### send\_stdin
+
+```python
+def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None)
+```
+
+Send stdin
+
+
+#### run
+
+```python
+def run(cmd: str,
+ background: Union[bool, None] = None,
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: Optional[Callable[[str], None]] = None,
+ on_stderr: Optional[Callable[[str], None]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None)
+```
+
+Run command
+
+
+#### connect
+
+```python
+def connect(pid: int,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None)
+```
+
+Connect to process
+
+
+
+
+## Pty Objects
+
+```python
+class Pty()
+```
+
+
+#### kill
+
+```python
+def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+```
+
+Kill process by PID
+
+
+#### send\_stdin
+
+```python
+def send_stdin(pid: int,
+ data: bytes,
+ request_timeout: Optional[float] = None) -> None
+```
+
+Send data to process stdin
+
+
+#### create
+
+```python
+def create(size: PtySize,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ envs: Optional[Dict[str, str]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> ProcessHandle
+```
+
+Create new PTY process
+
+
+#### resize
+
+```python
+def resize(pid: int,
+ size: PtySize,
+ request_timeout: Optional[float] = None) -> None
+```
+
+Resize PTY
+
+
+
+
+
+
+## Sandbox Objects
+
+```python
+class Sandbox(SandboxSetup, SandboxApi)
+```
+
+
+#### files
+
+```python
+@property
+def files() -> Filesystem
+```
+
+Get a Filesystem Object
+
+
+#### commands
+
+```python
+@property
+def commands() -> Process
+```
+
+Get a Process Object
+
+
+#### sandbox\_id
+
+```python
+@property
+def sandbox_id() -> str
+```
+
+Get the sandbox ID
+
+
+#### envd\_api\_url
+
+```python
+@property
+def envd_api_url() -> str
+```
+
+Get the sanbox API URL
+
+
+#### connection\_config
+
+```python
+@property
+def connection_config() -> ConnectionConfig
+```
+
+Get the ConnectionConfig Object
+
+
+#### \_\_init\_\_
+
+```python
+def __init__(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)
+```
+
+Instantiate sandbox
+
+
+#### is\_running
+
+```python
+def is_running(request_timeout: Optional[float] = None) -> bool
+```
+
+Check if sandbox is running
+
+
+#### connect
+
+```python
+@classmethod
+def connect(cls,
+ sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None)
+```
+
+Connect to a running sandbox
+
+
+#### kill
+
+```python
+@class_method_variant("_cls_kill")
+def kill(request_timeout: Optional[float] = None) -> bool
+```
+
+Kill sandbox
+
+
+#### set\_timeout
+
+```python
+@class_method_variant("_cls_set_timeout")
+def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None
+```
+
+Configure sandbox timeout
+
diff --git a/packages/cli/scripts/generate_api_ref.sh b/packages/cli/scripts/generate_api_ref.sh
index 8cb0ffa2f..51a1b8414 100755
--- a/packages/cli/scripts/generate_api_ref.sh
+++ b/packages/cli/scripts/generate_api_ref.sh
@@ -8,14 +8,18 @@ mkdir -p api_ref
npx tsup && echo && NODE_ENV=development node dist/index.js -cmd2md
-# move to docs (for later use)
-#for file in api_ref/*.md; do
-# # Extract the filename without extension
-# filename=$(basename "$file" .md)
-#
-# # Create the directory if it doesn't exist
-# mkdir -p "../../apps/web/src/app/(docs)/docs/api-reference/cli/$filename"
-#
-# # Move the file to the new location and rename it to page.mdx
-# mv "$file" "../../apps/web/src/app/(docs)/docs/api-reference/cli/$filename/page.mdx"
-#done
+PKG_VERSION="v$(node -p "require('./package.json').version")"
+
+# move to docs web app
+for file in api_ref/*.md; do
+ # Extract the filename without extension
+ filename=$(basename "$file" .md)
+
+ # Create the directory if it doesn't exist
+ mkdir -p "../../apps/web/src/app/(docs)/docs/api-reference/cli/${PKG_VERSION}/${filename}"
+
+ # Move the file to the new location and rename it to page.mdx
+ mv "$file" "../../apps/web/src/app/(docs)/docs/api-reference/cli/${PKG_VERSION}/${filename}/page.mdx"
+done
+
+rm -rf api_ref
diff --git a/packages/js-sdk/scripts/generate_api_ref.sh b/packages/js-sdk/scripts/generate_api_ref.sh
index dfd0926b2..bd822ed2e 100755
--- a/packages/js-sdk/scripts/generate_api_ref.sh
+++ b/packages/js-sdk/scripts/generate_api_ref.sh
@@ -8,20 +8,29 @@ set -euo pipefail
# generate raw api reference markdown files
npx typedoc
-# move to docs (for later use)
-#mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/sandbox
-#mv api_ref/sandbox.md ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/sandbox/page.mdx
-#
-#mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/errors
-#mv api_ref/errors.md ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/errors/page.mdx
-#
-#mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/filesystem
-#mv api_ref/sandbox/filesystem.md ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/filesystem/page.mdx
-#
-#mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/process
-#mv api_ref/sandbox/process.md ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/process/page.mdx
-#
-#mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/pty
-#mv api_ref/sandbox/pty.md ../../apps/web/src/app/\(docs\)/docs/api-reference/js-sdk/pty/page.mdx
-#
-#rm -rf api_ref
+PKG_VERSION="v$(node -p "require('./package.json').version")"
+ROUTES_DIR="../../apps/web/src/app/(docs)/docs/api-reference/js-sdk/${PKG_VERSION}"
+# move to docs web app
+mkdir -p "${ROUTES_DIR}"
+
+rm -rf api_ref/README.md
+
+# Flatten the api_ref directory by moving all nested files to the root level and remove empty subdirectories
+find api_ref -mindepth 2 -type f | while read -r file; do
+ mv "$file" api_ref/
+done
+find api_ref -type d -empty -delete
+
+# Transfrom top level MD files into folders of the same name with page.mdx inside
+find api_ref -maxdepth 1 -type f -name "*.md" | while read -r file; do
+ # Extract the filename without extension
+ filename=$(basename "$file" .md)
+ # Create the directory of the same name in api_ref
+ mkdir -p "api_ref/${filename}"
+ # Move the file inside the newly created directory
+ mv "$file" "api_ref/${filename}/page.mdx"
+done
+
+cp -r api_ref/* "${ROUTES_DIR}"
+
+rm -rf api_ref
diff --git a/packages/python-sdk/e2b/sandbox_async/pty/main.py b/packages/python-sdk/e2b/sandbox_async/pty/main.py
index d52c2d4d2..ccfcb7054 100644
--- a/packages/python-sdk/e2b/sandbox_async/pty/main.py
+++ b/packages/python-sdk/e2b/sandbox_async/pty/main.py
@@ -1,15 +1,11 @@
+from typing import Callable, Dict, Optional
+
import e2b_connect
import httpcore
-
-from typing import Dict, Optional, Callable
-
+from e2b.connection_config import ConnectionConfig, Username
from e2b.envd.process import process_connect, process_pb2
-from e2b.connection_config import (
- Username,
- ConnectionConfig,
-)
-from e2b.exceptions import SandboxException
from e2b.envd.rpc import authentication_header, handle_rpc_exception
+from e2b.exceptions import SandboxException
from e2b.sandbox.process.process_handle import PtySize
from e2b.sandbox_async.process.process_handle import AsyncProcessHandle
@@ -34,6 +30,7 @@ class Pty:
pid: int,
request_timeout: Optional[float] = None,
) -> bool:
+ """Kill process by PID"""
try:
await self._rpc.asend_signal(
process_pb2.SendSignalRequest(
@@ -57,6 +54,7 @@ class Pty:
data: bytes,
request_timeout: Optional[float] = None,
):
+ """Send data to process stdin"""
try:
await self._rpc.asend_input(
process_pb2.SendInputRequest(
@@ -82,6 +80,7 @@ class Pty:
timeout: Optional[float] = 60,
request_timeout: Optional[float] = None,
) -> AsyncProcessHandle:
+ """Create new PTY process"""
envs = envs or {}
envs["TERM"] = "xterm-256color"
events = self._rpc.astart(
@@ -123,6 +122,7 @@ class Pty:
async def resize(
self, pid: int, size: PtySize, request_timeout: Optional[float] = None
):
+ """Resize PTY"""
await self._rpc.aupdate(
process_pb2.UpdateRequest(
process=process_pb2.ProcessSelector(pid=pid),
diff --git a/packages/python-sdk/e2b/sandbox_sync/pty/main.py b/packages/python-sdk/e2b/sandbox_sync/pty/main.py
index 3d4cbc761..81f5d0e47 100644
--- a/packages/python-sdk/e2b/sandbox_sync/pty/main.py
+++ b/packages/python-sdk/e2b/sandbox_sync/pty/main.py
@@ -34,6 +34,7 @@ class Pty:
pid: int,
request_timeout: Optional[float] = None,
) -> bool:
+ """Kill process by PID"""
try:
self._rpc.send_signal(
process_pb2.SendSignalRequest(
@@ -57,6 +58,7 @@ class Pty:
data: bytes,
request_timeout: Optional[float] = None,
) -> None:
+ """Send data to process stdin"""
try:
self._rpc.send_input(
process_pb2.SendInputRequest(
@@ -81,6 +83,7 @@ class Pty:
timeout: Optional[float] = 60,
request_timeout: Optional[float] = None,
) -> ProcessHandle:
+ """Create new PTY process"""
envs = envs or {}
envs["TERM"] = "xterm-256color"
events = self._rpc.start(
@@ -121,6 +124,7 @@ class Pty:
def resize(
self, pid: int, size: PtySize, request_timeout: Optional[float] = None
) -> None:
+ """Resize PTY"""
self._rpc.update(
process_pb2.UpdateRequest(
process=process_pb2.ProcessSelector(pid=pid),
diff --git a/packages/python-sdk/scripts/generate_api_ref.sh b/packages/python-sdk/scripts/generate_api_ref.sh
index 211333b04..c174fd644 100755
--- a/packages/python-sdk/scripts/generate_api_ref.sh
+++ b/packages/python-sdk/scripts/generate_api_ref.sh
@@ -5,17 +5,24 @@ set -euo pipefail
# This script generates the python sdk api reference markdown files
# Run it in the `python-sdk/` directory
+PKG_VERSION="v$(node -p "require('./package.json').version")"
+
packages=("sandbox_sync" "sandbox_async" "exceptions")
-mkdir api_ref
+mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/python-sdk/${PKG_VERSION}
+
+mkdir -p api_ref
for package in "${packages[@]}"; do
# generate raw api reference markdown file
- pydoc-markdown -p e2b.${package} >api_ref/${package}.mdx
+ pydoc-markdown -p e2b."${package}" >api_ref/"${package}".mdx
# remove package path display
- sed -i '' '/<a[^>]*>.*<\/a>/d' api_ref/${package}.mdx
+ sed -i '/<a[^>]*>.*<\/a>/d' api_ref/"${package}".mdx
# remove empty hyperlinks
- sed -i '' '/^# /d' api_ref/${package}.mdx
- # move to docs (for later use)
- # mv api_ref/${package}.mdx ../../apps/web/src/app/\(docs\)/docs/api-reference/python-sdk/${package}/page.mdx
+ sed -i '/^# /d' "api_ref/${package}.mdx"
+ # move to docs
+ mkdir -p "../../apps/web/src/app/(docs)/docs/api-reference/python-sdk/${PKG_VERSION}/${package}"
+ mv "api_ref/${package}.mdx" "../../apps/web/src/app/(docs)/docs/api-reference/python-sdk/${PKG_VERSION}/${package}/page.mdx"
done
+
+rm -rf api_ref
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index dd0c4c1fb..92a65abb2 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -359,7 +359,13 @@ importers:
version: 6.7.6
tsup:
specifier: ^8.0.2
+ typedoc:
+ specifier: ^0.26.7
+ version: 0.26.7([email protected])
+ typedoc-plugin-markdown:
+ specifier: ^4.2.7
typescript:
specifier: ^5.4.5
version: 5.5.3
@@ -2199,6 +2205,21 @@ packages:
peerDependencies:
webpack: '>=4.40.0'
+ '@shikijs/[email protected]':
+ resolution: {integrity: sha512-VK4BNVCd2leY62Nm2JjyxtRLkyrZT/tv104O81eyaCjHq4Adceq2uJVFJJAIof6lT1mBwZrEo2qT/T+grv3MQQ==}
+
+ '@shikijs/[email protected]':
+ resolution: {integrity: sha512-qoP/aO/ATNwYAUw1YMdaip/YVEstMZEgrwhePm83Ll9OeQPuxDZd48szZR8oSQNQBT8m8UlWxZv8EA3lFuyI5A==}
+
+ '@shikijs/[email protected]':
+ resolution: {integrity: sha512-B9u0ZKI/cud+TcmF8Chyh+R4V5qQVvyDOqXC2l2a4x73PBSBc6sZ0JRAX3eqyJswqir6ktwApUUGBYePdKnMJg==}
+
+ '@shikijs/[email protected]':
+ resolution: {integrity: sha512-O9N36UEaGGrxv1yUrN2nye7gDLG5Uq0/c1LyfmxsvzNPqlHzWo9DI0A4+fhW2y3bGKuQu/fwS7EPdKJJCowcVA==}
+
+ '@shikijs/[email protected]':
+ resolution: {integrity: sha512-TMp15K+GGYrWlZM8+Lnj9EaHEFmOen0WJBrfa17hF7taDOYthuPPV0GWzfd/9iMij0akS/8Yw2ikquH7uVi/fg==}
+
'@sigstore/[email protected]':
resolution: {integrity: sha512-PFutXEy0SmQxYI4texPw3dd2KewuNqv7OuK1ZFtY2fM754yhvG2KdgwIhRnoEE2uHdtdGNQ8s0lb94dW9sELog==}
engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0}
@@ -2414,6 +2435,9 @@ packages:
resolution: {integrity: sha512-47rJE80oqPmFdVDCD7IheXBrVdwuBgsYwoczFvKmwfo2Mzsnt+V9OONsYauFmICb6lQPpCuXYJWejBNs4pDJRg==}
+ '@types/[email protected]':
+ resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==}
+
resolution: {integrity: sha512-V46MYLFp08Wf2mmaBhvgjStM3tPa+2GAdy/iqoX+noX1//zje2x4XmrIU0cAwyClATsTmahbtoQ2EwP7I5WSiA==}
@@ -2435,6 +2459,9 @@ packages:
resolution: {integrity: sha512-DT+iNIRNX884cx0/Q1ja7NyUPpZuv0KPyL5rGNxm1WC1OtHstl7n4Jb7nk+xacNShQMbczJjt8uFzznpp6kYBg==}
+ '@types/[email protected]':
+ resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==}
+
resolution: {integrity: sha512-r7/zWe+f9x+zjXqGxf821qz++ld8tp6Z4jUS6qmPZUXH6tfh4riXOhAqb12tWGWAevCFtMt1goLWkQMqIJKpsA==}
@@ -2504,6 +2531,9 @@ packages:
resolution: {integrity: sha512-d0XxK3YTObnWVp6rZuev3c49+j4Lo8g4L1ZRm9z5L0xpoZycUPshHgczK5gsUMaZOstjVYYi09p5gYvUtfChYw==}
+ '@types/[email protected]':
+ resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==}
+
resolution: {integrity: sha512-uUOhxsJ3edPHu06r3k4I2yJ4eoyqBt+53ra9+caXEx0ruoPwqNHTlkq75CUvI4yWsrCA5+31tih+opunLCYnXw==}
@@ -2684,6 +2714,9 @@ packages:
resolution: {integrity: sha512-Qlzzx4sE4u3FsHTPQAAQFJFNOuqtuY0LFrZHwQ8IHK705XxBiWOFkfKRWu6niB7hwfgnwIpO4jTC75ozW1PHWg==}
engines: {node: ^18.18.0 || >=20.0.0}
+ '@ungap/[email protected]':
+ resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==}
+
'@vercel/[email protected]':
resolution: {integrity: sha512-BZFxVrv24VbNNl5xMxqUojQIegEeXMI6rX3rg1uVLYUEXsuKNBSAEQf4BWEcjQDp/8aYJOj6m8V4PUA3x/cxgg==}
@@ -3555,6 +3588,9 @@ packages:
resolution: {integrity: sha512-ypdmJU/TbBby2Dxibuv7ZLW3Bs1QEmM7nHjEANfohJLvE0XVujisn1qPJcZxg+qDucsr+bP6fLD1rPS3AhJ7EQ==}
+ resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==}
+
resolution: {integrity: sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw==}
@@ -3640,6 +3676,10 @@ packages:
resolution: {integrity: sha512-rRqJg/6gd538VHvR3PSrdRBb/1Vy2YfzHqzvbhGIQpDRKIa4FgV/54b5Q1xYSxOOwKvjXweS26E0Q+nAMwp2pQ==}
engines: {node: '>=8.6'}
+ resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==}
+ engines: {node: '>=0.12'}
+
resolution: {integrity: sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==}
engines: {node: '>=6'}
@@ -4242,9 +4282,15 @@ packages:
resolution: {integrity: sha512-ihhPIUPxN0v0w6M5+IiAZZrn0LH2uZomeWwhn7uP7avZC6TE7lIiEh2yBMPr5+zi1aUCXq6VoYRgs2Bw9xmycQ==}
+ resolution: {integrity: sha512-M17uBDzMJ9RPCqLMO92gNNUDuBSq10a25SDBI08iCCxmorf4Yy6sYHK57n9WAbRAAaU+DuR4W6GN9K4DFZesYg==}
+
resolution: {integrity: sha512-nAxA0v8+vXSBDt3AnRUNjyRIQ0rD+ntpbAp4LnPkumc5M9yUbSMa4XDU9Q6etY4f1Wp4bNgvc1yjiZtsTTrSng==}
+ resolution: {integrity: sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==}
+
resolution: {integrity: sha512-COpmrF2NOg4TBWUJ5UVyaCU2A88wEMkUPK4hNqyCkqHbxT92BbvfjoSozkAIIm6XhicGlJHhFdullInrdhwU8Q==}
@@ -4272,6 +4318,9 @@ packages:
resolution: {integrity: sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==}
engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0}
+ resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==}
+
resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==}
@@ -4810,6 +4859,9 @@ packages:
resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}
+ resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==}
+
resolution: {integrity: sha512-gUD/epcRms75Cw8RT1pUdHugZYM5ce64ucs2GEISABwkRsOQr0q2wm/MV2TKThycIe5e0ytRweW2RZxclogCdQ==}
engines: {node: '>=8'}
@@ -4922,6 +4974,9 @@ packages:
peerDependencies:
react: ^16.5.1 || ^17.0.0 || ^18.0.0
+ resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==}
+
resolution: {integrity: sha512-c4BEos3y6G2qO0B9X7K0FVLOPT9uGrjYwYRLFmDqyl5YMboUviyecnXWp94fJTSMwPw2/sf+CEYt5AGpmklkkQ==}
@@ -4957,6 +5012,10 @@ packages:
resolution: {integrity: sha512-WWC0ZuMzCyDHYCasEGs4IPvLyTGftYwh6wIEOULOF0HXcqZlhwRzrK0w2VUlxWA98xnvb/jszw4ZSkJ6ADpM6Q==}
engines: {node: '>=0.10.0'}
+ resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==}
+ hasBin: true
+
resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==}
@@ -5005,12 +5064,18 @@ packages:
resolution: {integrity: sha512-pits93r8PhnIoU4Vy9bjW39M2jJ6/tdHyja9rrot9uujkN7UTU9SDnE6WNJz/IGyQk3XHX6yNNtrBH6cQzm8Hw==}
+ resolution: {integrity: sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==}
+
resolution: {integrity: sha512-bbv7TPv/WC49thZPg3jXuqzuvI45IL2EVAr/KxF0BSdHsU0ceFHOmwQn6evxAh1GaoK/6GQ1wp4R4oW2+LFL/A==}
resolution: {integrity: sha512-V4Zn/ncyN1QNSqSBxTrMOLpjr+IKdHl2v3KVLoWmDPscP4r9GcCi71gjgvUV1SFSKh92AjAG4peFuBl2/YgCJg==}
+ resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==}
+
resolution: {integrity: sha512-2XrOlQeBDUa8GirNHy/Y7BR1h/P+vzk+1G2rzAfqJ+lg6JcEOKMCqsVkpVFSw0hdzpVuj9BnoNeA+aU1XPTkoA==}
@@ -5096,6 +5161,9 @@ packages:
resolution: {integrity: sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==}
+ resolution: {integrity: sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==}
+
resolution: {integrity: sha512-Ye01HXpkZPNcV6FiyoW2fGZDUw4Yc7vT0E9Sad83+bEDiCJ1uXu0S3mr8WLpsz3HaG3x2q0HM6CTuPdcZcluFQ==}
@@ -5114,6 +5182,9 @@ packages:
resolution: {integrity: sha512-EuEzTWSTAj9PA5GOAs992GzNh2dGQO52UvAbtSOMvXTxv3Criqb6IOzJUBCmEqrrXSblJIJBbFFv6zPxpreiJw==}
+ resolution: {integrity: sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==}
+
resolution: {integrity: sha512-ij4X7Wuc4fED6UoLWkmo0xJQhsktfNh1J0m8g4PbIMPlx+ek/4YdW5mvbye8z/aZvAPUoxgXHrwVlXAPKMRp1w==}
@@ -5129,15 +5200,24 @@ packages:
resolution: {integrity: sha512-QO4GXv0XZfWey4pYFndLUKEAktKkG5kZTdUNaTAkzbuJxn2tNBOr+QtxR2XpWaMhbImT2dPzyLrPXLlPhph34A==}
+ resolution: {integrity: sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==}
+
resolution: {integrity: sha512-kUQHyzRoxvZO2PuLzMt2P/dwVsTiivCK8icYTeR+3WgbuPqfHgPPy7nFKbeqRivBvn/3N3GBiNC+JRTMSxEC7A==}
resolution: {integrity: sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==}
+ resolution: {integrity: sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==}
+
resolution: {integrity: sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==}
+ resolution: {integrity: sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==}
+
resolution: {integrity: sha512-uD66tJj54JLYq0De10AhWycZWGQNUvDI55xPgk2sQM5kn1JYlhbCMTtEeT27+vAhW2FBQxLlOmS3pmA7/2z4aA==}
@@ -5513,6 +5593,9 @@ packages:
resolution: {integrity: sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==}
engines: {node: '>=12'}
+ resolution: {integrity: sha512-X0jWUcAlxORhOqqBREgPMgnshB7ZGYszBNspP+tS9hPD3l13CdaXcHbgImoHUHlrvGx/7AvFEkTRhAGYh+jzjQ==}
+
resolution: {integrity: sha512-OS+QTnw1/4vrf+9hh1jc1jnYjzSG4ttTBB8UxOwAnInG3Uo4ssetzC1ihqaIHjLJnA5GGlRl6QlZXOTQhRBUvg==}
engines: {node: '>=14.16'}
@@ -5919,6 +6002,10 @@ packages:
resolution: {integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==}
+ resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==}
+ engines: {node: '>=6'}
+
resolution: {integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==}
engines: {node: '>=6'}
@@ -6048,6 +6135,9 @@ packages:
resolution: {integrity: sha512-srw17NI0TUWHuGa5CFGGmhfNIeja30WMBfbslPNhf6JrqQlLN5gcrvig1oqPxiVaXb0oW0XRKtH6Nngs5lKCIA==}
+ resolution: {integrity: sha512-kK/AA3A9K6q2js89+VMymcboLOlF5lZRCYJv3gzszXFHBr6kO6qLGzbm+UIugBEV8SMMKCTR59txoY6ctRHYVw==}
+
resolution: {integrity: sha512-sy6TXMN+hnP/wMy+ISxg3krXx7BAtWVO4UouuCN/ziM9UEne0euamVNafDfvC83bRNr95y0V5iijeDQFUNpvrg==}
engines: {node: '>= 0.4'}
@@ -6289,6 +6379,9 @@ packages:
resolution: {integrity: sha512-EugY9VASFuDqOexOgXR18ZV+TbFrQHeCpEYaXamO+SZlsnT/2LxuLBX25GGtIrwaEVFXUAbUQ601SWE2rMwWHA==}
+ resolution: {integrity: sha512-8jo7tOXr96h9PBQmOHVrltnETn1honZZY76YA79MHheGQg55jBvbm9dtU+MI5pjC5NJCFuA6rvVTLVeSW5cE4A==}
+
resolution: {integrity: sha512-sQTKC1Re/rM6XyFM6fIAGHRPVGvyXfgzIDvzoq608vM+jeyVD0Tu1E6Np0Kc2zAIFWIj963V2800iF/9LPieQw==}
@@ -6845,6 +6938,19 @@ packages:
resolution: {integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==}
+ resolution: {integrity: sha512-1EDsc66jaCjZtxdYy+Rl0KDU1WY/iyuCOOPaeFzcYFZ81FNXV8CmgUDOHri20WGmYnkEM5nQ+ooxj1vyuQo0Lg==}
+ engines: {node: '>= 18'}
+ peerDependencies:
+ typedoc: 0.26.x
+
+ resolution: {integrity: sha512-gUeI/Wk99vjXXMi8kanwzyhmeFEGv1LTdTQsiyIsmSYsBebvFxhbcyAx7Zjo4cMbpLGxM4Uz3jVIjksu/I2v6Q==}
+ engines: {node: '>= 18'}
+ hasBin: true
+ peerDependencies:
+ typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x
+
resolution: {integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==}
engines: {node: '>=14.17'}
@@ -6860,6 +6966,9 @@ packages:
engines: {node: '>=14.17'}
hasBin: true
+ resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==}
+
resolution: {integrity: sha512-jv+D9de1flsum5QkFtBdjyppCQAdz9kTck/0xST5Vx48T9LL2BYnw0Iw77dSKDQ9KZ/PS3qPO1vfXHDpLZlxcQ==}
@@ -6911,24 +7020,39 @@ packages:
resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==}
+ resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==}
+
resolution: {integrity: sha512-poZa0eXpS+/XpoQwGwl79UUdea4ol2ZuCYguVaJS4qzIOMDzbqz8a3erUCOmubSZkaOuGamb3tX790iwOIROww==}
resolution: {integrity: sha512-kUBE91efOWfIVBo8xzh/uZQ7p9ffYRtUbMRZBNFYwf0RK8koUMx6dGUfwylLOKmaT2cs4wSW96QoYUSXAyEtpg==}
+ resolution: {integrity: sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==}
+
resolution: {integrity: sha512-TkBb0HABNmxzAcfLf4qsIbFbaPDvMO6wa3b3j4VcEzFVaw1LBKwnW4/sRJ/atSLSzoIg41JWEdnE7N6DIhGDGQ==}
resolution: {integrity: sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg==}
+ resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==}
+
resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==}
+ resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==}
+
resolution: {integrity: sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==}
+ resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==}
+
resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==}
engines: {node: '>= 4.0.0'}
@@ -7041,9 +7165,15 @@ packages:
resolution: {integrity: sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw==}
+ resolution: {integrity: sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==}
+
resolution: {integrity: sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g==}
+ resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==}
+
resolution: {integrity: sha512-de6HJgzC+TFzOu0NTC4RAIsyf/DY/ibWDYQUcuEA84EMHhcefTUGkjFHKKEJhQN4A+6I0u++kr3l36ZF2d7XRw==}
engines: {node: ^18.0.0 || >=20.0.0}
@@ -7271,6 +7401,11 @@ packages:
resolution: {integrity: sha512-N/lyzTPaJasoDmfV7YTrYCI0G/3ivm/9wdG0aHuheKowWQwGTsK0Eoiw6utmzAnI6pkJa0DUVygvp3spqqEKXg==}
engines: {node: '>= 14'}
+ resolution: {integrity: sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==}
+ engines: {node: '>= 14'}
+ hasBin: true
+
resolution: {integrity: sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==}
engines: {node: '>=6'}
@@ -9416,6 +9551,33 @@ snapshots:
- encoding
- supports-color
+ '@shikijs/[email protected]':
+ dependencies:
+ '@shikijs/engine-javascript': 1.18.0
+ '@shikijs/engine-oniguruma': 1.18.0
+ '@shikijs/types': 1.18.0
+ '@shikijs/vscode-textmate': 9.2.2
+ '@types/hast': 3.0.4
+ hast-util-to-html: 9.0.3
+
+ '@shikijs/[email protected]':
+ dependencies:
+ '@shikijs/types': 1.18.0
+ '@shikijs/vscode-textmate': 9.2.2
+ oniguruma-to-js: 0.4.3
+
+ '@shikijs/[email protected]':
+ dependencies:
+ '@shikijs/types': 1.18.0
+ '@shikijs/vscode-textmate': 9.2.2
+
+ '@shikijs/[email protected]':
+ dependencies:
+ '@shikijs/vscode-textmate': 9.2.2
+ '@types/hast': 3.0.4
+
+ '@shikijs/[email protected]': {}
+
'@sigstore/[email protected]':
dependencies:
'@sigstore/protobuf-specs': 0.2.1
@@ -9689,6 +9851,10 @@ snapshots:
dependencies:
'@types/unist': 2.0.8
+ '@types/[email protected]':
+ dependencies:
+ '@types/unist': 2.0.8
+
'@types/[email protected]': {}
@@ -9712,6 +9878,10 @@ snapshots:
dependencies:
'@types/unist': 2.0.8
+ '@types/[email protected]':
+ dependencies:
+ '@types/unist': 3.0.3
+
'@types/[email protected]': {}
'@types/[email protected]': {}
@@ -9778,6 +9948,8 @@ snapshots:
'@types/[email protected]': {}
+ '@types/[email protected]': {}
+
dependencies:
'@types/configstore': 6.0.1
@@ -10033,6 +10205,8 @@ snapshots:
'@typescript-eslint/types': 7.16.1
eslint-visitor-keys: 3.4.3
+ '@ungap/[email protected]': {}
+
'@vercel/[email protected]': {}
'@vitest/[email protected]':
@@ -10975,6 +11149,10 @@ snapshots:
+ dependencies:
+ dequal: 2.0.3
+
@@ -11060,6 +11238,8 @@ snapshots:
ansi-colors: 4.1.3
strip-ansi: 6.0.1
+
@@ -11775,7 +11955,7 @@ snapshots:
dependencies:
foreground-child: 3.1.1
jackspeak: 2.3.6
- minimatch: 9.0.3
+ minimatch: 9.0.5
minipass: 7.0.3
path-scurry: 1.10.1
@@ -11938,8 +12118,26 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ '@types/hast': 3.0.4
+ '@types/unist': 3.0.3
+ ccount: 2.0.1
+ comma-separated-tokens: 2.0.3
+ hast-util-whitespace: 3.0.0
+ html-void-elements: 3.0.0
+ mdast-util-to-hast: 13.2.0
+ property-information: 6.3.0
+ space-separated-tokens: 2.0.2
+ stringify-entities: 4.0.3
+ zwitch: 2.0.4
+
+ dependencies:
+ '@types/hast': 3.0.4
+
@@ -11964,6 +12162,8 @@ snapshots:
dependencies:
lru-cache: 7.18.3
+
@@ -12013,7 +12213,7 @@ snapshots:
dependencies:
- minimatch: 9.0.3
+ minimatch: 9.0.5
@@ -12478,6 +12678,10 @@ snapshots:
+ dependencies:
+ uc.micro: 2.1.0
+
dependencies:
graceful-fs: 4.2.11
@@ -12577,6 +12781,8 @@ snapshots:
dependencies:
react: 18.2.0
+
dependencies:
vlq: 0.2.3
@@ -12621,6 +12827,15 @@ snapshots:
+ dependencies:
+ argparse: 2.0.1
+ entities: 4.5.0
+ linkify-it: 5.0.0
+ mdurl: 2.0.0
+ punycode.js: 2.3.1
+ uc.micro: 2.1.0
+
@@ -12760,6 +12975,18 @@ snapshots:
unist-util-position: 4.0.4
unist-util-visit: 4.1.2
+ dependencies:
+ '@types/hast': 3.0.4
+ '@types/mdast': 4.0.4
+ '@ungap/structured-clone': 1.2.0
+ devlop: 1.1.0
+ micromark-util-sanitize-uri: 2.0.0
+ trim-lines: 3.0.1
+ unist-util-position: 5.0.0
+ unist-util-visit: 5.0.0
+ vfile: 6.0.3
+
dependencies:
'@types/mdast': 3.0.12
@@ -12775,6 +13002,8 @@ snapshots:
dependencies:
'@types/mdast': 3.0.12
+
dependencies:
acorn: 8.11.3
@@ -12987,6 +13216,11 @@ snapshots:
micromark-util-symbol: 1.1.0
micromark-util-types: 1.1.0
+ dependencies:
+ micromark-util-symbol: 2.0.0
+ micromark-util-types: 2.0.0
+
dependencies:
micromark-util-symbol: 1.1.0
@@ -13015,6 +13249,8 @@ snapshots:
+
dependencies:
'@types/acorn': 4.0.6
@@ -13042,6 +13278,12 @@ snapshots:
micromark-util-encode: 1.1.0
micromark-util-symbol: 1.1.0
+ dependencies:
+ micromark-util-character: 2.1.0
+ micromark-util-encode: 2.0.0
+ micromark-util-symbol: 2.0.0
+
dependencies:
micromark-util-chunked: 1.1.0
@@ -13051,8 +13293,12 @@ snapshots:
+
+
dependencies:
'@types/debug': 4.1.8
@@ -13515,6 +13761,10 @@ snapshots:
dependencies:
mimic-fn: 4.0.0
+ dependencies:
+ regex: 4.3.2
+
dependencies:
default-browser: 4.0.0
@@ -13798,12 +14048,13 @@ snapshots:
optionalDependencies:
postcss: 8.4.39
dependencies:
lilconfig: 3.1.2
optionalDependencies:
jiti: 1.21.6
postcss: 8.4.39
+ yaml: 2.5.1
dependencies:
@@ -13931,6 +14182,8 @@ snapshots:
end-of-stream: 1.4.4
once: 1.4.0
+
@@ -14080,6 +14333,8 @@ snapshots:
+
dependencies:
call-bind: 1.0.2
@@ -14362,6 +14617,15 @@ snapshots:
vscode-oniguruma: 1.7.0
vscode-textmate: 6.0.0
+ dependencies:
+ '@shikijs/core': 1.18.0
+ '@shikijs/engine-javascript': 1.18.0
+ '@shikijs/engine-oniguruma': 1.18.0
+ '@shikijs/types': 1.18.0
+ '@shikijs/vscode-textmate': 9.2.2
+ '@types/hast': 3.0.4
+
@@ -14854,7 +15118,7 @@ snapshots:
- supports-color
- ts-node
dependencies:
bundle-require: 5.0.0([email protected])
cac: 6.7.14
@@ -14866,7 +15130,7 @@ snapshots:
globby: 11.1.0
joycon: 3.1.1
picocolors: 1.0.1
- postcss-load-config: 6.0.1([email protected])([email protected])
resolve-from: 5.0.0
rollup: 4.19.0
source-map: 0.8.0-beta.0
@@ -14960,12 +15224,27 @@ snapshots:
dependencies:
is-typedarray: 1.0.0
+ dependencies:
+ typedoc: 0.26.7([email protected])
+
+ dependencies:
+ lunr: 2.3.9
+ markdown-it: 14.1.0
+ minimatch: 9.0.5
+ shiki: 1.18.0
+ typescript: 5.5.3
+ yaml: 2.5.1
+
+
@@ -15027,6 +15306,10 @@ snapshots:
dependencies:
'@types/unist': 2.0.8
+ dependencies:
+ '@types/unist': 3.0.3
+
dependencies:
'@types/unist': 2.0.8
@@ -15035,6 +15318,10 @@ snapshots:
dependencies:
'@types/unist': 2.0.8
+ dependencies:
+ '@types/unist': 3.0.3
+
dependencies:
'@types/unist': 2.0.8
@@ -15044,17 +15331,32 @@ snapshots:
dependencies:
'@types/unist': 2.0.8
+ dependencies:
+ '@types/unist': 3.0.3
+
dependencies:
'@types/unist': 2.0.8
unist-util-is: 5.2.1
+ dependencies:
+ '@types/unist': 3.0.3
+ unist-util-is: 6.0.0
+
dependencies:
'@types/unist': 2.0.8
unist-util-is: 5.2.1
unist-util-visit-parents: 5.1.3
+ dependencies:
+ '@types/unist': 3.0.3
+ unist-util-is: 6.0.0
+ unist-util-visit-parents: 6.0.1
+
@@ -15188,6 +15490,11 @@ snapshots:
'@types/unist': 2.0.8
unist-util-stringify-position: 3.0.3
+ dependencies:
+ '@types/unist': 3.0.3
+ unist-util-stringify-position: 4.0.0
+
dependencies:
'@types/unist': 2.0.8
@@ -15195,6 +15502,11 @@ snapshots:
unist-util-stringify-position: 3.0.3
vfile-message: 3.1.4
+ dependencies:
+ '@types/unist': 3.0.3
+ vfile-message: 4.0.2
+
dependencies:
cac: 6.7.14
@@ -15459,6 +15771,8 @@ snapshots:
+
dependencies:
camelcase: 5.3.1