mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 13:52:43 +08:00

* update badges

* fix badges

* better badges

* move credits

* more badge work

* add gh logo

* update some copy

* update logo

* fix height

* update text

* emdash

* remove cruft

* move title

* update links

* add hr

* white logo

* move some stuff to getting-started

* revert logo

* more copy changes

* minor tweaks

* fix sidebar

* explicit sidebar

* words

* fix tag

* fix how-to

* more docs work

* update styles

* fix up custom sandbox docs

* change eval title

* fix up getting-started

* fix getting started

* update to 0.9.2

* update screenshot

* add company link

* fix dark mode

* minor fixes

* update image

* update headless and cli docs

* update readme

* fix links

* revert package

* rename links

* fix links

* fix link

* chagne to claude

2024-09-04 21:22:52 +00:00

2.7 KiB

Raw Blame History

sidebar_position

sidebar_position
2

⚡Getting Started

System Requirements

Docker version 26.0.0+ or Docker Desktop 4.31.0+
You must be using Linux or Mac OS
- If you are on Windows, you must use WSL

Installation

The easiest way to run OpenHands is in Docker. Use WORKSPACE_BASE below to specify which folder the OpenHands agent should modify.

WORKSPACE_BASE=$(pwd)/workspace

docker run -it --pull=always \
    -e SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.9.2-nikolaik \
    -e SANDBOX_USER_ID=$(id -u) \
    -e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
    -v $WORKSPACE_BASE:/opt/workspace_base \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -p 3000:3000 \
    --add-host host.docker.internal:host-gateway \
    --name openhands-app-$(date +%Y%m%d%H%M%S) \
    ghcr.io/all-hands-ai/openhands:0.9

You can also run OpenHands in a scriptable headless mode, or as an interactive CLI.

Setup

After running the command above, you'll find OpenHands running at http://localhost:3000.

The agent will have access to the ./workspace folder to do its work. You can copy existing code here, or change WORKSPACE_BASE in the command to point to an existing folder.

Upon launching OpenHands, you'll see a settings modal. You must select an LLM backend using 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 Model does not exist in the list, you can manually enter it in the text box.

Versions

The command above pulls the 0.9 tag, which represents the most recent stable release of OpenHands. You have other options as well:

For a specific release, use ghcr.io/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 ghcr.io/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.

2.7 KiB Raw Blame History