Skip to content

Commit 0d5cfd1

Browse files
[skip ci] Release new versions
1 parent b0ab7f7 commit 0d5cfd1

18 files changed

Lines changed: 7818 additions & 13 deletions

File tree

.changeset/new-moons-jog.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/plenty-onions-do.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: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
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 (default: 1000, 0 for no limit) `
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 pause
63+
64+
65+
pause sandbox
66+
67+
### Usage
68+
69+
```bash
70+
e2b sandbox pause [options] <sandboxID>
71+
```
72+
73+
74+
## e2b sandbox resume
75+
76+
77+
resume paused sandbox
78+
79+
### Usage
80+
81+
```bash
82+
e2b sandbox resume [options] <sandboxID>
83+
```
84+
85+
86+
## e2b sandbox create
87+
88+
89+
create sandbox and connect terminal to it
90+
91+
### Usage
92+
93+
```bash
94+
e2b sandbox create [options] [template]
95+
```
96+
97+
### Options
98+
99+
100+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
101+
- `--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. `
102+
- `-d, --detach: create sandbox without connecting terminal to it `
103+
104+
105+
## e2b sandbox spawn
106+
107+
108+
create sandbox and connect terminal to it
109+
110+
### Usage
111+
112+
```bash
113+
e2b sandbox spawn [options] [template]
114+
```
115+
116+
### Options
117+
118+
119+
- `-p, --path <path>: change root directory where command is executed to <path> directory `
120+
- `--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. `
121+
- `-d, --detach: create sandbox without connecting terminal to it `
122+
123+
124+
## e2b sandbox logs
125+
126+
127+
show logs for sandbox
128+
129+
### Usage
130+
131+
```bash
132+
e2b sandbox logs [options] <sandboxID>
133+
```
134+
135+
### Options
136+
137+
138+
- `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`
139+
- `-f, --follow: keep streaming logs until the sandbox is closed `
140+
- `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`
141+
- `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `
142+
143+
144+
## e2b sandbox metrics
145+
146+
147+
show metrics for sandbox
148+
149+
### Usage
150+
151+
```bash
152+
e2b sandbox metrics [options] <sandboxID>
153+
```
154+
155+
### Options
156+
157+
158+
- `-f, --follow: keep streaming metrics until the sandbox is closed `
159+
- `--format <format>: specify format for printing metrics (json, pretty) [default: pretty]`
160+
161+
162+
## e2b sandbox exec
163+
164+
165+
execute a command in a running sandbox
166+
167+
### Usage
168+
169+
```bash
170+
e2b sandbox exec [options] <sandboxID> <command...>
171+
```
172+
173+
### Options
174+
175+
176+
- `-b, --background: run in background and return immediately `
177+
- `-c, --cwd <dir>: working directory `
178+
- `-u, --user <user>: run as specified user `
179+
- `-e, --env <KEY=VALUE>: set environment variable (repeatable) [default: [object Object]]`
180+
181+

0 commit comments

Comments
 (0)