Skip to content
Merged
Changes from all commits
Commits
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
18 changes: 8 additions & 10 deletions openhands/usage/run-openhands/local-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: Getting started with running OpenHands on your own.
---

## Recommended Methods for Running Openhands on Your Local System

Check warning on line 6 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L6

Did you really mean 'Openhands'?

### System Requirements

Expand Down Expand Up @@ -68,11 +68,11 @@

### Start the App

#### Option 1: Using the CLI Launcher with uv (Recommended)

Check warning on line 71 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L71

Did you really mean 'uv'?

We recommend using [uv](https://docs.astral.sh/uv/) for the best OpenHands experience. uv provides better isolation from your current project's virtual environment and is required for OpenHands' default MCP servers (like the [fetch MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch)).

Check warning on line 73 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L73

Did you really mean 'uv'?

**Install uv** (if you haven't already):

Check warning on line 75 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L75

Did you really mean 'uv'?

See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for the latest installation instructions for your platform.

Expand Down Expand Up @@ -121,17 +121,15 @@
<Accordion title="Docker Command (Click to expand)">

```bash
docker pull docker.openhands.dev/openhands/runtime:1.2-nikolaik

docker run -it --rm --pull=always \
-e AGENT_SERVER_IMAGE_REPOSITORY=docker.openhands.dev/openhands/runtime \
-e AGENT_SERVER_IMAGE_TAG=1.2-nikolaik \
-e LOG_ALL_EVENTS=true \
-v /var/run/docker.sock:/var/run/docker.sock \
-v ~/.openhands:/.openhands \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
--name openhands-app \
-e AGENT_SERVER_IMAGE_REPOSITORY=ghcr.io/openhands/agent-server \
-e AGENT_SERVER_IMAGE_TAG=1.10.0-python \
-e LOG_ALL_EVENTS=true \
-v /var/run/docker.sock:/var/run/docker.sock \
-v ~/.openhands:/.openhands \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
--name openhands-app \
docker.openhands.dev/openhands/openhands:1.2
```

Expand Down Expand Up @@ -215,8 +213,8 @@

To enable search functionality in OpenHands:

1. Get a Tavily API key from [tavily.com](https://tavily.com/).

Check warning on line 216 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L216

Did you really mean 'Tavily'?
2. Enter the Tavily API key in the Settings page under `LLM` tab > `Search API Key (Tavily)`

Check warning on line 217 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L217

Did you really mean 'Tavily'?

For more details, see the [Search Engine Setup](/openhands/usage/advanced/search-engine-setup) guide.

Expand Down