@e2b/cli 0.5.9 → 0.5.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -48
- package/dist/index.js +125 -127
- package/dist/index.js.map +1 -1
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,63 +1,28 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
</
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img width="100" src="/readme-assets/logo-circle.png" alt="e2b logo">
|
|
3
|
+
</p>
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
terminal.
|
|
5
|
+
# E2B CLI
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
the sandbox template. You can then connect to the sandbox template via SDKs and
|
|
10
|
-
run your AI agents.
|
|
7
|
+
This CLI tool allows you to build manager your running E2B sandbox and sandbox templates. Learn more in [our documentation](https://e2b.dev/docs).
|
|
11
8
|
|
|
12
|
-
|
|
13
|
-
linux distros** as the base image.
|
|
14
|
-
|
|
15
|
-
## Installation
|
|
9
|
+
### 1. Install the CLI
|
|
16
10
|
|
|
17
11
|
```bash
|
|
18
12
|
npm install -g @e2b/cli
|
|
19
13
|
```
|
|
20
14
|
|
|
21
|
-
|
|
15
|
+
### 2. Authenticate
|
|
22
16
|
|
|
23
17
|
```bash
|
|
24
|
-
e2b
|
|
18
|
+
e2b auth login
|
|
25
19
|
```
|
|
26
20
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
1. Authenticate with `e2b auth login`
|
|
30
|
-
|
|
31
|
-
> To authenticate without the ability to open browser, you can provide
|
|
21
|
+
> [!NOTE]
|
|
22
|
+
> To authenticate without the ability to open the browser, provide
|
|
32
23
|
> `E2B_ACCESS_TOKEN` as an environment variable. Get your `E2B_ACCESS_TOKEN`
|
|
33
24
|
> from [e2b.dev/docs](https://e2b.dev/docs). Then use the CLI like this:
|
|
34
|
-
> `E2B_ACCESS_TOKEN=sk_e2b_... e2b build
|
|
35
|
-
|
|
36
|
-
2. Create a `Dockerfile` where you describe how your custom E2B sandbox template
|
|
37
|
-
should look like. Majority of **Debian based linux distros should work as the
|
|
38
|
-
base image**. Here is an example of a minimal `Dockerfile` for E2B sandbox
|
|
39
|
-
template:
|
|
40
|
-
|
|
41
|
-
```Dockerfile
|
|
42
|
-
FROM ubuntu:22.04
|
|
43
|
-
```
|
|
25
|
+
> `E2B_ACCESS_TOKEN=sk_e2b_... e2b build`.
|
|
44
26
|
|
|
45
|
-
3.
|
|
46
|
-
|
|
47
|
-
connecting to the sandbox via SDKs and for rebuilding the sandbox template
|
|
48
|
-
|
|
49
|
-
4. Use the **template ID** that you got during the `e2b build` with the Python
|
|
50
|
-
or JS/TS SDK as the `id` to create sandbox
|
|
51
|
-
|
|
52
|
-
5. Rebuild the sandbox template by running `e2b build <id-of-the-template>` in
|
|
53
|
-
the directory with the `Dockerfile`
|
|
54
|
-
|
|
55
|
-
## Commands
|
|
56
|
-
|
|
57
|
-
All commands can be called with a `--path <path-to-dir>` flag that changes the
|
|
58
|
-
directory where the command will be called, without the need to call `cd`.
|
|
59
|
-
|
|
60
|
-
```md
|
|
61
|
-
-V, --version Display E2B CLI version
|
|
62
|
-
-h, --help display help for command
|
|
63
|
-
```
|
|
27
|
+
### 3. Check out docs
|
|
28
|
+
Visit our [CLI documentation](https://e2b.dev/docs) to learn more.
|