Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmurdza authored Nov 4, 2024
1 parent 02a0ee8 commit cfb996a
Showing 1 changed file with 39 additions and 16 deletions.
55 changes: 39 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,55 @@ https://github.com/user-attachments/assets/07d42297-27f1-4119-8f4c-c102bf205b10

> ⚠️ **Caution:** While this agent runs in a secure cloud Sandbox, you should avoid giving it access to sensitive data (such as account login information) and supervise it to prevent unwanted behavior. In some circumstances, Claude will follow commands found on webpages or contained in images, overriding user instructions and causing Claude to make mistakes.
## Quickstart
## Get started

### Prerequisites

This project requires:
- [git](https://git-scm.com/)
- [E2B API key](https://e2b.dev/dashboard?tab=keys)
- [Anthropic API key](https://console.anthropic.com/settings/keys)

- Python 3.11
- macOS: `brew install [email protected]`
- ImageMagick:
- macOS: `brew install imagemagick`
- API keys for [Anthropic](https://console.anthropic.com/settings/keys) and [E2B](https://e2b.dev/dashboard?tab=keys).
### 1. Install the prerequisites

### Running the agent
In your terminal:

First, copy `example.env` to `.env`, and add your E2B API key to the new file.
```sh
brew install [email protected] poetry imagemagick
```

To start the server, run the following command in the project directory:
### 2. Clone the repository

`sh start.sh`
In your terminal:

You can then then access the Streamlit interface in your browser at http://localhost:8501.
```sh
git clone https://github.com/e2b-dev/secure-computer-use/
```

With the open Streamlit interface open, you can configure your Anthropic API key:
### 3. Set the environment variables

<img src="https://github.com/user-attachments/assets/444dc5f7-523d-437c-9e4c-1f12d2f58ac1" alt="Configure Anthropic API Key" height="100" />
Enter the project directory:

Finally, enter a prompt to start the agent:
```
cd secure-computer-use
```

<img src="https://github.com/user-attachments/assets/f9ca4c86-844c-410c-87f1-a60c0ab77b3e" alt="Enter a prompt to start the agent" height="100" />
Create a `.env` file in `secure-computer-use` and set the following:

```sh
# Get your API key here - https://e2b.dev/
E2B_API_KEY="your-e2b-api-key"
```

### 4. Start the web interface

Run the following command to start the web server:

```sh
sh start.sh
```

You can then now access the Streamlit interface in your browser at http://localhost:8501.

### 5. Configure the LLM

Finally, in the settings of the web app, configure the LLM provider you want to use.

0 comments on commit cfb996a

Please sign in to comment.