Skip to main content

Running OpenHands

System Requirements​

Prerequisites​

MacOS

Docker Desktop​

  1. Install Docker Desktop on Mac.
  2. Open Docker Desktop, go to Settings > Advanced and ensure Allow the default Docker socket to be used is enabled.
Linux
note

Tested with Ubuntu 22.04.

Docker Desktop​

  1. Install Docker Desktop on Linux.
Windows

WSL​

  1. Install WSL.
  2. Run wsl --version in powershell and confirm Default Version: 2.

Docker Desktop​

  1. Install Docker Desktop on Windows.
  2. Open Docker Desktop, go to Settings and confirm the following:
  • General: Use the WSL 2 based engine is enabled.
  • Resources > WSL Integration: Enable integration with my default WSL distro is enabled.
note

The docker command below to start the app must be run inside the WSL terminal.

Start the App​

The easiest way to run OpenHands is in Docker.

docker pull docker.all-hands.dev/all-hands-ai/runtime:0.22-nikolaik

docker run -it --rm --pull=always \
    -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.22-nikolaik \
    -e LOG_ALL_EVENTS=true \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v ~/.openhands-state:/.openhands-state \
    -p 3000:3000 \
    --add-host host.docker.internal:host-gateway \
    --name openhands-app \
    docker.all-hands.dev/all-hands-ai/openhands:0.22

You'll find OpenHands running at http://localhost:3000!

You can also connect OpenHands to your local filesystem, run OpenHands in a scriptable headless mode, interact with it via a friendly CLI, or run it on tagged issues with a github action.

Setup​

Upon launching OpenHands, you'll see a settings modal. You must select an LLM Provider and LLM Model and enter a corresponding API Key. These can be changed at any time by selecting the Settings button (gear icon) in the UI.

If the required LLM Model does not exist in the list, you can toggle Advanced Options and manually enter it with the correct prefix in the Custom Model text box. The Advanced Options also allow you to specify a Base URL if required.

settings-modalsettings-modal

Versions​

The command above pulls the most recent stable release of OpenHands. You have other options as well:

  • For a specific release, use docker.all-hands.dev/all-hands-ai/openhands:$VERSION, replacing $VERSION with the version number.
  • We use semver, and release major, minor, and patch tags. So 0.9 will automatically point to the latest 0.9.x release, and 0 will point to the latest 0.x.x release.
  • For the most up-to-date development version, you can use docker.all-hands.dev/all-hands-ai/openhands:main. This version is unstable and is recommended for testing or development purposes only.

You can choose the tag that best suits your needs based on stability requirements and desired features.

For the development workflow, see Development.md.

Are you having trouble? Check out our Troubleshooting Guide.