Skip to content

Commit 64e8f05

Browse files
[skip ci] Release new versions
1 parent 4da865c commit 64e8f05

5 files changed

Lines changed: 368 additions & 6 deletions

File tree

.changeset/grumpy-moons-melt.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
## e2b auth
2+
3+
4+
authentication commands
5+
6+
### Usage
7+
8+
```bash
9+
e2b auth [options] [command]
10+
```
11+
## e2b auth login
12+
13+
14+
log in to CLI
15+
16+
### Usage
17+
18+
```bash
19+
e2b auth login [options]
20+
```
21+
22+
23+
## e2b auth logout
24+
25+
26+
log out of CLI
27+
28+
### Usage
29+
30+
```bash
31+
e2b auth logout [options]
32+
```
33+
34+
35+
## e2b auth info
36+
37+
38+
get information about the current user
39+
40+
### Usage
41+
42+
```bash
43+
e2b auth info [options]
44+
```
45+
46+
47+
## e2b auth configure
48+
49+
50+
configure user
51+
52+
### Usage
53+
54+
```bash
55+
e2b auth configure [options]
56+
```
57+
58+
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
## e2b sandbox
2+
3+
4+
work with sandboxes
5+
6+
### Usage
7+
8+
```bash
9+
e2b sandbox [options] [command]
10+
```
11+
## e2b sandbox connect
12+
13+
14+
connect terminal to already running sandbox
15+
16+
### Usage
17+
18+
```bash
19+
e2b sandbox connect [options] <sandboxID>
20+
```
21+
22+
23+
## e2b sandbox list
24+
25+
26+
list all sandboxes, by default it list only running ones
27+
28+
### Usage
29+
30+
```bash
31+
e2b sandbox list [options]
32+
```
33+
34+
### Options
35+
36+
37+
- `-s, --state <state>: filter by state, eg. running, paused. Defaults to running `
38+
- `-m, --metadata <metadata>: filter by metadata, eg. key1=value1 `
39+
- `-l, --limit <limit>: limit the number of sandboxes returned `
40+
- `-f, --format <format>: output format, eg. json, pretty `
41+
42+
43+
## e2b sandbox kill
44+
45+
46+
kill sandbox
47+
48+
### Usage
49+
50+
```bash
51+
e2b sandbox kill [options] [sandboxIDs...]
52+
```
53+
54+
### Options
55+
56+
57+
- `-a, --all: kill all sandboxes `
58+
- `-s, --state <state>: when used with -a/--all flag, filter by state, eg. running, paused. Defaults to running `
59+
- `-m, --metadata <metadata>: when used with -a/--all flag, filter by metadata, eg. key1=value1 `
60+
61+
62+
## e2b sandbox create
63+
64+
65+
create sandbox and connect terminal to it
66+
67+
### Usage
68+
69+
```bash
70+
e2b sandbox create [options] [template]
71+
```
72+
73+
### Options
74+
75+
76+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
77+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
78+
79+
80+
## e2b sandbox spawn
81+
82+
83+
create sandbox and connect terminal to it
84+
85+
### Usage
86+
87+
```bash
88+
e2b sandbox spawn [options] [template]
89+
```
90+
91+
### Options
92+
93+
94+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
95+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
96+
97+
98+
## e2b sandbox logs
99+
100+
101+
show logs for sandbox
102+
103+
### Usage
104+
105+
```bash
106+
e2b sandbox logs [options] <sandboxID>
107+
```
108+
109+
### Options
110+
111+
112+
- `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`
113+
- `-f, --follow: keep streaming logs until the sandbox is closed `
114+
- `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`
115+
- `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `
116+
117+
118+
## e2b sandbox metrics
119+
120+
121+
show metrics for sandbox
122+
123+
### Usage
124+
125+
```bash
126+
e2b sandbox metrics [options] <sandboxID>
127+
```
128+
129+
### Options
130+
131+
132+
- `-f, --follow: keep streaming metrics until the sandbox is closed `
133+
- `--format <format>: specify format for printing metrics (json, pretty) [default: pretty]`
134+
135+
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
## e2b template
2+
3+
4+
manage sandbox templates
5+
6+
### Usage
7+
8+
```bash
9+
e2b template [options] [command]
10+
```
11+
## e2b template build
12+
13+
14+
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.
15+
16+
### Usage
17+
18+
```bash
19+
e2b template build [options] [template]
20+
```
21+
22+
### Options
23+
24+
25+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
26+
- `-d, --dockerfile <file>: specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. `
27+
- `-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. `
28+
- `-c, --cmd <start-command>: specify command that will be executed when the sandbox is started. `
29+
- `--ready-cmd <ready-command>: specify command that will need to exit 0 for the template to be ready. `
30+
- `-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). `
31+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
32+
- `--cpu-count <cpu-count>: specify the number of CPUs that will be used to run the sandbox. The default value is 2. `
33+
- `--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. `
34+
- `--build-arg <args...>: specify additional build arguments for the build command. The format should be <varname>=<value>. `
35+
- `--no-cache: skip cache when building the template. `
36+
37+
38+
## e2b template list
39+
40+
41+
list sandbox templates
42+
43+
### Usage
44+
45+
```bash
46+
e2b template list [options]
47+
```
48+
49+
### Options
50+
51+
52+
- `-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). `
53+
- `-f, --format <format>: output format, eg. json, pretty `
54+
55+
56+
## e2b template init
57+
58+
59+
create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile
60+
61+
### Usage
62+
63+
```bash
64+
e2b template init [options]
65+
```
66+
67+
### Options
68+
69+
70+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
71+
72+
73+
## e2b template init-v2
74+
75+
76+
initialize a new sandbox template using the SDK
77+
78+
### Usage
79+
80+
```bash
81+
e2b template init-v2 [options]
82+
```
83+
84+
### Options
85+
86+
87+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
88+
- `-n, --name <name>: template name (alias) `
89+
- `-l, --language <language>: target language: typescript, python-sync, python-async `
90+
91+
92+
## e2b template delete
93+
94+
95+
delete sandbox template and e2b.toml config
96+
97+
### Usage
98+
99+
```bash
100+
e2b template delete [options] [template]
101+
```
102+
103+
### Options
104+
105+
106+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
107+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
108+
- `-s, --select: select sandbox template from interactive list `
109+
- `-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). `
110+
- `-y, --yes: skip manual delete confirmation `
111+
112+
113+
## e2b template publish
114+
115+
116+
publish sandbox template
117+
118+
### Usage
119+
120+
```bash
121+
e2b template publish [options] [template]
122+
```
123+
124+
### Options
125+
126+
127+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
128+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
129+
- `-s, --select: select sandbox template from interactive list `
130+
- `-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). `
131+
- `-y, --yes: skip manual publish confirmation `
132+
133+
134+
## e2b template unpublish
135+
136+
137+
unpublish sandbox template
138+
139+
### Usage
140+
141+
```bash
142+
e2b template unpublish [options] [template]
143+
```
144+
145+
### Options
146+
147+
148+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
149+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
150+
- `-s, --select: select sandbox template from interactive list `
151+
- `-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). `
152+
- `-y, --yes: skip manual unpublish confirmation `
153+
154+
155+
## e2b template migrate
156+
157+
158+
migrate e2b.Dockerfile and e2b.toml to new Template SDK format
159+
160+
### Usage
161+
162+
```bash
163+
e2b template migrate [options]
164+
```
165+
166+
### Options
167+
168+
169+
- `-d, --dockerfile <file>: specify path to Dockerfile. Defaults to e2b.Dockerfile `
170+
- `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `
171+
- `-l, --language <language>: specify target language: typescript, python-sync, python-async `
172+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
173+
174+

packages/cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@e2b/cli",
3-
"version": "2.2.4",
3+
"version": "2.2.5",
44
"description": "CLI for managing e2b sandbox templates",
55
"homepage": "https://e2b.dev",
66
"license": "MIT",

0 commit comments

Comments
 (0)