Skip to content

πŸ™Œ OpenHands: AI-Driven Development

chore: daytona runtime windows README.md and docs (#7396)

Ivan Dagelice95c2bf521ab
diff --git a/docs/modules/usage/runtimes/daytona.md b/docs/modules/usage/runtimes/daytona.md
index 107f957c5a..b400b91135 100644
--- a/docs/modules/usage/runtimes/daytona.md
+++ b/docs/modules/usage/runtimes/daytona.md
@@ -10,18 +10,32 @@ You can use [Daytona](https://www.daytona.io/) as a runtime provider:
## Step 2: Set Your API Key as an Environment Variable
Run the following command in your terminal, replacing `<your-api-key>` with the actual key you copied:
+
+### Mac/Linux:
```bash
export DAYTONA_API_KEY="<your-api-key>"
```
+### Windows PowerShell:
+```powershell
+$env:DAYTONA_API_KEY="<your-api-key>"
+```
+
This step ensures that OpenHands can authenticate with the Daytona platform when it runs.
## Step 3: Run OpenHands Locally Using Docker
To start the latest version of OpenHands on your machine, execute the following command in your terminal:
+
+### Mac/Linux:
```bash
bash -i <(curl -sL https://get.daytona.io/openhands)
```
+### Windows:
+```powershell
+powershell -Command "irm https://get.daytona.io/openhands-windows | iex"
+```
+
### What This Command Does:
- Downloads the latest OpenHands release script.
- Runs the script in an interactive Bash session.
diff --git a/openhands/runtime/impl/daytona/README.md b/openhands/runtime/impl/daytona/README.md
index d319b87b9e..f37dce64ea 100644
--- a/openhands/runtime/impl/daytona/README.md
+++ b/openhands/runtime/impl/daytona/README.md
@@ -12,18 +12,32 @@
### Step 2: Set Your API Key as an Environment Variable
Run the following command in your terminal, replacing `<your-api-key>` with the actual key you copied:
+
+Mac/Linux:
```bash
export DAYTONA_API_KEY="<your-api-key>"
```
+Windows PowerShell:
+```powershell
+$env:DAYTONA_API_KEY="<your-api-key>"
+```
+
This step ensures that OpenHands can authenticate with the Daytona platform when it runs.
### Step 3: Run OpenHands Locally Using Docker
To start the latest version of OpenHands on your machine, execute the following command in your terminal:
+
+Mac/Linux:
```bash
bash -i <(curl -sL https://get.daytona.io/openhands)
```
+Windows:
+```powershell
+powershell -Command "irm https://get.daytona.io/openhands-windows | iex"
+```
+
#### What This Command Does:
- Downloads the latest OpenHands release script.
- Runs the script in an interactive Bash session.
@@ -36,10 +50,16 @@ Once executed, OpenHands should be running locally and ready for use.
### Step 1: Set the `OPENHANDS_VERSION` Environment Variable
Run the following command in your terminal, replacing `<openhands-release>` with the latest release's version seen in the [main README.md file](https://github.com/All-Hands-AI/OpenHands?tab=readme-ov-file#-quick-start):
+#### Mac/Linux:
```bash
export OPENHANDS_VERSION="<openhands-release>" # e.g. 0.27
```
+#### Windows PowerShell:
+```powershell
+$env:OPENHANDS_VERSION="<openhands-release>" # e.g. 0.27
+```
+
### Step 2: Retrieve Your Daytona API Key
1. Visit the [Daytona Dashboard](https://app.daytona.io/dashboard/keys).
2. Click **"Create Key"**.
@@ -48,13 +68,21 @@ export OPENHANDS_VERSION="<openhands-release>" # e.g. 0.27
### Step 3: Set Your API Key as an Environment Variable:
Run the following command in your terminal, replacing `<your-api-key>` with the actual key you copied:
+
+#### Mac/Linux:
```bash
export DAYTONA_API_KEY="<your-api-key>"
```
+#### Windows PowerShell:
+```powershell
+$env:DAYTONA_API_KEY="<your-api-key>"
+```
+
### Step 4: Run the following `docker` command:
This command pulls and runs the OpenHands container using Docker. Once executed, OpenHands should be running locally and ready for use.
+#### Mac/Linux:
```bash
docker run -it --rm --pull=always \
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:${OPENHANDS_VERSION}-nikolaik \
@@ -67,16 +95,36 @@ docker run -it --rm --pull=always \
docker.all-hands.dev/all-hands-ai/openhands:${OPENHANDS_VERSION}
```
+#### Windows:
+```powershell
+docker run -it --rm --pull=always `
+ -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:${env:OPENHANDS_VERSION}-nikolaik `
+ -e LOG_ALL_EVENTS=true `
+ -e RUNTIME=daytona `
+ -e DAYTONA_API_KEY=${env:DAYTONA_API_KEY} `
+ -v ~/.openhands-state:/.openhands-state `
+ -p 3000:3000 `
+ --name openhands-app `
+ docker.all-hands.dev/all-hands-ai/openhands:${env:OPENHANDS_VERSION}
+```
+
> **Tip:** If you don't want your sandboxes to default to the EU region, you can set the `DAYTONA_TARGET` environment variable to `us`
### Running OpenHands Locally Without Docker
Alternatively, if you want to run the OpenHands app on your local machine using `make run` without Docker, make sure to set the following environment variables first:
+#### Mac/Linux:
```bash
export RUNTIME="daytona"
export DAYTONA_API_KEY="<your-api-key>"
```
+#### Windows PowerShell:
+```powershell
+$env:RUNTIME="daytona"
+$env:DAYTONA_API_KEY="<your-api-key>"
+```
+
## Documentation
Read more by visiting our [documentation](https://www.daytona.io/docs/) page.