Skip to content

Commit 3b792c6

Browse files
Migration: SDK Reference files from old repositories (#113)
* migrate: sdk reference js-sdk * migrate: sdk reference python-sdk * migrate: sdk reference code-interpreter-js-sdk * migrate: sdk reference code-interpreter-python-sdk * migrate: sdk reference desktop-js-sdk * migrate: sdk reference desktop-python-sdk * migrate: sdk reference cli * migrate: update sdk reference docs.json * docs: update SDK reference for all all * docs: update SDK reference for all all * fix: docs.json duplicate sdk reference * remove: all code-interpreter js index.mdx files --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 7821f75 commit 3b792c6

1,338 files changed

Lines changed: 680973 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs.json

Lines changed: 3392 additions & 2 deletions
Large diffs are not rendered by default.
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+
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
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 list
28+
29+
30+
list all running sandboxes
31+
32+
### Usage
33+
34+
```bash
35+
e2b sandbox list [options]
36+
```
37+
38+
39+
## e2b sandbox kill
40+
41+
42+
kill sandbox
43+
44+
### Usage
45+
46+
```bash
47+
e2b sandbox kill [options] [sandboxID]
48+
```
49+
50+
### Options
51+
52+
53+
- `-a, --all: kill all running sandboxes `
54+
55+
56+
## e2b sandbox spawn
57+
58+
59+
spawn sandbox and connect terminal to it
60+
61+
### Usage
62+
63+
```bash
64+
e2b sandbox spawn [options] [template]
65+
```
66+
67+
### Options
68+
69+
70+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
71+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
72+
73+
74+
## e2b sandbox logs
75+
76+
77+
show logs for sandbox
78+
79+
### Usage
80+
81+
```bash
82+
e2b sandbox logs [options] <sandboxID>
83+
```
84+
85+
### Options
86+
87+
88+
- `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`
89+
- `-f, --follow: keep streaming logs until the sandbox is closed `
90+
- `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`
91+
- `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `
92+
93+
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
sidebarTitle: "Template"
3+
---
4+
5+
## e2b template
6+
7+
8+
manage sandbox templates
9+
10+
### Usage
11+
12+
```bash
13+
e2b template [options] [command]
14+
```
15+
## e2b template build
16+
17+
18+
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.
19+
20+
### Usage
21+
22+
```bash
23+
e2b template build [options] [template]
24+
```
25+
26+
### Options
27+
28+
29+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
30+
- `-d, --dockerfile <file>: specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. `
31+
- `-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. `
32+
- `-c, --cmd <start-command>: specify command that will be executed when the sandbox is started. `
33+
- `-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). `
34+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
35+
- `--cpu-count <cpu-count>: specify the number of CPUs that will be used to run the sandbox. The default value is 2. `
36+
- `--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. `
37+
- `--build-arg <args...>: specify additional build arguments for the build command. The format should be <varname>=<value>. `
38+
39+
40+
## e2b template list
41+
42+
43+
list sandbox templates
44+
45+
### Usage
46+
47+
```bash
48+
e2b template list [options]
49+
```
50+
51+
### Options
52+
53+
54+
- `-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). `
55+
56+
57+
## e2b template init
58+
59+
60+
create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile
61+
62+
### Usage
63+
64+
```bash
65+
e2b template init [options]
66+
```
67+
68+
### Options
69+
70+
71+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
72+
73+
74+
## e2b template delete
75+
76+
77+
delete sandbox template and e2b.toml config
78+
79+
### Usage
80+
81+
```bash
82+
e2b template delete [options] [template]
83+
```
84+
85+
### Options
86+
87+
88+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
89+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
90+
- `-s, --select: select sandbox template from interactive list `
91+
- `-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). `
92+
- `-y, --yes: skip manual delete confirmation `
93+
94+
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+

0 commit comments

Comments
 (0)