Skip to content

docs: clarify README install option requirements #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamiechicago312 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify README install option requirements #945

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec59aaa
Clarify README install option requirements
openhands-agent May 29, 2026
cb6f7b5
Merge branch 'main' into docs/readme-install-option-notes
chuckbutkus May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ agent-canvas

### Option 2: With a Docker Sandbox

**Prerequisites**: Docker, plus a host directory containing the projects you want to mount into the container

```sh
docker pull ghcr.io/openhands/agent-canvas:1.0.0-alpha.9

Expand All @@ -74,10 +76,11 @@ docker run -it --rm \

The agent will be able to access any project under `PROJECTS_PATH`.



### Option 3: From Source

> [!WARNING]
> This runs the agent-server directly on the machine you're installing on — the agent will have full access to your filesystem!

**Prerequisites**: Node.js 22.12.x or later, `npm`, `uv` (for running the agent server via `uvx`)

```sh
Expand Down
Loading