@e2b/cli 0.0.13 → 0.0.15

package/README.md

@@ -20,6 +20,13 @@
 
 [E2B](https://e2b.dev) (_english2bits_) is a cloud operating system for AI agents.
 
+This CLI tool allows you to build and manage E2B sandbox templates from your terminal.
+
+You define your sandbox template in a `Dockerfile` and then use the CLI to build the sandbox template. You can then
+connect to the sandbox template via SDKs and run your AI agents.
+
+The `Dockerfile` is the same as for Docker, but you can only use **Debian based linux distros** as the base image.
+
 ## Installation
 
 ```bash
@@ -36,37 +43,52 @@ e2b --help
 
 1. Authenticate with `e2b login`
 
-> To authenticate without the ability to open browser, you can provide `E2B_ACCESS_TOKEN` as an environment variable. Get your `E2B_ACCESS_TOKEN` from [e2b.dev/docs](https://e2b.dev/docs). Then use the CLI like this: `E2B_ACCESS_TOKEN=sk_e2b_... e2b build`
+> To authenticate without the ability to open browser, you can provide `E2B_ACCESS_TOKEN` as an environment variable.
+> Get your `E2B_ACCESS_TOKEN` from [e2b.dev/docs](https://e2b.dev/docs). Then use the CLI like
+> this: `E2B_ACCESS_TOKEN=sk_e2b_... e2b build`
 
-2. Create a `Dockerfile` where you describe how your custom E2B environment should look like
+2. Create a `Dockerfile` where you describe how your custom E2B sandbox template should look like. Majority of **Debian
+   based linux distros should work as the base image**. Here is an example of a minimal `Dockerfile` for E2B sandbox
+   template:
 
-3. Run `e2b build` inside the directory with the `Dockerfile` to create and build the environment. You will get **environment ID** that you use for connecting to the environment instances via SDKs and for rebuilding the environment
+```Dockerfile
+FROM ubuntu:22.04
+```
 
-5. Use the **environment ID** that you got during the `e2b build` with the Python or JS/TS SDK as the `id` to create environment instances
+3. Run `e2b build` inside the directory with the `Dockerfile` to create and build the sandbox template. You will get *
+   _template ID_* that you use for connecting to the sandbox via SDKs and for rebuilding the sandbox template
 
-6. Rebuild the environment by running `e2b build <id-of-the-environment>` in the directory with the `Dockerfile`
+5. Use the **template ID** that you got during the `e2b build` with the Python or JS/TS SDK as the `id` to create
+   sandbox
 
+6. Rebuild the sandbox template by running `e2b build <id-of-the-template>` in the directory with the `Dockerfile`
 
 ## Commands
 
-All commands can be called with a `--path <path-to-dir>` flag that changes the directory where the command will be called, without the need to call `cd`.
+All commands can be called with a `--path <path-to-dir>` flag that changes the directory where the command will be
+called, without the need to call `cd`.
 
 ```sh
--V, --version    Display e2b CLI version
+-V, --version    Display E2B CLI version
 -h, --help       display help for command
 ```
 
 ```sh
-Usage: e2b env [options] [command]
+Usage: e2b template [options] [command]
 
-Manage e2b environments
+Manage E2B sandbox templates
 
 Options:
   -h, --help               display help for command
 
 Commands:
-  build|bd [options] [id]  Build environment
-  list|ls                  List environments
-  shell|sh <id>            Connect terminal to environment
+  build|bd [options] [id]  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
+
+  list|ls                  List sandbox templates
+
+  shell|sh <id>            Connect terminal to sandbox
+
+  init|it [options]        Create basic E2B `e2b.Dockerfile` in root directory. You can then run `e2b template build` to build sandbox template from this Dockerfile
+
   help [command]           display help for command
 ```