Skip to content

Commit 980dbb2

Browse files
github-actions[bot]github-actions[bot]
committed
docs: sync SDK reference for all latest
1 parent e836d29 commit 980dbb2

27 files changed

+16365
-5
lines changed

‎docs.json‎

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,22 @@
240240
"icon": "square-js",
241241
"versions": [
242242
{
243-
"version": "v2.14.1",
243+
"version": "v2.18.0",
244244
"default": true,
245+
"pages": [
246+
"docs/sdk-reference/js-sdk/v2.18.0/errors",
247+
"docs/sdk-reference/js-sdk/v2.18.0/sandbox",
248+
"docs/sdk-reference/js-sdk/v2.18.0/sandbox-commands",
249+
"docs/sdk-reference/js-sdk/v2.18.0/sandbox-filesystem",
250+
"docs/sdk-reference/js-sdk/v2.18.0/template",
251+
"docs/sdk-reference/js-sdk/v2.18.0/template-logger",
252+
"docs/sdk-reference/js-sdk/v2.18.0/template-readycmd",
253+
"docs/sdk-reference/js-sdk/v2.18.0/volume"
254+
]
255+
},
256+
{
257+
"version": "v2.14.1",
258+
"default": false,
245259
"pages": [
246260
"docs/sdk-reference/js-sdk/v2.14.1/errors",
247261
"docs/sdk-reference/js-sdk/v2.14.1/sandbox",
@@ -1311,8 +1325,24 @@
13111325
"icon": "python",
13121326
"versions": [
13131327
{
1314-
"version": "v2.15.2",
1328+
"version": "v2.19.0",
13151329
"default": true,
1330+
"pages": [
1331+
"docs/sdk-reference/python-sdk/v2.19.0/exceptions",
1332+
"docs/sdk-reference/python-sdk/v2.19.0/logger",
1333+
"docs/sdk-reference/python-sdk/v2.19.0/readycmd",
1334+
"docs/sdk-reference/python-sdk/v2.19.0/sandbox_async",
1335+
"docs/sdk-reference/python-sdk/v2.19.0/sandbox_sync",
1336+
"docs/sdk-reference/python-sdk/v2.19.0/template",
1337+
"docs/sdk-reference/python-sdk/v2.19.0/template_async",
1338+
"docs/sdk-reference/python-sdk/v2.19.0/template_sync",
1339+
"docs/sdk-reference/python-sdk/v2.19.0/volume_async",
1340+
"docs/sdk-reference/python-sdk/v2.19.0/volume_sync"
1341+
]
1342+
},
1343+
{
1344+
"version": "v2.15.2",
1345+
"default": false,
13161346
"pages": [
13171347
"docs/sdk-reference/python-sdk/v2.15.2/exceptions",
13181348
"docs/sdk-reference/python-sdk/v2.15.2/logger",
@@ -2345,8 +2375,18 @@
23452375
"icon": "square-js",
23462376
"versions": [
23472377
{
2348-
"version": "v2.3.3",
2378+
"version": "v2.4.0",
23492379
"default": true,
2380+
"pages": [
2381+
"docs/sdk-reference/code-interpreter-js-sdk/v2.4.0/charts",
2382+
"docs/sdk-reference/code-interpreter-js-sdk/v2.4.0/consts",
2383+
"docs/sdk-reference/code-interpreter-js-sdk/v2.4.0/messaging",
2384+
"docs/sdk-reference/code-interpreter-js-sdk/v2.4.0/sandbox"
2385+
]
2386+
},
2387+
{
2388+
"version": "v2.3.3",
2389+
"default": false,
23502390
"pages": [
23512391
"docs/sdk-reference/code-interpreter-js-sdk/v2.3.3/charts",
23522392
"docs/sdk-reference/code-interpreter-js-sdk/v2.3.3/consts",
@@ -2491,8 +2531,15 @@
24912531
"icon": "python",
24922532
"versions": [
24932533
{
2494-
"version": "v2.5.0",
2534+
"version": "v2.6.0",
24952535
"default": true,
2536+
"pages": [
2537+
"docs/sdk-reference/code-interpreter-python-sdk/v2.6.0/code_interpreter"
2538+
]
2539+
},
2540+
{
2541+
"version": "v2.5.0",
2542+
"default": false,
24962543
"pages": [
24972544
"docs/sdk-reference/code-interpreter-python-sdk/v2.5.0/code_interpreter"
24982545
]
@@ -3027,8 +3074,17 @@
30273074
"icon": "terminal",
30283075
"versions": [
30293076
{
3030-
"version": "v2.8.1",
3077+
"version": "v2.9.0",
30313078
"default": true,
3079+
"pages": [
3080+
"docs/sdk-reference/cli/v2.9.0/auth",
3081+
"docs/sdk-reference/cli/v2.9.0/sandbox",
3082+
"docs/sdk-reference/cli/v2.9.0/template"
3083+
]
3084+
},
3085+
{
3086+
"version": "v2.8.1",
3087+
"default": false,
30323088
"pages": [
30333089
"docs/sdk-reference/cli/v2.8.1/auth",
30343090
"docs/sdk-reference/cli/v2.8.1/sandbox",

‎docs/sdk-reference/cli/v2.9.0/auth.mdx‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
sidebarTitle: "Auth"
3+
---
4+
5+
## e2b auth
6+
7+
8+
authentication commands
9+
10+
### Usage
11+
12+
```bash
13+
e2b auth [options] [command]
14+
```
15+
## e2b auth login
16+
17+
18+
log in to CLI
19+
20+
### Usage
21+
22+
```bash
23+
e2b auth login [options]
24+
```
25+
26+
27+
## e2b auth logout
28+
29+
30+
log out of CLI
31+
32+
### Usage
33+
34+
```bash
35+
e2b auth logout [options]
36+
```
37+
38+
39+
## e2b auth info
40+
41+
42+
get information about the current user
43+
44+
### Usage
45+
46+
```bash
47+
e2b auth info [options]
48+
```
49+
50+
51+
## e2b auth configure
52+
53+
54+
configure user
55+
56+
### Usage
57+
58+
```bash
59+
e2b auth configure [options]
60+
```
61+
62+

‎docs/sdk-reference/cli/v2.9.0/sandbox.mdx‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
---
2+
sidebarTitle: "Sandbox"
3+
---
4+
5+
## e2b sandbox
6+
7+
8+
work with sandboxes
9+
10+
### Usage
11+
12+
```bash
13+
e2b sandbox [options] [command]
14+
```
15+
## e2b sandbox connect
16+
17+
18+
connect terminal to already running sandbox
19+
20+
### Usage
21+
22+
```bash
23+
e2b sandbox connect [options] <sandboxID>
24+
```
25+
26+
27+
## e2b sandbox info
28+
29+
30+
show information for a sandbox
31+
32+
### Usage
33+
34+
```bash
35+
e2b sandbox info [options] <sandboxID>
36+
```
37+
38+
### Options
39+
40+
41+
- `-f, --format <format>: output format, eg. json, pretty `
42+
43+
44+
## e2b sandbox list
45+
46+
47+
list all sandboxes, by default it list only running ones
48+
49+
### Usage
50+
51+
```bash
52+
e2b sandbox list [options]
53+
```
54+
55+
### Options
56+
57+
58+
- `-s, --state <state>: filter by state, eg. running, paused. Defaults to running `
59+
- `-m, --metadata <metadata>: filter by metadata, eg. key1=value1 `
60+
- `-l, --limit <limit>: limit the number of sandboxes returned (default: 1000, 0 for no limit) `
61+
- `-f, --format <format>: output format, eg. json, pretty `
62+
63+
64+
## e2b sandbox kill
65+
66+
67+
kill sandbox
68+
69+
### Usage
70+
71+
```bash
72+
e2b sandbox kill [options] [sandboxIDs...]
73+
```
74+
75+
### Options
76+
77+
78+
- `-a, --all: kill all sandboxes `
79+
- `-s, --state <state>: when used with -a/--all flag, filter by state, eg. running, paused. Defaults to running `
80+
- `-m, --metadata <metadata>: when used with -a/--all flag, filter by metadata, eg. key1=value1 `
81+
82+
83+
## e2b sandbox pause
84+
85+
86+
pause sandbox
87+
88+
### Usage
89+
90+
```bash
91+
e2b sandbox pause [options] <sandboxID>
92+
```
93+
94+
95+
## e2b sandbox resume
96+
97+
98+
resume paused sandbox
99+
100+
### Usage
101+
102+
```bash
103+
e2b sandbox resume [options] <sandboxID>
104+
```
105+
106+
107+
## e2b sandbox create
108+
109+
110+
create sandbox and connect terminal to it
111+
112+
### Usage
113+
114+
```bash
115+
e2b sandbox create [options] [template]
116+
```
117+
118+
### Options
119+
120+
121+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
122+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. We recommend using the new build system (https://e2b.dev/docs/template/defining-template) that does not use config files. `
123+
- `-d, --detach: create sandbox without connecting terminal to it `
124+
125+
126+
## e2b sandbox spawn
127+
128+
129+
create sandbox and connect terminal to it
130+
131+
### Usage
132+
133+
```bash
134+
e2b sandbox spawn [options] [template]
135+
```
136+
137+
### Options
138+
139+
140+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
141+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. We recommend using the new build system (https://e2b.dev/docs/template/defining-template) that does not use config files. `
142+
- `-d, --detach: create sandbox without connecting terminal to it `
143+
144+
145+
## e2b sandbox logs
146+
147+
148+
show logs for sandbox
149+
150+
### Usage
151+
152+
```bash
153+
e2b sandbox logs [options] <sandboxID>
154+
```
155+
156+
### Options
157+
158+
159+
- `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`
160+
- `-f, --follow: keep streaming logs until the sandbox is closed `
161+
- `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`
162+
- `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `
163+
164+
165+
## e2b sandbox metrics
166+
167+
168+
show metrics for sandbox
169+
170+
### Usage
171+
172+
```bash
173+
e2b sandbox metrics [options] <sandboxID>
174+
```
175+
176+
### Options
177+
178+
179+
- `-f, --follow: keep streaming metrics until the sandbox is closed `
180+
- `--format <format>: specify format for printing metrics (json, pretty) [default: pretty]`
181+
182+
183+
## e2b sandbox exec
184+
185+
186+
execute a command in a running sandbox
187+
188+
### Usage
189+
190+
```bash
191+
e2b sandbox exec [options] <sandboxID> <command...>
192+
```
193+
194+
### Options
195+
196+
197+
- `-b, --background: run in background and return immediately `
198+
- `-c, --cwd <dir>: working directory `
199+
- `-u, --user <user>: run as specified user `
200+
- `-e, --env <KEY=VALUE>: set environment variable (repeatable) [default: [object Object]]`
201+
202+

0 commit comments

Comments
 (0)