diff --git a/apps/web/src/app/(docs)/docs/cli/page.mdx b/apps/web/src/app/(docs)/docs/cli/page.mdx index ec1bc98183..2aba777e50 100644 --- a/apps/web/src/app/(docs)/docs/cli/page.mdx +++ b/apps/web/src/app/(docs)/docs/cli/page.mdx @@ -4,6 +4,16 @@ E2B CLI is a command line tool that allows you to list, kill running sandboxes, ## Installation +**Using Homebrew (on macOS)** + + +```bash +brew install e2b +``` + + +**Using NPM** + You can install E2B CLI using the following command: @@ -14,7 +24,7 @@ npm i -g @e2b/cli ### Beta CLI -The latest beta version of the CLI can be installed using the following command: +The latest beta version of the CLI can be installed from NPM using the following command: ```bash diff --git a/apps/web/src/app/(docs)/docs/quickstart/install-custom-packages/page.mdx b/apps/web/src/app/(docs)/docs/quickstart/install-custom-packages/page.mdx index 3b827ce920..27c24dcc21 100644 --- a/apps/web/src/app/(docs)/docs/quickstart/install-custom-packages/page.mdx +++ b/apps/web/src/app/(docs)/docs/quickstart/install-custom-packages/page.mdx @@ -21,7 +21,17 @@ Custom sandbox template is a Docker image that we automatically convert to a san ### 1. Install E2B CLI -Install the [E2B CLI](https://npmjs.com/package/@e2b/cli) globally on your machine with NPM. + +**Using Homebrew (on macOS)** + + +```bash +brew install e2b +``` + + +**Using NPM** + ```bash npm i -g @e2b/cli diff --git a/apps/web/src/app/(docs)/docs/sandbox-template/page.mdx b/apps/web/src/app/(docs)/docs/sandbox-template/page.mdx index 7a1e75ac7d..700a75e072 100644 --- a/apps/web/src/app/(docs)/docs/sandbox-template/page.mdx +++ b/apps/web/src/app/(docs)/docs/sandbox-template/page.mdx @@ -17,10 +17,20 @@ You can then use this template ID to create a new sandbox with the SDK based on ### 1. Install E2B CLI -Install E2B CLI with npm: + +**Using Homebrew (on macOS)** + + +```bash +brew install e2b +``` + + +**Using NPM** + ```bash -npm i @e2b/cli +npm i -g @e2b/cli ``` diff --git a/packages/cli/README.md b/packages/cli/README.md index 8a5a16773b..fad54d8080 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -8,6 +8,14 @@ This CLI tool allows you to build manager your running E2B sandbox and sandbox t ### 1. Install the CLI +**Using Homebrew (on macOS)** + +```bash +brew install e2b +``` + +**Using NPM** + ```bash npm install -g @e2b/cli ``` @@ -18,7 +26,7 @@ npm install -g @e2b/cli e2b auth login ``` -> [!NOTE] +> [!NOTE] > To authenticate without the ability to open the browser, provide > `E2B_ACCESS_TOKEN` as an environment variable. Get your `E2B_ACCESS_TOKEN` > from the Personal tab at [e2b.dev/dashboard](https://e2b.dev/dashboard). Then use the CLI like this: @@ -28,4 +36,5 @@ e2b auth login > Note the distinction between `E2B_ACCESS_TOKEN` and `E2B_API_KEY`. ### 3. Check out docs + Visit our [CLI documentation](https://e2b.dev/docs) to learn more.