github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention dev container in Development.md (#8726)

Browse Source
This commit is contained in:
Kent Johnson 2025-05-27 17:29:05 -05:00 committed by GitHub
parent 0023eb0982
commit 4b6f2aeb4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Development.md
View File

@ -1,8 +1,10 @@
# Development Guide # Development Guide
This guide is for people working on OpenHands and editing the source code. This guide is for people working on OpenHands and editing the source code.
If you wish to contribute your changes, check out the [CONTRIBUTING.md](https://github.com/All-Hands-AI/OpenHands/blob/main/CONTRIBUTING.md) on how to clone and setup the project If you wish to contribute your changes, check out the
initially before moving on. Otherwise, you can clone the OpenHands project directly. [CONTRIBUTING.md](https://github.com/All-Hands-AI/OpenHands/blob/main/CONTRIBUTING.md)
on how to clone and setup the project initially before moving on. Otherwise,
you can clone the OpenHands project directly.
## Start the Server for Development ## Start the Server for Development
@ -19,9 +21,20 @@ initially before moving on. Otherwise, you can clone the OpenHands project direc
Make sure you have all these dependencies installed before moving on to `make build`. Make sure you have all these dependencies installed before moving on to `make build`.
#### Dev container
There is a [dev container](https://containers.dev/) available which provides a
pre-configured environment with all the necessary dependencies installed if you
are using a [supported editor or tool](https://containers.dev/supporting). For
example, if you are using Visual Studio Code (VS Code) with the
[Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
extension installed, you can open the project in a dev container by using the
_Dev Container: Reopen in Container_ command from the Command Palette
(Ctrl+Shift+P).
#### Develop without sudo access #### Develop without sudo access
If you want to develop without system admin/sudo access to upgrade/install `Python` and/or `NodeJs`, you can use If you want to develop without system admin/sudo access to upgrade/install `Python` and/or `NodeJs`, you can use
`conda` or `mamba` to manage the packages for you: `conda` or `mamba` to manage the packages for you:
```bash ```bash
@ -37,7 +50,7 @@ mamba install conda-forge::poetry
### 2. Build and Setup The Environment ### 2. Build and Setup The Environment
Begin by building the project which includes setting up the environment and installing dependencies. This step ensures Begin by building the project which includes setting up the environment and installing dependencies. This step ensures
that OpenHands is ready to run on your system: that OpenHands is ready to run on your system:
```bash ```bash
@ -54,11 +67,11 @@ To configure the LM of your choice, run:
make setup-config make setup-config
``` ```
This command will prompt you to enter the LLM API key, model name, and other variables ensuring that OpenHands is This command will prompt you to enter the LLM API key, model name, and other variables ensuring that OpenHands is
tailored to your specific needs. Note that the model name will apply only when you run headless. If you use the UI, tailored to your specific needs. Note that the model name will apply only when you run headless. If you use the UI,
please set the model in the UI. please set the model in the UI.
Note: If you have previously run OpenHands using the docker command, you may have already set some environmental Note: If you have previously run OpenHands using the docker command, you may have already set some environmental
variables in your terminal. The final configurations are set from highest to lowest priority: variables in your terminal. The final configurations are set from highest to lowest priority:
Environment variables > config.toml variables > default variables Environment variables > config.toml variables > default variables
@ -77,14 +90,14 @@ make run
#### Option B: Individual Server Startup #### Option B: Individual Server Startup
- **Start the Backend Server:** If you prefer, you can start the backend server independently to focus on - **Start the Backend Server:** If you prefer, you can start the backend server independently to focus on
backend-related tasks or configurations. backend-related tasks or configurations.
```bash ```bash
make start-backend make start-backend
``` ```
- **Start the Frontend Server:** Similarly, you can start the frontend server on its own to work on frontend-related - **Start the Frontend Server:** Similarly, you can start the frontend server on its own to work on frontend-related
components or interface enhancements. components or interface enhancements.
```bash ```bash
make start-frontend make start-frontend
@ -120,7 +133,7 @@ poetry run pytest ./tests/unit/test_*.py
### 9. Use existing Docker image ### 9. Use existing Docker image
To reduce build time (e.g., if no changes were made to the client-runtime component), you can use an existing Docker To reduce build time (e.g., if no changes were made to the client-runtime component), you can use an existing Docker
container image by setting the SANDBOX_RUNTIME_CONTAINER_IMAGE environment variable to the desired Docker image. container image by setting the SANDBOX_RUNTIME_CONTAINER_IMAGE environment variable to the desired Docker image.
Example: `export SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.39-nikolaik` Example: `export SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.39-nikolaik`