diff --git a/.openhands/microagents/repo.md b/.openhands/microagents/repo.md index 66d7cda666..aa24fe1746 100644 --- a/.openhands/microagents/repo.md +++ b/.openhands/microagents/repo.md @@ -5,6 +5,18 @@ This repository contains the code for OpenHands, an automated AI software engine To set up the entire repo, including frontend and backend, run `make build`. You don't need to do this unless the user asks you to, or if you're trying to run the entire application. +## Running OpenHands with OpenHands: +To run the full application for development or self-improvement: +```bash +export INSTALL_DOCKER=0 +export RUNTIME=local +make build && make run +``` +For external access (cloud environments), use: +```bash +make run FRONTEND_PORT=12000 FRONTEND_HOST=0.0.0.0 BACKEND_HOST=0.0.0.0 +``` + IMPORTANT: Before making any changes to the codebase, ALWAYS run `make install-pre-commit-hooks` to ensure pre-commit hooks are properly installed. Before pushing any changes, you MUST ensure that any lint errors or simple test errors have been fixed. diff --git a/Development.md b/Development.md index 8604384c70..32bad58de8 100644 --- a/Development.md +++ b/Development.md @@ -103,6 +103,29 @@ components or interface enhancements. make start-frontend ``` +### 5. Running OpenHands with OpenHands + +You can use OpenHands to develop and improve OpenHands itself! This is a powerful way to leverage AI assistance for contributing to the project. + +#### Quick Start + +1. **Build and run OpenHands:** + ```bash + export INSTALL_DOCKER=0 + export RUNTIME=local + make build && make run + ``` + +2. **Access the interface:** + - Local development: http://localhost:3001 + - Remote/cloud environments: Use the appropriate external URL + +3. **Configure for external access (if needed):** + ```bash + # For external access (e.g., cloud environments) + make run FRONTEND_PORT=12000 FRONTEND_HOST=0.0.0.0 BACKEND_HOST=0.0.0.0 + ``` + ### 6. LLM Debugging If you encounter any issues with the Language Model (LM) or you're simply curious, export DEBUG=1 in the environment and restart the backend.