From 8f8b70f7fb44e9a0aee944f0b96ba48a15fafe0f Mon Sep 17 00:00:00 2001 From: openhands Date: Tue, 7 Oct 2025 16:49:22 +0000 Subject: [PATCH 01/16] Update package name from openhands-ai to openhands - Update uvx commands to use simplified 'openhands' instead of '--from openhands-ai openhands' - Change pip install commands from 'openhands-ai' to 'openhands' - Update shell aliases and installation examples across documentation - Sync with changes from OpenHands PR #11271 Co-authored-by: openhands --- openhands/usage/run-openhands/cli-mode.mdx | 10 +++++----- openhands/usage/run-openhands/gui-mode.mdx | 2 +- openhands/usage/run-openhands/local-setup.mdx | 8 ++++---- openhands/usage/runtimes/overview.mdx | 2 +- openhands/usage/windows-without-wsl.mdx | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/openhands/usage/run-openhands/cli-mode.mdx b/openhands/usage/run-openhands/cli-mode.mdx index 8c235ab4..13acb29a 100644 --- a/openhands/usage/run-openhands/cli-mode.mdx +++ b/openhands/usage/run-openhands/cli-mode.mdx @@ -32,7 +32,7 @@ We recommend using [uv](https://docs.astral.sh/uv/) for the best OpenHands exper 2. **Launch OpenHands CLI**: ```bash -uvx --python 3.12 --from openhands-ai openhands +uvx --python 3.12 openhands ``` @@ -43,7 +43,7 @@ If you prefer to use pip: ```bash # Install OpenHands -pip install openhands-ai +pip install openhands ``` Note that you'll still need `uv` installed for the default MCP servers to work properly. @@ -56,8 +56,8 @@ Add the following to your shell configuration file (`.bashrc`, `.zshrc`, etc.): ```bash # Add OpenHands aliases (recommended) -alias openhands="uvx --python 3.12 --from openhands-ai openhands" -alias oh="uvx --python 3.12 --from openhands-ai openhands" +alias openhands="uvx --python 3.12 openhands" +alias oh="uvx --python 3.12 openhands" ``` After adding these lines, reload your shell configuration with `source ~/.bashrc` or `source ~/.zshrc` (depending on your shell). @@ -74,7 +74,7 @@ cd ~ uv venv .openhands-venv --python 3.12 # Install OpenHands in the virtual environment -uv pip install -t ~/.openhands-venv/lib/python3.12/site-packages openhands-ai +uv pip install -t ~/.openhands-venv/lib/python3.12/site-packages openhands # Add the bin directory to your PATH in your shell configuration file echo 'export PATH="$PATH:$HOME/.openhands-venv/bin"' >> ~/.bashrc # or ~/.zshrc diff --git a/openhands/usage/run-openhands/gui-mode.mdx b/openhands/usage/run-openhands/gui-mode.mdx index 861d3d1c..c68ed957 100644 --- a/openhands/usage/run-openhands/gui-mode.mdx +++ b/openhands/usage/run-openhands/gui-mode.mdx @@ -14,7 +14,7 @@ description: High level overview of the Graphical User Interface (GUI) in OpenHa You can launch the OpenHands GUI server directly from the command line using the `serve` command: -**Prerequisites**: You need to have the [OpenHands CLI installed](/usage/run-openhands/cli-mode) first, OR have `uv` installed and run `uvx --python 3.12 --from openhands-ai openhands serve`. Otherwise, you'll need to use Docker directly (see the [Docker section](#using-docker-directly) below). +**Prerequisites**: You need to have the [OpenHands CLI installed](/usage/run-openhands/cli-mode) first, OR have `uv` installed and run `uvx --python 3.12 openhands serve`. Otherwise, you'll need to use Docker directly (see the [Docker section](#using-docker-directly) below). ```bash diff --git a/openhands/usage/run-openhands/local-setup.mdx b/openhands/usage/run-openhands/local-setup.mdx index 1801cffc..73c48fcf 100644 --- a/openhands/usage/run-openhands/local-setup.mdx +++ b/openhands/usage/run-openhands/local-setup.mdx @@ -84,13 +84,13 @@ See the [uv installation guide](https://docs.astral.sh/uv/getting-started/instal **Launch OpenHands**: ```bash # Launch the GUI server -uvx --python 3.12 --from openhands-ai openhands serve +uvx --python 3.12 openhands serve # Or with GPU support (requires nvidia-docker) -uvx --python 3.12 --from openhands-ai openhands serve --gpu +uvx --python 3.12 openhands serve --gpu # Or with current directory mounted -uvx --python 3.12 --from openhands-ai openhands serve --mount-cwd +uvx --python 3.12 openhands serve --mount-cwd ``` This will automatically handle Docker requirements checking, image pulling, and launching the GUI server. The `--gpu` flag enables GPU support via nvidia-docker, and `--mount-cwd` mounts your current directory into the container. @@ -101,7 +101,7 @@ If you prefer to use pip and have Python 3.12+ installed: ```bash # Install OpenHands -pip install openhands-ai +pip install openhands # Launch the GUI server openhands serve diff --git a/openhands/usage/runtimes/overview.mdx b/openhands/usage/runtimes/overview.mdx index 25ab882c..b11a54fc 100644 --- a/openhands/usage/runtimes/overview.mdx +++ b/openhands/usage/runtimes/overview.mdx @@ -25,7 +25,7 @@ OpenHands supports several different runtime environments: The following third-party runtimes are available when you install the `third_party_runtimes` extra: ```bash -pip install openhands-ai[third_party_runtimes] +pip install openhands[third_party_runtimes] ``` - [E2B Runtime](/usage/runtimes/e2b) - Open source runtime using E2B sandboxes. diff --git a/openhands/usage/windows-without-wsl.mdx b/openhands/usage/windows-without-wsl.mdx index f09d874a..a1bad745 100644 --- a/openhands/usage/windows-without-wsl.mdx +++ b/openhands/usage/windows-without-wsl.mdx @@ -162,7 +162,7 @@ After installation, restart your PowerShell session to ensure the environment va After installing the prerequisites, you can install and run OpenHands with: ```powershell -uvx --python 3.12 --from openhands-ai openhands +uvx --python 3.12 openhands ``` ### Troubleshooting CLI Issues From 0b3aae0e2a03d30912f4c9de8d85595e295f1d36 Mon Sep 17 00:00:00 2001 From: Rohit Malhotra Date: Tue, 7 Oct 2025 12:50:20 -0400 Subject: [PATCH 02/16] Apply suggestion from @malhotra5 --- openhands/usage/runtimes/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openhands/usage/runtimes/overview.mdx b/openhands/usage/runtimes/overview.mdx index b11a54fc..25ab882c 100644 --- a/openhands/usage/runtimes/overview.mdx +++ b/openhands/usage/runtimes/overview.mdx @@ -25,7 +25,7 @@ OpenHands supports several different runtime environments: The following third-party runtimes are available when you install the `third_party_runtimes` extra: ```bash -pip install openhands[third_party_runtimes] +pip install openhands-ai[third_party_runtimes] ``` - [E2B Runtime](/usage/runtimes/e2b) - Open source runtime using E2B sandboxes. From fa3ec1b7f58a7edf1ef78df94b18ce7bebf0b27b Mon Sep 17 00:00:00 2001 From: openhands Date: Tue, 7 Oct 2025 16:55:40 +0000 Subject: [PATCH 03/16] Make executable binary the primary CLI installation method - Restructure Getting Started section to prioritize executable binary - Move uv and pip methods to accordion alternatives - Simplify instructions and remove verbose explanations --- openhands/usage/run-openhands/cli-mode.mdx | 30 ++++++++++++---------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/openhands/usage/run-openhands/cli-mode.mdx b/openhands/usage/run-openhands/cli-mode.mdx index 13acb29a..2d99d72e 100644 --- a/openhands/usage/run-openhands/cli-mode.mdx +++ b/openhands/usage/run-openhands/cli-mode.mdx @@ -18,36 +18,38 @@ for scripting. ## Getting Started -### Running with Python +### Using Executable Binary (Recommended) -**Note** - OpenHands requires Python version 3.12 or higher (Python 3.14 is not currently supported) and `uv` for the default `fetch` MCP server (more details below). +1. **Download the executable binary** from [https://github.com/All-Hands-AI/OpenHands/releases](https://github.com/All-Hands-AI/OpenHands/releases) -#### Recommended: Using uv +2. **Make it executable**: +```bash +chmod +x ./openhands +``` + +3. **Run the executable**: +```bash +./openhands +``` -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. + -1. **Install uv** (if you haven't already): + - See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for the latest installation instructions for your platform. +Requires Python 3.12+ and uv installed. -2. **Launch OpenHands CLI**: ```bash uvx --python 3.12 openhands ``` - - - + -If you prefer to use pip: + ```bash -# Install OpenHands pip install openhands ``` -Note that you'll still need `uv` installed for the default MCP servers to work properly. - From 4a12b9244f918f219cecc395c9644a9e8366e7a7 Mon Sep 17 00:00:00 2001 From: openhands Date: Tue, 7 Oct 2025 17:02:42 +0000 Subject: [PATCH 04/16] Update CLI page title to 'CLI (V1)' and add migration note - Change page title from 'CLI' to 'CLI (V1)' - Add note about settings migration for users upgrading from pre-1.X.X versions --- openhands/usage/run-openhands/cli-mode.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openhands/usage/run-openhands/cli-mode.mdx b/openhands/usage/run-openhands/cli-mode.mdx index 2d99d72e..08c19bcf 100644 --- a/openhands/usage/run-openhands/cli-mode.mdx +++ b/openhands/usage/run-openhands/cli-mode.mdx @@ -1,5 +1,5 @@ --- -title: CLI +title: CLI (V1) description: The Command-Line Interface (CLI) provides a powerful interface that lets you engage with OpenHands directly from your terminal. --- @@ -7,6 +7,10 @@ description: The Command-Line Interface (CLI) provides a powerful interface that This mode is different from the [headless mode](/openhands/usage/run-openhands/headless-mode), which is non-interactive and better for scripting. + +If you're upgrading from a CLI version before release 1.X.X, you'll need to redo your settings setup as the configuration format has changed. + +