@e2b/cli 0.0.16 → 0.1.1
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 +35 -20
- package/dist/index.js +67 -64
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -18,14 +18,18 @@
|
|
|
18
18
|
</a>
|
|
19
19
|
</h4>
|
|
20
20
|
|
|
21
|
-
[E2B](https://e2b.dev) (_english2bits_) is a cloud operating system for AI
|
|
21
|
+
[E2B](https://e2b.dev) (_english2bits_) is a cloud operating system for AI
|
|
22
|
+
agents.
|
|
22
23
|
|
|
23
|
-
This CLI tool allows you to build and manage E2B sandbox templates from your
|
|
24
|
+
This CLI tool allows you to build and manage E2B sandbox templates from your
|
|
25
|
+
terminal.
|
|
24
26
|
|
|
25
|
-
You define your sandbox template in a `Dockerfile` and then use the CLI to build
|
|
26
|
-
connect to the sandbox template via SDKs and
|
|
27
|
+
You define your sandbox template in a `Dockerfile` and then use the CLI to build
|
|
28
|
+
the sandbox template. You can then connect to the sandbox template via SDKs and
|
|
29
|
+
run your AI agents.
|
|
27
30
|
|
|
28
|
-
The `Dockerfile` is the same as for Docker, but you can only use **Debian based
|
|
31
|
+
The `Dockerfile` is the same as for Docker, but you can only use **Debian based
|
|
32
|
+
linux distros** as the base image.
|
|
29
33
|
|
|
30
34
|
## Installation
|
|
31
35
|
|
|
@@ -43,30 +47,34 @@ e2b --help
|
|
|
43
47
|
|
|
44
48
|
1. Authenticate with `e2b login`
|
|
45
49
|
|
|
46
|
-
> To authenticate without the ability to open browser, you can provide
|
|
47
|
-
>
|
|
48
|
-
>
|
|
50
|
+
> To authenticate without the ability to open browser, you can provide
|
|
51
|
+
> `E2B_ACCESS_TOKEN` as an environment variable. Get your `E2B_ACCESS_TOKEN`
|
|
52
|
+
> from [e2b.dev/docs](https://e2b.dev/docs). Then use the CLI like this:
|
|
53
|
+
> `E2B_ACCESS_TOKEN=sk_e2b_... e2b build`
|
|
49
54
|
|
|
50
|
-
2. Create a `Dockerfile` where you describe how your custom E2B sandbox template
|
|
51
|
-
based linux distros should work as the
|
|
55
|
+
2. Create a `Dockerfile` where you describe how your custom E2B sandbox template
|
|
56
|
+
should look like. Majority of **Debian based linux distros should work as the
|
|
57
|
+
base image**. Here is an example of a minimal `Dockerfile` for E2B sandbox
|
|
52
58
|
template:
|
|
53
59
|
|
|
54
60
|
```Dockerfile
|
|
55
61
|
FROM ubuntu:22.04
|
|
56
62
|
```
|
|
57
63
|
|
|
58
|
-
3. Run `e2b build` inside the directory with the `Dockerfile` to create and
|
|
59
|
-
|
|
64
|
+
3. Run `e2b build` inside the directory with the `Dockerfile` to create and
|
|
65
|
+
build the sandbox template. You will get * _template ID_* that you use for
|
|
66
|
+
connecting to the sandbox via SDKs and for rebuilding the sandbox template
|
|
60
67
|
|
|
61
|
-
|
|
62
|
-
sandbox
|
|
68
|
+
4. Use the **template ID** that you got during the `e2b build` with the Python
|
|
69
|
+
or JS/TS SDK as the `id` to create sandbox
|
|
63
70
|
|
|
64
|
-
|
|
71
|
+
5. Rebuild the sandbox template by running `e2b build <id-of-the-template>` in
|
|
72
|
+
the directory with the `Dockerfile`
|
|
65
73
|
|
|
66
74
|
## Commands
|
|
67
75
|
|
|
68
|
-
All commands can be called with a `--path <path-to-dir>` flag that changes the
|
|
69
|
-
called, without the need to call `cd`.
|
|
76
|
+
All commands can be called with a `--path <path-to-dir>` flag that changes the
|
|
77
|
+
directory where the command will be called, without the need to call `cd`.
|
|
70
78
|
|
|
71
79
|
```sh
|
|
72
80
|
-V, --version Display E2B CLI version
|
|
@@ -76,19 +84,26 @@ called, without the need to call `cd`.
|
|
|
76
84
|
```sh
|
|
77
85
|
Usage: e2b template [options] [command]
|
|
78
86
|
|
|
79
|
-
|
|
87
|
+
Create sandbox templates from Dockerfiles by running e2b build then use our SDKs to create
|
|
88
|
+
sandboxes from these templates.
|
|
89
|
+
|
|
90
|
+
Visit E2B docs (https://e2b.dev/docs) to learn how to create sandbox templates
|
|
91
|
+
and start sandboxes.
|
|
80
92
|
|
|
81
93
|
Options:
|
|
82
94
|
-h, --help display help for command
|
|
83
95
|
|
|
84
96
|
Commands:
|
|
85
|
-
build|bd [options] [id] Build sandbox template defined by ./e2b.Dockerfile or
|
|
97
|
+
build|bd [options] [id] Build sandbox template defined by ./e2b.Dockerfile or
|
|
98
|
+
./Dockerfile in root directory. By default the root directory is the
|
|
99
|
+
current working directory. This command also creates e2b.toml config
|
|
86
100
|
|
|
87
101
|
list|ls List sandbox templates
|
|
88
102
|
|
|
89
103
|
shell|sh <id> Connect terminal to sandbox
|
|
90
104
|
|
|
91
|
-
init|it [options] Create basic E2B
|
|
105
|
+
init|it [options] Create basic E2B ./e2b.Dockerfile in root directory. You can then run
|
|
106
|
+
e2b build to build sandbox template from this Dockerfile
|
|
92
107
|
|
|
93
108
|
help [command] display help for command
|
|
94
109
|
```
|