From 1ff351a4f17b0f79bc4596f6c51eac58b076d069 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Mon, 14 Apr 2025 10:01:52 -0400 Subject: [PATCH] Add OpenHands Cloud to README, other minor tweaks (#7844) --- README.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a36229e3d4..adb24867d8 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Welcome to OpenHands (formerly OpenDevin), a platform for software development a OpenHands agents can do anything a human developer can: modify code, run commands, browse the web, call APIs, and yes—even copy code snippets from StackOverflow. -Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or jump to the [Quick Start](#-quick-start). +Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or [sign up for OpenHands Cloud](app.all-hands.dev) to get started. > [!IMPORTANT] > Using OpenHands for work? We'd love to chat! Fill out @@ -36,12 +36,21 @@ Learn more at [docs.all-hands.dev](https://docs.all-hands.dev), or jump to the [ ![App screenshot](./docs/static/img/screenshot.png) -## ⚡ Quick Start +## ☁️ OpenHands Cloud +The easiest way to get started with OpenHands is on [OpenHands Cloud](app.all-hands.dev), +which comes with $50 in free credits for new users. -The easiest way to run OpenHands is in Docker. +## 💻 Running OpenHands Locally + +OpenHands can also run on your laptop using Docker. See the [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) guide for system requirements and more information. +> [!WARNING] +> On a public network? See our [Hardened Docker Installation Guide](https://docs.all-hands.dev/modules/usage/runtimes/docker#hardened-docker-installation) +> to secure your deployment by restricting network binding and implementing additional security measures. + + ```bash docker pull docker.all-hands.dev/all-hands-ai/runtime:0.32-nikolaik @@ -56,17 +65,21 @@ docker run -it --rm --pull=always \ docker.all-hands.dev/all-hands-ai/openhands:0.32 ``` -> [!WARNING] -> On a public network? See our [Hardened Docker Installation](https://docs.all-hands.dev/modules/usage/runtimes/docker#hardened-docker-installation) guide -> to secure your deployment by restricting network binding and implementing additional security measures. - You'll find OpenHands running at [http://localhost:3000](http://localhost:3000)! -Finally, you'll need a model provider and API key. +When you open the application, you'll be asked to choose an LLM provider and add an API key. [Anthropic's Claude 3.5 Sonnet](https://www.anthropic.com/api) (`anthropic/claude-3-5-sonnet-20241022`) works best, but you have [many options](https://docs.all-hands.dev/modules/usage/llms). ---- +## 💡 Other ways to run OpenHands + +> [!CAUTION] +> OpenHands is meant to be run by a single user on their local workstation. +> It is not appropriate for multi-tenant deployments where multiple users share the same instance. There is no built-in authentication, isolation, or scalability. +> +> If you're interested in running OpenHands in a multi-tenant environment, please +> [get in touch with us](https://docs.google.com/forms/d/e/1FAIpQLSet3VbGaz8z32gW9Wm-Grl4jpt5WgMXPgJ4EDPVmCETCBpJtQ/viewform) +> for advanced deployment options. You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem), run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode), @@ -75,14 +88,6 @@ or run it on tagged issues with [a github action](https://docs.all-hands.dev/mod Visit [Running OpenHands](https://docs.all-hands.dev/modules/usage/installation) for more information and setup instructions. -> [!CAUTION] -> OpenHands is meant to be run by a single user on their local workstation. -> It is not appropriate for multi-tenant deployments where multiple users share the same instance. There is no built-in isolation or scalability. -> -> If you're interested in running OpenHands in a multi-tenant environment, please -> [get in touch with us](https://docs.google.com/forms/d/e/1FAIpQLSet3VbGaz8z32gW9Wm-Grl4jpt5WgMXPgJ4EDPVmCETCBpJtQ/viewform) -> for advanced deployment options. - If you want to modify the OpenHands source code, check out [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md). Having issues? The [Troubleshooting Guide](https://docs.all-hands.dev/modules/usage/troubleshooting) can help.