+
+Welcome to OpenHands (formerly OpenDevin), a platform for software development agents powered by AI.
+
+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 [sign up for OpenHands Cloud](https://app.all-hands.dev) to get started.
+
+> [!IMPORTANT]
+> Using OpenHands for work? We'd love to chat! Fill out
+> [this short form](https://docs.google.com/forms/d/e/1FAIpQLSet3VbGaz8z32gW9Wm-Grl4jpt5WgMXPgJ4EDPVmCETCBpJtQ/viewform)
+> to join our Design Partner program, where you'll get early access to commercial features and the opportunity to provide input on our product roadmap.
+
+
+
+## ☁️ OpenHands Cloud
+The easiest way to get started with OpenHands is on [OpenHands Cloud](https://app.all-hands.dev),
+which comes with $50 in free credits for new users.
+
+## 💻 Running OpenHands Locally
+
+OpenHands can also run on your local system using Docker.
+See the [Running OpenHands](https://docs.all-hands.dev/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/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.41-nikolaik
+
+docker run -it --rm --pull=always \
+ -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.41-nikolaik \
+ -e LOG_ALL_EVENTS=true \
+ -v /var/run/docker.sock:/var/run/docker.sock \
+ -v ~/.openhands-state:/.openhands-state \
+ -p 3000:3000 \
+ --add-host host.docker.internal:host-gateway \
+ --name openhands-app \
+ docker.all-hands.dev/all-hands-ai/openhands:0.41
+```
+
+You'll find OpenHands running at [http://localhost:3000](http://localhost:3000)!
+
+When you open the application, you'll be asked to choose an LLM provider and add an API key.
+[Anthropic's Claude Sonnet 4](https://www.anthropic.com/api) (`anthropic/claude-sonnet-4-20250514`)
+works best, but you have [many options](https://docs.all-hands.dev/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/usage/runtimes/docker#connecting-to-your-filesystem),
+run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/usage/how-to/headless-mode),
+interact with it via a [friendly CLI](https://docs.all-hands.dev/usage/how-to/cli-mode),
+or run it on tagged issues with [a github action](https://docs.all-hands.dev/usage/how-to/github-action).
+
+Visit [Running OpenHands](https://docs.all-hands.dev/usage/installation) for more information and setup instructions.
+
+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/usage/troubleshooting) can help.
+
+## 📖 Documentation
+
+
+To learn more about the project, and for tips on using OpenHands,
+check out our [documentation](https://docs.all-hands.dev/usage/getting-started).
+
+There you'll find resources on how to use different LLM providers,
+troubleshooting resources, and advanced configuration options.
+
+## 🤝 How to Join the Community
+
+OpenHands is a community-driven project, and we welcome contributions from everyone. We do most of our communication
+through Slack, so this is the best place to start, but we also are happy to have you contact us on Discord or Github:
+
+- [Join our Slack workspace](https://join.slack.com/t/openhands-ai/shared_invite/zt-34zm4j0gj-Qz5kRHoca8DFCbqXPS~f_A) - Here we talk about research, architecture, and future development.
+- [Join our Discord server](https://discord.gg/ESHStjSjD4) - This is a community-run server for general discussion, questions, and feedback.
+- [Read or post Github Issues](https://github.com/All-Hands-AI/OpenHands/issues) - Check out the issues we're working on, or add your own ideas.
+
+See more about the community in [COMMUNITY.md](./COMMUNITY.md) or find details on contributing in [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## 📈 Progress
+
+See the monthly OpenHands roadmap [here](https://github.com/orgs/All-Hands-AI/projects/1) (updated at the maintainer's meeting at the end of each month).
+
+
+
+## 📜 License
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+## 🙏 Acknowledgements
+
+OpenHands is built by a large number of contributors, and every contribution is greatly appreciated! We also build upon other open source projects, and we are deeply thankful for their work.
+
+For a list of open source projects and licenses used in OpenHands, please see our [CREDITS.md](./CREDITS.md) file.
+
+## 📚 Cite
+
+```
+@misc{openhands,
+ title={{OpenHands: An Open Platform for AI Software Developers as Generalist Agents}},
+ author={Xingyao Wang and Boxuan Li and Yufan Song and Frank F. Xu and Xiangru Tang and Mingchen Zhuge and Jiayi Pan and Yueqi Song and Bowen Li and Jaskirat Singh and Hoang H. Tran and Fuqiang Li and Ren Ma and Mingzhang Zheng and Bill Qian and Yanjun Shao and Niklas Muennighoff and Yizhe Zhang and Binyuan Hui and Junyang Lin and Robert Brennan and Hao Peng and Heng Ji and Graham Neubig},
+ year={2024},
+ eprint={2407.16741},
+ archivePrefix={arXiv},
+ primaryClass={cs.SE},
+ url={https://arxiv.org/abs/2407.16741},
+}
+```
diff --git a/README_CN.md b/README_CN.md
new file mode 100644
index 0000000000000000000000000000000000000000..d23e50602033da3e56d504d2b512e3f629ad7a95
--- /dev/null
+++ b/README_CN.md
@@ -0,0 +1,146 @@
+
+
+
+
+
+## 📜 许可证
+
+根据MIT许可证分发。有关更多信息，请参阅[`LICENSE`](./LICENSE)。
+
+## 🙏 致谢
+
+OpenHands由大量贡献者构建，每一份贡献都备受感谢！我们还借鉴了其他开源项目，对他们的工作深表感谢。
+
+有关OpenHands中使用的开源项目和许可证列表，请参阅我们的[CREDITS.md](./CREDITS.md)文件。
+
+## 📚 引用
+
+```
+@misc{openhands,
+ title={{OpenHands: An Open Platform for AI Software Developers as Generalist Agents}},
+ author={Xingyao Wang and Boxuan Li and Yufan Song and Frank F. Xu and Xiangru Tang and Mingchen Zhuge and Jiayi Pan and Yueqi Song and Bowen Li and Jaskirat Singh and Hoang H. Tran and Fuqiang Li and Ren Ma and Mingzhang Zheng and Bill Qian and Yanjun Shao and Niklas Muennighoff and Yizhe Zhang and Binyuan Hui and Junyang Lin and Robert Brennan and Hao Peng and Heng Ji and Graham Neubig},
+ year={2024},
+ eprint={2407.16741},
+ archivePrefix={arXiv},
+ primaryClass={cs.SE},
+ url={https://arxiv.org/abs/2407.16741},
+}
+```
diff --git a/build.sh b/build.sh
new file mode 100644
index 0000000000000000000000000000000000000000..599c63161a213cf16e90bb13552843f45ec83c6d
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+poetry build -v
diff --git a/config.template.toml b/config.template.toml
new file mode 100644
index 0000000000000000000000000000000000000000..30bf1cd5baa45322cdabbabde35f04f68ebf4316
--- /dev/null
+++ b/config.template.toml
@@ -0,0 +1,417 @@
+###################### OpenHands Configuration Example ######################
+#
+# All settings have default values, so you only need to uncomment and
+# modify what you want to change
+# The fields within each section are sorted in alphabetical order.
+#
+##############################################################################
+
+#################################### Core ####################################
+# General core configurations
+##############################################################################
+[core]
+# API key for E2B
+#e2b_api_key = ""
+
+# API key for Modal
+#modal_api_token_id = ""
+#modal_api_token_secret = ""
+
+# API key for Daytona
+#daytona_api_key = ""
+
+# Daytona Target
+#daytona_target = ""
+
+# Base path for the workspace
+#workspace_base = "./workspace"
+
+# Cache directory path
+#cache_dir = "/tmp/cache"
+
+# Reasoning effort for o1 models (low, medium, high, or not set)
+#reasoning_effort = "medium"
+
+# Debugging enabled
+#debug = false
+
+# Disable color in terminal output
+#disable_color = false
+
+# Path to store trajectories, can be a folder or a file
+# If it's a folder, the session id will be used as the file name
+#save_trajectory_path="./trajectories"
+
+# Whether to save screenshots in the trajectory
+# The screenshots are encoded and can make trajectory json files very large
+#save_screenshots_in_trajectory = false
+
+# Path to replay a trajectory, must be a file path
+# If provided, trajectory will be loaded and replayed before the
+# agent responds to any user instruction
+#replay_trajectory_path = ""
+
+# File store path
+#file_store_path = "/tmp/file_store"
+
+# File store type
+#file_store = "memory"
+
+# Maximum file size for uploads, in megabytes
+#file_uploads_max_file_size_mb = 0
+
+# Maximum budget per task, 0.0 means no limit
+#max_budget_per_task = 0.0
+
+# Maximum number of iterations
+#max_iterations = 250
+
+# Path to mount the workspace in the sandbox
+#workspace_mount_path_in_sandbox = "/workspace"
+
+# Path to mount the workspace
+#workspace_mount_path = ""
+
+# Path to rewrite the workspace mount path to
+#workspace_mount_rewrite = ""
+
+# Run as openhands
+#run_as_openhands = true
+
+# Runtime environment
+#runtime = "docker"
+
+# Name of the default agent
+#default_agent = "CodeActAgent"
+
+# JWT secret for authentication
+#jwt_secret = ""
+
+# Restrict file types for file uploads
+#file_uploads_restrict_file_types = false
+
+# List of allowed file extensions for uploads
+#file_uploads_allowed_extensions = [".*"]
+
+# Whether to enable the default LLM summarizing condenser when no condenser is specified in config
+# When true, a LLMSummarizingCondenserConfig will be used as the default condenser
+# When false, a NoOpCondenserConfig (no summarization) will be used
+#enable_default_condenser = true
+
+# Maximum number of concurrent conversations per user
+#max_concurrent_conversations = 3
+
+# Maximum age of conversations in seconds before they are automatically closed
+#conversation_max_age_seconds = 864000 # 10 days
+
+#################################### LLM #####################################
+# Configuration for LLM models (group name starts with 'llm')
+# use 'llm' for the default LLM config
+##############################################################################
+[llm]
+# AWS access key ID
+#aws_access_key_id = ""
+
+# AWS region name
+#aws_region_name = ""
+
+# AWS secret access key
+#aws_secret_access_key = ""
+
+# API key to use (For Headless / CLI only - In Web this is overridden by Session Init)
+api_key = ""
+
+# API base URL (For Headless / CLI only - In Web this is overridden by Session Init)
+#base_url = ""
+
+# API version
+#api_version = ""
+
+# Cost per input token
+#input_cost_per_token = 0.0
+
+# Cost per output token
+#output_cost_per_token = 0.0
+
+# Custom LLM provider
+#custom_llm_provider = ""
+
+# Maximum number of characters in an observation's content
+#max_message_chars = 10000
+
+# Maximum number of input tokens
+#max_input_tokens = 0
+
+# Maximum number of output tokens
+#max_output_tokens = 0
+
+# Model to use. (For Headless / CLI only - In Web this is overridden by Session Init)
+model = "gpt-4o"
+
+# Number of retries to attempt when an operation fails with the LLM.
+# Increase this value to allow more attempts before giving up
+#num_retries = 8
+
+# Maximum wait time (in seconds) between retry attempts
+# This caps the exponential backoff to prevent excessively long
+#retry_max_wait = 120
+
+# Minimum wait time (in seconds) between retry attempts
+# This sets the initial delay before the first retry
+#retry_min_wait = 15
+
+# Multiplier for exponential backoff calculation
+# The wait time increases by this factor after each failed attempt
+# A value of 2.0 means each retry waits twice as long as the previous one
+#retry_multiplier = 2.0
+
+# Drop any unmapped (unsupported) params without causing an exception
+#drop_params = false
+
+# Modify params for litellm to do transformations like adding a default message, when a message is empty.
+# Note: this setting is global, unlike drop_params, it cannot be overridden in each call to litellm.
+#modify_params = true
+
+# Using the prompt caching feature if provided by the LLM and supported
+#caching_prompt = true
+
+# Base URL for the OLLAMA API
+#ollama_base_url = ""
+
+# Temperature for the API
+#temperature = 0.0
+
+# Timeout for the API
+#timeout = 0
+
+# Top p for the API
+#top_p = 1.0
+
+# If model is vision capable, this option allows to disable image processing (useful for cost reduction).
+#disable_vision = true
+
+# Custom tokenizer to use for token counting
+# https://docs.litellm.ai/docs/completion/token_usage
+#custom_tokenizer = ""
+
+# Whether to use native tool calling if supported by the model. Can be true, false, or None by default, which chooses the model's default behavior based on the evaluation.
+# ATTENTION: Based on evaluation, enabling native function calling may lead to worse results
+# in some scenarios. Use with caution and consider testing with your specific use case.
+# https://github.com/All-Hands-AI/OpenHands/pull/4711
+#native_tool_calling = None
+
+
+
+[llm.gpt4o-mini]
+api_key = ""
+model = "gpt-4o"
+
+
+#################################### Agent ###################################
+# Configuration for agents (group name starts with 'agent')
+# Use 'agent' for the default agent config
+# otherwise, group name must be `agent.` (case-sensitive), e.g.
+# agent.CodeActAgent
+##############################################################################
+[agent]
+
+# Whether the browsing tool is enabled
+enable_browsing = true
+
+# Whether the LLM draft editor is enabled
+enable_llm_editor = false
+
+# Whether the standard editor tool (str_replace_editor) is enabled
+# Only has an effect if enable_llm_editor is False
+enable_editor = true
+
+# Whether the IPython tool is enabled
+enable_jupyter = true
+
+# Whether the command tool is enabled
+enable_cmd = true
+
+# Whether the think tool is enabled
+enable_think = true
+
+# Whether the finish tool is enabled
+enable_finish = true
+
+# LLM config group to use
+#llm_config = 'your-llm-config-group'
+
+# Whether to use prompt extension (e.g., microagent, repo/runtime info) at all
+#enable_prompt_extensions = true
+
+# List of microagents to disable
+#disabled_microagents = []
+
+# Whether history should be truncated to continue the session when hitting LLM context
+# length limit
+enable_history_truncation = true
+
+[agent.RepoExplorerAgent]
+# Example: use a cheaper model for RepoExplorerAgent to reduce cost, especially
+# useful when an agent doesn't demand high quality but uses a lot of tokens
+llm_config = 'gpt3'
+
+[agent.CustomAgent]
+# Example: use a custom agent from a different package
+# This will be automatically be registered as a new agent named "CustomAgent"
+classpath = "my_package.my_module.MyCustomAgent"
+
+#################################### Sandbox ###################################
+# Configuration for the sandbox
+##############################################################################
+[sandbox]
+# Sandbox timeout in seconds
+#timeout = 120
+
+# Sandbox user ID
+#user_id = 1000
+
+# Container image to use for the sandbox
+#base_container_image = "nikolaik/python-nodejs:python3.12-nodejs22"
+
+# Use host network
+#use_host_network = false
+
+# Runtime extra build args
+#runtime_extra_build_args = ["--network=host", "--add-host=host.docker.internal:host-gateway"]
+
+# Enable auto linting after editing
+#enable_auto_lint = false
+
+# Whether to initialize plugins
+#initialize_plugins = true
+
+# Extra dependencies to install in the runtime image
+#runtime_extra_deps = ""
+
+# Environment variables to set at the launch of the runtime
+#runtime_startup_env_vars = {}
+
+# BrowserGym environment to use for evaluation
+#browsergym_eval_env = ""
+
+# Platform to use for building the runtime image (e.g., "linux/amd64")
+#platform = ""
+
+# Force rebuild of runtime image even if it exists
+#force_rebuild_runtime = false
+
+# Runtime container image to use (if not provided, will be built from base_container_image)
+#runtime_container_image = ""
+
+# Keep runtime alive after session ends
+#keep_runtime_alive = false
+
+# Pause closed runtimes instead of stopping them
+#pause_closed_runtimes = false
+
+# Delay in seconds before closing idle runtimes
+#close_delay = 300
+
+# Remove all containers when stopping the runtime
+#rm_all_containers = false
+
+# Enable GPU support in the runtime
+#enable_gpu = false
+
+# Additional Docker runtime kwargs
+#docker_runtime_kwargs = {}
+
+# Specific port to use for VSCode. If not set, a random port will be chosen.
+# Useful when deploying OpenHands in a remote machine where you need to expose a specific port.
+#vscode_port = 41234
+
+# Volume mounts in the format 'host_path:container_path[:mode]'
+# e.g. '/my/host/dir:/workspace:rw'
+# Multiple mounts can be specified using commas
+# e.g. '/path1:/workspace/path1,/path2:/workspace/path2:ro'
+
+# Configure volumes under the [sandbox] section:
+# [sandbox]
+# volumes = "/my/host/dir:/workspace:rw,/path2:/workspace/path2:ro"
+
+#################################### Security ###################################
+# Configuration for security features
+##############################################################################
+[security]
+
+# Enable confirmation mode (For Headless / CLI only - In Web this is overridden by Session Init)
+#confirmation_mode = false
+
+# The security analyzer to use (For Headless / CLI only - In Web this is overridden by Session Init)
+#security_analyzer = ""
+
+# Whether to enable security analyzer
+#enable_security_analyzer = false
+
+#################################### Condenser #################################
+# Condensers control how conversation history is managed and compressed when
+# the context grows too large. Each agent uses one condenser configuration.
+##############################################################################
+[condenser]
+# The type of condenser to use. Available options:
+# - "noop": No condensing, keeps full history (default)
+# - "observation_masking": Keeps full event structure but masks older observations
+# - "recent": Keeps only recent events and discards older ones
+# - "llm": Uses an LLM to summarize conversation history
+# - "amortized": Intelligently forgets older events while preserving important context
+# - "llm_attention": Uses an LLM to prioritize most relevant context
+type = "noop"
+
+# Examples for each condenser type (uncomment and modify as needed):
+
+# 1. NoOp Condenser - No additional settings needed
+#type = "noop"
+
+# 2. Observation Masking Condenser
+#type = "observation_masking"
+# Number of most-recent events where observations will not be masked
+#attention_window = 100
+
+# 3. Recent Events Condenser
+#type = "recent"
+# Number of initial events to always keep (typically includes task description)
+#keep_first = 1
+# Maximum number of events to keep in history
+#max_events = 100
+
+# 4. LLM Summarizing Condenser
+#type = "llm"
+# Reference to an LLM config to use for summarization
+#llm_config = "condenser"
+# Number of initial events to always keep (typically includes task description)
+#keep_first = 1
+# Maximum size of history before triggering summarization
+#max_size = 100
+
+# 5. Amortized Forgetting Condenser
+#type = "amortized"
+# Number of initial events to always keep (typically includes task description)
+#keep_first = 1
+# Maximum size of history before triggering forgetting
+#max_size = 100
+
+# 6. LLM Attention Condenser
+#type = "llm_attention"
+# Reference to an LLM config to use for attention scoring
+#llm_config = "condenser"
+# Number of initial events to always keep (typically includes task description)
+#keep_first = 1
+# Maximum size of history before triggering attention mechanism
+#max_size = 100
+
+# Example of a custom LLM configuration for condensers that require an LLM
+# If not provided, it falls back to the default LLM
+#[llm.condenser]
+#model = "gpt-4o"
+#temperature = 0.1
+#max_input_tokens = 1024
+
+#################################### Eval ####################################
+# Configuration for the evaluation, please refer to the specific evaluation
+# plugin for the available options
+##############################################################################
diff --git a/containers/README.md b/containers/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..03a420f2edfe48922c5f461fe2e776f82b1b9471
--- /dev/null
+++ b/containers/README.md
@@ -0,0 +1,12 @@
+# Docker Containers
+
+Each folder here contains a Dockerfile, and a config.sh describing how to build
+the images and where to push them. These images are built and pushed in GitHub Actions
+by the `ghcr.yml` workflow.
+
+## Building Manually
+
+```bash
+docker build -f containers/app/Dockerfile -t openhands .
+docker build -f containers/sandbox/Dockerfile -t sandbox .
+```
diff --git a/containers/app/Dockerfile b/containers/app/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..70f80aa1e74263a1fbc84cbd2e2ad60253b5b28c
--- /dev/null
+++ b/containers/app/Dockerfile
@@ -0,0 +1,98 @@
+ARG OPENHANDS_BUILD_VERSION=dev
+FROM node:21.7.2-bookworm-slim AS frontend-builder
+
+WORKDIR /app
+
+COPY ./frontend/package.json frontend/package-lock.json ./
+RUN npm install -g npm@10.5.1
+RUN npm ci
+
+COPY ./frontend ./
+RUN npm run build
+
+FROM python:3.12.3-slim AS backend-builder
+
+WORKDIR /app
+ENV PYTHONPATH='/app'
+
+ENV POETRY_NO_INTERACTION=1 \
+ POETRY_VIRTUALENVS_IN_PROJECT=1 \
+ POETRY_VIRTUALENVS_CREATE=1 \
+ POETRY_CACHE_DIR=/tmp/poetry_cache
+
+RUN apt-get update -y \
+ && apt-get install -y curl make git build-essential \
+ && python3 -m pip install poetry==1.8.2 --break-system-packages
+
+COPY ./pyproject.toml ./poetry.lock ./
+RUN touch README.md
+RUN export POETRY_CACHE_DIR && poetry install --no-root && rm -rf $POETRY_CACHE_DIR
+
+FROM python:3.12.3-slim AS openhands-app
+
+WORKDIR /app
+
+ARG OPENHANDS_BUILD_VERSION #re-declare for this section
+
+ENV RUN_AS_OPENHANDS=true
+# A random number--we need this to be different from the user's UID on the host machine
+ENV OPENHANDS_USER_ID=42420
+ENV SANDBOX_LOCAL_RUNTIME_URL=http://host.docker.internal
+ENV USE_HOST_NETWORK=false
+ENV WORKSPACE_BASE=/opt/workspace_base
+ENV OPENHANDS_BUILD_VERSION=$OPENHANDS_BUILD_VERSION
+ENV SANDBOX_USER_ID=0
+ENV FILE_STORE=local
+ENV FILE_STORE_PATH=/.openhands-state
+RUN mkdir -p $FILE_STORE_PATH
+RUN mkdir -p $WORKSPACE_BASE
+
+RUN apt-get update -y \
+ && apt-get install -y curl ssh sudo \
+ && rm -rf /var/lib/apt/lists/*
+
+# Default is 1000, but OSX is often 501
+RUN sed -i 's/^UID_MIN.*/UID_MIN 499/' /etc/login.defs
+# Default is 60000, but we've seen up to 200000
+RUN sed -i 's/^UID_MAX.*/UID_MAX 1000000/' /etc/login.defs
+
+RUN groupadd app
+RUN useradd -l -m -u $OPENHANDS_USER_ID -s /bin/bash openhands && \
+ usermod -aG app openhands && \
+ usermod -aG sudo openhands && \
+ echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+RUN chown -R openhands:app /app && chmod -R 770 /app
+RUN sudo chown -R openhands:app $WORKSPACE_BASE && sudo chmod -R 770 $WORKSPACE_BASE
+USER openhands
+
+ENV VIRTUAL_ENV=/app/.venv \
+ PATH="/app/.venv/bin:$PATH" \
+ PYTHONPATH='/app'
+
+COPY --chown=openhands:app --chmod=770 --from=backend-builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
+
+COPY --chown=openhands:app --chmod=770 ./microagents ./microagents
+COPY --chown=openhands:app --chmod=770 ./openhands ./openhands
+COPY --chown=openhands:app --chmod=777 ./openhands/runtime/plugins ./openhands/runtime/plugins
+COPY --chown=openhands:app --chmod=770 ./openhands/agenthub ./openhands/agenthub
+COPY --chown=openhands:app ./pyproject.toml ./pyproject.toml
+COPY --chown=openhands:app ./poetry.lock ./poetry.lock
+COPY --chown=openhands:app ./README.md ./README.md
+COPY --chown=openhands:app ./MANIFEST.in ./MANIFEST.in
+COPY --chown=openhands:app ./LICENSE ./LICENSE
+
+# This is run as "openhands" user, and will create __pycache__ with openhands:openhands ownership
+RUN python openhands/core/download.py # No-op to download assets
+# Add this line to set group ownership of all files/directories not already in "app" group
+# openhands:openhands -> openhands:app
+RUN find /app \! -group app -exec chgrp app {} +
+
+COPY --chown=openhands:app --chmod=770 --from=frontend-builder /app/build ./frontend/build
+COPY --chown=openhands:app --chmod=770 ./containers/app/entrypoint.sh /app/entrypoint.sh
+
+USER root
+
+WORKDIR /app
+
+ENTRYPOINT ["/app/entrypoint.sh"]
+CMD ["uvicorn", "openhands.server.listen:app", "--host", "0.0.0.0", "--port", "3000"]
diff --git a/containers/app/config.sh b/containers/app/config.sh
new file mode 100644
index 0000000000000000000000000000000000000000..6ed9ac329e009d8dfa61a298a302d61f7f2e4550
--- /dev/null
+++ b/containers/app/config.sh
@@ -0,0 +1,4 @@
+DOCKER_REGISTRY=ghcr.io
+DOCKER_ORG=all-hands-ai
+DOCKER_IMAGE=openhands
+DOCKER_BASE_DIR="."
diff --git a/containers/app/entrypoint.sh b/containers/app/entrypoint.sh
new file mode 100644
index 0000000000000000000000000000000000000000..fe26f92fca9283cb8f8c822d2d5dfa262e858a25
--- /dev/null
+++ b/containers/app/entrypoint.sh
@@ -0,0 +1,61 @@
+#!/bin/bash
+set -eo pipefail
+
+echo "Starting OpenHands..."
+if [[ $NO_SETUP == "true" ]]; then
+ echo "Skipping setup, running as $(whoami)"
+ "$@"
+ exit 0
+fi
+
+if [ "$(id -u)" -ne 0 ]; then
+ echo "The OpenHands entrypoint.sh must run as root"
+ exit 1
+fi
+
+if [ -z "$SANDBOX_USER_ID" ]; then
+ echo "SANDBOX_USER_ID is not set"
+ exit 1
+fi
+
+if [ -z "$WORKSPACE_MOUNT_PATH" ]; then
+ # This is set to /opt/workspace in the Dockerfile. But if the user isn't mounting, we want to unset it so that OpenHands doesn't mount at all
+ unset WORKSPACE_BASE
+fi
+
+if [[ "$SANDBOX_USER_ID" -eq 0 ]]; then
+ echo "Running OpenHands as root"
+ export RUN_AS_OPENHANDS=false
+ "$@"
+else
+ echo "Setting up enduser with id $SANDBOX_USER_ID"
+ if id "enduser" &>/dev/null; then
+ echo "User enduser already exists. Skipping creation."
+ else
+ if ! useradd -l -m -u $SANDBOX_USER_ID -s /bin/bash enduser; then
+ echo "Failed to create user enduser with id $SANDBOX_USER_ID. Moving openhands user."
+ incremented_id=$(($SANDBOX_USER_ID + 1))
+ usermod -u $incremented_id openhands
+ if ! useradd -l -m -u $SANDBOX_USER_ID -s /bin/bash enduser; then
+ echo "Failed to create user enduser with id $SANDBOX_USER_ID for a second time. Exiting."
+ exit 1
+ fi
+ fi
+ fi
+ usermod -aG app enduser
+ # get the user group of /var/run/docker.sock and set openhands to that group
+ DOCKER_SOCKET_GID=$(stat -c '%g' /var/run/docker.sock)
+ echo "Docker socket group id: $DOCKER_SOCKET_GID"
+ if getent group $DOCKER_SOCKET_GID; then
+ echo "Group with id $DOCKER_SOCKET_GID already exists"
+ else
+ echo "Creating group with id $DOCKER_SOCKET_GID"
+ groupadd -g $DOCKER_SOCKET_GID docker
+ fi
+
+ mkdir -p /home/enduser/.cache/huggingface/hub/
+
+ usermod -aG $DOCKER_SOCKET_GID enduser
+ echo "Running as enduser"
+ su enduser /bin/bash -c "${*@Q}" # This magically runs any arguments passed to the script as a command
+fi
diff --git a/containers/build.sh b/containers/build.sh
new file mode 100644
index 0000000000000000000000000000000000000000..72a1d2c117def176f23d59c9d467daa1c2da890f
--- /dev/null
+++ b/containers/build.sh
@@ -0,0 +1,182 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+# Initialize variables with default values
+image_name=""
+org_name=""
+push=0
+load=0
+tag_suffix=""
+dry_run=0
+
+# Function to display usage information
+usage() {
+ echo "Usage: $0 -i [-o ] [--push] [--load] [-t ] [--dry]"
+ echo " -i: Image name (required)"
+ echo " -o: Organization name"
+ echo " --push: Push the image"
+ echo " --load: Load the image"
+ echo " -t: Tag suffix"
+ echo " --dry: Don't build, only create build-args.json"
+ exit 1
+}
+
+# Parse command-line options
+while [[ $# -gt 0 ]]; do
+ case $1 in
+ -i) image_name="$2"; shift 2 ;;
+ -o) org_name="$2"; shift 2 ;;
+ --push) push=1; shift ;;
+ --load) load=1; shift ;;
+ -t) tag_suffix="$2"; shift 2 ;;
+ --dry) dry_run=1; shift ;;
+ *) usage ;;
+ esac
+done
+# Check if required arguments are provided
+if [[ -z "$image_name" ]]; then
+ echo "Error: Image name is required."
+ usage
+fi
+
+echo "Building: $image_name"
+tags=()
+
+OPENHANDS_BUILD_VERSION="dev"
+
+cache_tag_base="buildcache"
+cache_tag="$cache_tag_base"
+
+if [[ -n $RELEVANT_SHA ]]; then
+ git_hash=$(git rev-parse --short "$RELEVANT_SHA")
+ tags+=("$git_hash")
+ tags+=("$RELEVANT_SHA")
+fi
+
+if [[ -n $GITHUB_REF_NAME ]]; then
+ # check if ref name is a version number
+ if [[ $GITHUB_REF_NAME =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+ major_version=$(echo "$GITHUB_REF_NAME" | cut -d. -f1)
+ minor_version=$(echo "$GITHUB_REF_NAME" | cut -d. -f1,2)
+ tags+=("$major_version" "$minor_version")
+ tags+=("latest")
+ fi
+ sanitized_ref_name=$(echo "$GITHUB_REF_NAME" | sed 's/[^a-zA-Z0-9.-]\+/-/g')
+ OPENHANDS_BUILD_VERSION=$sanitized_ref_name
+ sanitized_ref_name=$(echo "$sanitized_ref_name" | tr '[:upper:]' '[:lower:]') # lower case is required in tagging
+ tags+=("$sanitized_ref_name")
+ cache_tag+="-${sanitized_ref_name}"
+fi
+
+if [[ -n $tag_suffix ]]; then
+ cache_tag+="-${tag_suffix}"
+ for i in "${!tags[@]}"; do
+ tags[$i]="${tags[$i]}-$tag_suffix"
+ done
+fi
+
+echo "Tags: ${tags[@]}"
+
+if [[ "$image_name" == "openhands" ]]; then
+ dir="./containers/app"
+elif [[ "$image_name" == "runtime" ]]; then
+ dir="./containers/runtime"
+else
+ dir="./containers/$image_name"
+fi
+
+if [[ (! -f "$dir/Dockerfile") && "$image_name" != "runtime" ]]; then
+ # Allow runtime to be built without a Dockerfile
+ echo "No Dockerfile found"
+ exit 1
+fi
+if [[ ! -f "$dir/config.sh" ]]; then
+ echo "No config.sh found for Dockerfile"
+ exit 1
+fi
+
+source "$dir/config.sh"
+
+if [[ -n "$org_name" ]]; then
+ DOCKER_ORG="$org_name"
+fi
+
+# If $DOCKER_IMAGE_SOURCE_TAG is set, add it to the tags
+if [[ -n "$DOCKER_IMAGE_SOURCE_TAG" ]]; then
+ tags+=("$DOCKER_IMAGE_SOURCE_TAG")
+fi
+# If $DOCKER_IMAGE_TAG is set, add it to the tags
+if [[ -n "$DOCKER_IMAGE_TAG" ]]; then
+ tags+=("$DOCKER_IMAGE_TAG")
+fi
+
+DOCKER_REPOSITORY="$DOCKER_REGISTRY/$DOCKER_ORG/$DOCKER_IMAGE"
+DOCKER_REPOSITORY=${DOCKER_REPOSITORY,,} # lowercase
+echo "Repo: $DOCKER_REPOSITORY"
+echo "Base dir: $DOCKER_BASE_DIR"
+
+args=""
+full_tags=()
+for tag in "${tags[@]}"; do
+ args+=" -t $DOCKER_REPOSITORY:$tag"
+ full_tags+=("$DOCKER_REPOSITORY:$tag")
+done
+
+
+if [[ $push -eq 1 ]]; then
+ args+=" --push"
+ args+=" --cache-to=type=registry,ref=$DOCKER_REPOSITORY:$cache_tag,mode=max"
+fi
+
+if [[ $load -eq 1 ]]; then
+ args+=" --load"
+fi
+
+echo "Args: $args"
+
+# Modify the platform selection based on --load flag
+if [[ $load -eq 1 ]]; then
+ # When loading, build only for the current platform
+ platform=$(docker version -f '{{.Server.Os}}/{{.Server.Arch}}')
+else
+ # For push or without load, build for multiple platforms
+ platform="linux/amd64,linux/arm64"
+fi
+if [[ $dry_run -eq 1 ]]; then
+ echo "Dry Run is enabled. Writing build config to docker-build-dry.json"
+ jq -n \
+ --argjson tags "$(printf '%s\n' "${full_tags[@]}" | jq -R . | jq -s .)" \
+ --arg platform "$platform" \
+ --arg openhands_build_version "$OPENHANDS_BUILD_VERSION" \
+ --arg dockerfile "$dir/Dockerfile" \
+ '{
+ tags: $tags,
+ platform: $platform,
+ build_args: [
+ "OPENHANDS_BUILD_VERSION=" + $openhands_build_version
+ ],
+ dockerfile: $dockerfile
+ }' > docker-build-dry.json
+
+ exit 0
+fi
+
+
+
+echo "Building for platform(s): $platform"
+
+docker buildx build \
+ $args \
+ --build-arg OPENHANDS_BUILD_VERSION="$OPENHANDS_BUILD_VERSION" \
+ --cache-from=type=registry,ref=$DOCKER_REPOSITORY:$cache_tag \
+ --cache-from=type=registry,ref=$DOCKER_REPOSITORY:$cache_tag_base-main \
+ --platform $platform \
+ --provenance=false \
+ -f "$dir/Dockerfile" \
+ "$DOCKER_BASE_DIR"
+
+# If load was requested, print the loaded images
+if [[ $load -eq 1 ]]; then
+ echo "Local images built:"
+ docker images "$DOCKER_REPOSITORY" --format "{{.Repository}}:{{.Tag}}"
+fi
diff --git a/containers/dev/Dockerfile b/containers/dev/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..29118ff8cf8e9b6d9cf9199bd2f8ead2b30e6638
--- /dev/null
+++ b/containers/dev/Dockerfile
@@ -0,0 +1,124 @@
+# syntax=docker/dockerfile:1
+
+###
+FROM ubuntu:22.04 AS dind
+
+# https://docs.docker.com/engine/install/ubuntu/
+RUN apt-get update && apt-get install -y \
+ ca-certificates \
+ curl \
+ && install -m 0755 -d /etc/apt/keyrings \
+ && curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc \
+ && chmod a+r /etc/apt/keyrings/docker.asc \
+ && echo \
+ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
+
+RUN apt-get update && apt-get install -y \
+ docker-ce \
+ docker-ce-cli \
+ containerd.io \
+ docker-buildx-plugin \
+ docker-compose-plugin \
+ && rm -rf /var/lib/apt/lists/* \
+ && apt-get clean \
+ && apt-get autoremove -y
+
+###
+FROM dind AS openhands
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+#
+RUN apt-get update && apt-get install -y \
+ bash \
+ build-essential \
+ curl \
+ git \
+ git-lfs \
+ software-properties-common \
+ make \
+ netcat \
+ sudo \
+ wget \
+ && rm -rf /var/lib/apt/lists/* \
+ && apt-get clean \
+ && apt-get autoremove -y
+
+# https://github.com/cli/cli/blob/trunk/docs/install_linux.md
+RUN curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
+ && chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
+ && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
+ && apt-get update && apt-get -y install \
+ gh \
+ && rm -rf /var/lib/apt/lists/* \
+ && apt-get clean \
+ && apt-get autoremove -y
+
+# Python 3.12
+RUN add-apt-repository ppa:deadsnakes/ppa \
+ && apt-get update \
+ && apt-get install -y python3.12 python3.12-venv python3.12-dev python3-pip \
+ && ln -s /usr/bin/python3.12 /usr/bin/python
+
+# NodeJS >= 22.x
+RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - \
+ && apt-get install -y nodejs
+
+# Poetry >= 1.8
+RUN curl -fsSL https://install.python-poetry.org | python3.12 - \
+ && ln -s ~/.local/bin/poetry /usr/local/bin/poetry
+
+#
+RUN <&1 | head -n 1
+" > /version.sh
+chmod a+x /version.sh
+EOF
+
+###
+FROM openhands AS dev
+
+RUN apt-get update && apt-get install -y \
+ dnsutils \
+ file \
+ iproute2 \
+ jq \
+ lsof \
+ ripgrep \
+ silversearcher-ag \
+ vim \
+ && rm -rf /var/lib/apt/lists/* \
+ && apt-get clean \
+ && apt-get autoremove -y
+
+WORKDIR /app
+
+# cache build dependencies
+RUN \
+ --mount=type=bind,source=./,target=/app/,rw \
+ < [!WARNING]
+> This is not officially supported and may not work.
+
+Install [Docker](https://docs.docker.com/engine/install/) on your host machine and run:
+
+```bash
+make docker-dev
+# same as:
+cd ./containers/dev
+./dev.sh
+```
+
+It could take some time if you are running for the first time as Docker will pull all the tools required for building OpenHands. The next time you run again, it should be instant.
+
+## Build and run
+
+If everything goes well, you should be inside a container after Docker finishes building the `openhands:dev` image similar to the following:
+
+```bash
+Build and run in Docker ...
+root@93fc0005fcd2:/app#
+```
+
+You may now proceed with the normal [build and run](../../Development.md) workflow as if you were on the host.
+
+## Make changes
+
+The source code on the host is mounted as `/app` inside docker. You may edit the files as usual either inside the Docker container or on your host with your favorite IDE/editors.
+
+The following are also mapped as readonly from your host:
+
+```yaml
+# host credentials
+- $HOME/.git-credentials:/root/.git-credentials:ro
+- $HOME/.gitconfig:/root/.gitconfig:ro
+- $HOME/.npmrc:/root/.npmrc:ro
+```
+
+## VSCode
+
+Alternatively, if you use VSCode, you could also [attach to the running container](https://code.visualstudio.com/docs/devcontainers/attach-container).
+
+See details for [developing in docker](https://code.visualstudio.com/docs/devcontainers/containers) or simply ask `OpenHands` ;-)
+
+## Rebuild dev image
+
+You could optionally pass additional options to the build script.
+
+```bash
+make docker-dev OPTIONS="--build"
+# or
+./containers/dev/dev.sh --build
+```
+
+See [docker compose run](https://docs.docker.com/reference/cli/docker/compose/run/) for more options.
diff --git a/containers/dev/compose.yml b/containers/dev/compose.yml
new file mode 100644
index 0000000000000000000000000000000000000000..a60bf0c91f7a630fb62e15d24cf0bfed16511d73
--- /dev/null
+++ b/containers/dev/compose.yml
@@ -0,0 +1,38 @@
+#
+services:
+ dev:
+ privileged: true
+ build:
+ context: ${OPENHANDS_WORKSPACE:-../../}
+ dockerfile: ./containers/dev/Dockerfile
+ image: openhands:dev
+ container_name: openhands-dev
+ environment:
+ - BACKEND_HOST=${BACKEND_HOST:-"0.0.0.0"}
+ - SANDBOX_API_HOSTNAME=host.docker.internal
+ #
+ - SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-ghcr.io/all-hands-ai/runtime:0.41-nikolaik}
+ - SANDBOX_USER_ID=${SANDBOX_USER_ID:-1234}
+ - WORKSPACE_MOUNT_PATH=${WORKSPACE_BASE:-$PWD/workspace}
+ ports:
+ - "3000:3000"
+ extra_hosts:
+ - "host.docker.internal:host-gateway"
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock
+ - ${WORKSPACE_BASE:-$PWD/workspace}:/opt/workspace_base
+ # source code
+ - ${OPENHANDS_WORKSPACE:-../../}:/app
+ # host credentials
+ - $HOME/.git-credentials:/root/.git-credentials:ro
+ - $HOME/.gitconfig:/root/.gitconfig:ro
+ - $HOME/.npmrc:/root/.npmrc:ro
+ # cache
+ - cache-data:/root/.cache
+ pull_policy: never
+ stdin_open: true
+ tty: true
+
+##
+volumes:
+ cache-data:
diff --git a/containers/dev/dev.sh b/containers/dev/dev.sh
new file mode 100644
index 0000000000000000000000000000000000000000..ee481f25264b015414e116e810d8ed509ef489bc
--- /dev/null
+++ b/containers/dev/dev.sh
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+set -o pipefail
+
+function get_docker() {
+ echo "Docker is required to build and run OpenHands."
+ echo "https://docs.docker.com/get-started/get-docker/"
+ exit 1
+}
+
+function check_tools() {
+ command -v docker &>/dev/null || get_docker
+}
+
+function exit_if_indocker() {
+ if [ -f /.dockerenv ]; then
+ echo "Running inside a Docker container. Exiting..."
+ exit 1
+ fi
+}
+
+#
+exit_if_indocker
+
+check_tools
+
+##
+OPENHANDS_WORKSPACE=$(git rev-parse --show-toplevel)
+
+cd "$OPENHANDS_WORKSPACE/containers/dev/" || exit 1
+
+##
+export BACKEND_HOST="0.0.0.0"
+#
+export SANDBOX_USER_ID=$(id -u)
+export WORKSPACE_BASE=${WORKSPACE_BASE:-$OPENHANDS_WORKSPACE/workspace}
+
+docker compose run --rm --service-ports "$@" dev
+
+##
diff --git a/containers/e2b-sandbox/Dockerfile b/containers/e2b-sandbox/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..f1283bd2aded5918601c5a4c17c7d1763441efaf
--- /dev/null
+++ b/containers/e2b-sandbox/Dockerfile
@@ -0,0 +1,19 @@
+FROM ubuntu:22.04
+
+# install basic packages
+RUN apt-get update && apt-get install -y \
+ curl \
+ wget \
+ git \
+ vim \
+ nano \
+ unzip \
+ zip \
+ python3 \
+ python3-pip \
+ python3-venv \
+ python3-dev \
+ build-essential \
+ openssh-server \
+ sudo \
+ && rm -rf /var/lib/apt/lists/*
diff --git a/containers/e2b-sandbox/README.md b/containers/e2b-sandbox/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..9f9ff728885f6a3cbb6c6759289d207496ff07d2
--- /dev/null
+++ b/containers/e2b-sandbox/README.md
@@ -0,0 +1,15 @@
+# How to build custom E2B sandbox for OpenHands
+
+[E2B](https://e2b.dev) is an [open-source](https://github.com/e2b-dev/e2b) secure cloud environment (sandbox) made for running AI-generated code and agents. E2B offers [Python](https://pypi.org/project/e2b/) and [JS/TS](https://www.npmjs.com/package/e2b) SDK to spawn and control these sandboxes.
+
+
+1. Install the CLI with NPM.
+ ```sh
+ npm install -g @e2b/cli@latest
+ ```
+ Full CLI API is [here](https://e2b.dev/docs/cli/installation).
+
+1. Build the sandbox
+ ```sh
+ e2b template build --dockerfile ./Dockerfile --name "openhands"
+ ```
diff --git a/containers/e2b-sandbox/e2b.toml b/containers/e2b-sandbox/e2b.toml
new file mode 100644
index 0000000000000000000000000000000000000000..f19eb933a07dce1116a8c92085fc5eedef6c843b
--- /dev/null
+++ b/containers/e2b-sandbox/e2b.toml
@@ -0,0 +1,14 @@
+# This is a config for E2B sandbox template.
+# You can use 'template_id' (785n69crgahmz0lkdw9h) or 'template_name (openhands) from this config to spawn a sandbox:
+
+# Python SDK
+# from e2b import Sandbox
+# sandbox = Sandbox(template='openhands')
+
+# JS SDK
+# import { Sandbox } from 'e2b'
+# const sandbox = await Sandbox.create({ template: 'openhands' })
+
+dockerfile = "Dockerfile"
+template_name = "openhands"
+template_id = "785n69crgahmz0lkdw9h"
diff --git a/containers/runtime/README.md b/containers/runtime/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..9fbed76aa3716f17b199bc65628f01755e087fa5
--- /dev/null
+++ b/containers/runtime/README.md
@@ -0,0 +1,12 @@
+# Dynamically constructed Dockerfile
+
+This folder builds a runtime image (sandbox), which will use a dynamically generated `Dockerfile`
+that depends on the `base_image` **AND** a [Python source distribution](https://docs.python.org/3.10/distutils/sourcedist.html) that is based on the current commit of `openhands`.
+
+The following command will generate a `Dockerfile` file for `nikolaik/python-nodejs:python3.12-nodejs22` (the default base image), an updated `config.sh` and the runtime source distribution files/folders into `containers/runtime`:
+
+```bash
+poetry run python3 openhands/runtime/utils/runtime_build.py \
+ --base_image nikolaik/python-nodejs:python3.12-nodejs22 \
+ --build_folder containers/runtime
+```
diff --git a/containers/runtime/config.sh b/containers/runtime/config.sh
new file mode 100644
index 0000000000000000000000000000000000000000..99d2eb66ccc6501b673c904e793544bbf13e2745
--- /dev/null
+++ b/containers/runtime/config.sh
@@ -0,0 +1,7 @@
+DOCKER_REGISTRY=ghcr.io
+DOCKER_ORG=all-hands-ai
+DOCKER_BASE_DIR="./containers/runtime"
+DOCKER_IMAGE=runtime
+# These variables will be appended by the runtime_build.py script
+# DOCKER_IMAGE_TAG=
+# DOCKER_IMAGE_SOURCE_TAG=
diff --git a/dev_config/python/mypy.ini b/dev_config/python/mypy.ini
new file mode 100644
index 0000000000000000000000000000000000000000..84b97d720b2ff054d374123b2ebaadf5c8306133
--- /dev/null
+++ b/dev_config/python/mypy.ini
@@ -0,0 +1,9 @@
+[mypy]
+warn_unused_configs = True
+ignore_missing_imports = True
+check_untyped_defs = True
+explicit_package_bases = True
+warn_unreachable = True
+warn_redundant_casts = True
+no_implicit_optional = True
+strict_optional = True
diff --git a/dev_config/python/ruff.toml b/dev_config/python/ruff.toml
new file mode 100644
index 0000000000000000000000000000000000000000..e15500e061dafa4756a54184d74bf8eb586ae148
--- /dev/null
+++ b/dev_config/python/ruff.toml
@@ -0,0 +1,39 @@
+[lint]
+select = [
+ "E",
+ "W",
+ "F",
+ "I",
+ "Q",
+ "B",
+ "ASYNC",
+ "UP006", # Use `list` instead of `List` for annotations
+ "UP007", # Use `X | Y` instead of `Union[X, Y]`
+ "UP008", # Use `X | None` instead of `Optional[X]`
+]
+
+ignore = [
+ "E501",
+ "B003",
+ "B007",
+ "B009",
+ "B010",
+ "B904",
+ "B018",
+ # Temporarily ignore ASYNC rules until they can be properly fixed in a separate PR
+ "ASYNC110",
+ "ASYNC220",
+ "ASYNC221",
+ "ASYNC230",
+ "ASYNC251",
+]
+
+[lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "single"
+
+[format]
+quote-style = "single"
+
+[lint.flake8-bugbear]
+extend-immutable-calls = ["Depends", "fastapi.Depends", "fastapi.params.Depends"]
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000000000000000000000000000000000000..e8f35857350e23a3786a7ab651731a498b396625
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,23 @@
+
+services:
+ openhands:
+ build:
+ context: ./
+ dockerfile: ./containers/app/Dockerfile
+ image: openhands:latest
+ container_name: openhands-app-${DATE:-}
+ environment:
+ - SANDBOX_RUNTIME_CONTAINER_IMAGE=${SANDBOX_RUNTIME_CONTAINER_IMAGE:-docker.all-hands.dev/all-hands-ai/runtime:0.41-nikolaik}
+ #- SANDBOX_USER_ID=${SANDBOX_USER_ID:-1234} # enable this only if you want a specific non-root sandbox user but you will have to manually adjust permissions of openhands-state for this user
+ - WORKSPACE_MOUNT_PATH=${WORKSPACE_BASE:-$PWD/workspace}
+ ports:
+ - "3000:3000"
+ extra_hosts:
+ - "host.docker.internal:host-gateway"
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock
+ - ~/.openhands-state:/.openhands-state
+ - ${WORKSPACE_BASE:-$PWD/workspace}:/opt/workspace_base
+ pull_policy: build
+ stdin_open: true
+ tty: true
diff --git a/docs/DOC_STYLE_GUIDE.md b/docs/DOC_STYLE_GUIDE.md
new file mode 100644
index 0000000000000000000000000000000000000000..213e857078ce2a3919ad0e575cc4f6f5766b8b41
--- /dev/null
+++ b/docs/DOC_STYLE_GUIDE.md
@@ -0,0 +1,67 @@
+# Documentation Style Guide
+
+## General Writing Principles
+
+- **Clarity & Conciseness**: Always prioritize clarity and brevity. Avoid unnecessary jargon or overly complex explanations.
+Keep sentences short and to the point.
+- **Gradual Complexity**: Start with the simplest, most basic setup, and then gradually introduce more advanced
+concepts and configurations.
+
+## Formatting Guidelines
+
+### Headers
+
+Use **Title Case** for the first and second level headers.
+
+Example:
+ - **Basic Usage**
+ - **Advanced Configuration Options**
+
+### Lists
+
+When listing items or options, use bullet points to enhance readability.
+
+Example:
+ - Option A
+ - Option B
+ - Option C
+
+### Procedures
+
+For instructions or processes that need to be followed in a specific order, use numbered steps.
+
+Example:
+ 1. Step one: Do this.
+ - First this sub step.
+ - Then this sub step.
+ 2. Step two: Complete this action.
+ 3. Step three: Verify the result.
+
+### Code Blocks
+
+* Use code blocks for multi-line inputs, outputs, commands and code samples.
+
+Example:
+```bash
+docker run -it \
+ -e THIS=this \
+ -e THAT=that
+ ...
+```
+
+### Use of Note and Warning
+
+When adding a note or warning, use the built-in note and warning syntax.
+
+Example:
+
+This section is for advanced users only.
+
+
+### Referring to UI Elements
+
+When referencing UI elements, use ``.
+
+Example:
+1. Toggle the `Advanced` option
+2. Enter your model in the `Custom Model` textbox.
diff --git a/docs/docs.json b/docs/docs.json
new file mode 100644
index 0000000000000000000000000000000000000000..c91d7064ed5a2442a85b766877e7fe67a11fb6d9
--- /dev/null
+++ b/docs/docs.json
@@ -0,0 +1,204 @@
+{
+ "$schema": "https://mintlify.com/docs.json",
+ "theme": "mint",
+ "name": "All Hands Docs",
+ "colors": {
+ "primary": "#99873c",
+ "light": "#ffe165",
+ "dark": "#ffe165"
+ },
+ "background": {
+ "color": {
+ "light": "#f7f3ee",
+ "dark": "#0B0D0E"
+ }
+ },
+ "appearance": {
+ "default": "light"
+ },
+ "favicon": "/logo-square.png",
+ "navigation": {
+ "tabs": [
+ {
+ "tab": "Docs",
+ "pages": [
+ "index",
+ "usage/installation",
+ "usage/getting-started",
+ "usage/key-features",
+ {
+ "group": "OpenHands Cloud",
+ "pages": [
+ "usage/cloud/openhands-cloud",
+ {
+ "group": "Integrations",
+ "pages": [
+ "usage/cloud/github-installation",
+ "usage/cloud/gitlab-installation"
+ ]
+ },
+ "usage/cloud/cloud-ui",
+ "usage/cloud/cloud-api"
+ ]
+ },
+ {
+ "group": "Running OpenHands Locally",
+ "pages": [
+ "usage/local-setup",
+ "usage/how-to/gui-mode",
+ "usage/how-to/cli-mode",
+ "usage/how-to/headless-mode",
+ "usage/how-to/github-action"
+ ]
+ },
+ {
+ "group": "Customization",
+ "pages": [
+ "usage/prompting/prompting-best-practices",
+ "usage/prompting/repository",
+ {
+ "group": "Microagents",
+ "pages": [
+ "usage/prompting/microagents-overview",
+ "usage/prompting/microagents-repo",
+ "usage/prompting/microagents-keyword",
+ "usage/prompting/microagents-org",
+ "usage/prompting/microagents-public"
+ ]
+ }
+ ]
+ },
+ {
+ "group": "Advanced Configuration",
+ "pages": [
+ {
+ "group": "LLM Configuration",
+ "pages": [
+ "usage/llms/llms",
+ {
+ "group": "Providers",
+ "pages": [
+ "usage/llms/azure-llms",
+ "usage/llms/google-llms",
+ "usage/llms/groq",
+ "usage/llms/local-llms",
+ "usage/llms/litellm-proxy",
+ "usage/llms/openai-llms",
+ "usage/llms/openrouter"
+ ]
+ }
+ ]
+ },
+ {
+ "group": "Runtime Configuration",
+ "pages": [
+ "usage/runtimes/overview",
+ {
+ "group": "Providers",
+ "pages": [
+ "usage/runtimes/docker",
+ "usage/runtimes/remote",
+ "usage/runtimes/local",
+ {
+ "group": "Third-Party Providers",
+ "pages": [
+ "usage/runtimes/modal",
+ "usage/runtimes/daytona",
+ "usage/runtimes/runloop",
+ "usage/runtimes/e2b"
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "usage/configuration-options",
+ "usage/how-to/custom-sandbox-guide",
+ "usage/search-engine-setup",
+ "usage/mcp"
+ ]
+ },
+ {
+ "group": "Troubleshooting & Feedback",
+ "pages": [
+ "usage/troubleshooting/troubleshooting",
+ "usage/feedback"
+ ]
+ },
+ {
+ "group": "OpenHands Developers",
+ "pages": [
+ "usage/how-to/development-overview",
+ {
+ "group": "Architecture",
+ "pages": [
+ "usage/architecture/backend",
+ "usage/architecture/runtime"
+ ]
+ },
+ "usage/how-to/debugging",
+ "usage/how-to/evaluation-harness",
+ "usage/how-to/websocket-connection"
+ ]
+ }
+ ]
+ },
+ {
+ "tab": "API Reference",
+ "openapi": "/openapi.json"
+ }
+ ],
+ "global": {
+ "anchors": [
+ {
+ "anchor": "Company",
+ "href": "https://www.all-hands.dev/",
+ "icon": "house"
+ },
+ {
+ "anchor": "Blog",
+ "href": "https://www.all-hands.dev/blog",
+ "icon": "newspaper"
+ },
+ {
+ "anchor": "OpenHands Cloud",
+ "href": "https://app.all-hands.dev",
+ "icon": "cloud"
+ }
+ ]
+ }
+ },
+ "logo": {
+ "light": "/logo/light.svg",
+ "dark": "/logo/dark.svg"
+ },
+ "navbar": {
+ "links": [
+ ],
+ "primary": {
+ "type": "github",
+ "href": "https://github.com/All-Hands-AI/OpenHands"
+ }
+ },
+ "footer": {
+ "socials": {
+ "slack": "https://join.slack.com/t/openhands-ai/shared_invite/zt-34zm4j0gj-Qz5kRHoca8DFCbqXPS~f_A",
+ "github": "https://github.com/All-Hands-AI/OpenHands",
+ "discord": "https://discord.gg/ESHStjSjD4"
+ }
+ },
+ "contextual": {
+ "options": [
+ "copy",
+ "view",
+ "chatgpt",
+ "claude"
+ ]
+ },
+ "redirects": [
+ {
+ "source": "/modules/:slug*",
+ "destination": "/:slug*"
+ }
+ ]
+}
diff --git a/docs/favicon.svg b/docs/favicon.svg
new file mode 100644
index 0000000000000000000000000000000000000000..b785c738bf178e7072e15ad6770e13ad1032d54b
--- /dev/null
+++ b/docs/favicon.svg
@@ -0,0 +1,19 @@
+
diff --git a/docs/index.mdx b/docs/index.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..4fb2874a0f5bf9abf4daabca40cd13cd6258e784
--- /dev/null
+++ b/docs/index.mdx
@@ -0,0 +1,16 @@
+---
+title: Introduction
+description: OpenHands - Code Less, Make More
+icon: book-open
+mode: wide
+---
+Use AI to tackle the toil in your backlog. Our agents have all the same tools as a human developer: they can modify code, run commands, browse the web, call APIs, and yes-even copy code snippets from StackOverflow.
+
+
diff --git a/docs/logo-square.png b/docs/logo-square.png
new file mode 100644
index 0000000000000000000000000000000000000000..624dad2fb22d4d2ac723d8e9f81ab56e0886c36d
--- /dev/null
+++ b/docs/logo-square.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:de58ad6132a9afb7d4924612c5e013695658af993a81a7611a6564f6a8063d59
+size 1189506
diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg
new file mode 100644
index 0000000000000000000000000000000000000000..5632a89e4a7d2d7ce61c5c0e8fbf2859e26cc750
--- /dev/null
+++ b/docs/logo/dark.svg
@@ -0,0 +1,29 @@
+
diff --git a/docs/logo/light.svg b/docs/logo/light.svg
new file mode 100644
index 0000000000000000000000000000000000000000..80f4eccf394a0d90d9a1a16bd5ee44bfede63e14
--- /dev/null
+++ b/docs/logo/light.svg
@@ -0,0 +1,29 @@
+
diff --git a/docs/openapi.json b/docs/openapi.json
new file mode 100644
index 0000000000000000000000000000000000000000..954c28957810b9a7f30c0b34bd6caadbe00d2445
--- /dev/null
+++ b/docs/openapi.json
@@ -0,0 +1,2091 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "OpenHands API",
+ "description": "OpenHands: Code Less, Make More",
+ "version": "1.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://app.all-hands.dev",
+ "description": "Production server"
+ },
+ {
+ "url": "http://localhost:3000",
+ "description": "Local development server"
+ }
+ ],
+ "paths": {
+ "/health": {
+ "get": {
+ "summary": "Health check",
+ "description": "Check if the API is running",
+ "operationId": "health",
+ "responses": {
+ "200": {
+ "description": "API is running",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string",
+ "example": "OK"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/config": {
+ "get": {
+ "summary": "Get runtime configuration",
+ "description": "Retrieve the runtime configuration (session ID and runtime ID)",
+ "operationId": "getRemoteRuntimeConfig",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Runtime configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "runtime_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "session_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/vscode-url": {
+ "get": {
+ "summary": "Get VSCode URL",
+ "description": "Get the VSCode URL for the conversation",
+ "operationId": "getVscodeUrl",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "VSCode URL",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "vscode_url": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error getting VSCode URL",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "vscode_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/web-hosts": {
+ "get": {
+ "summary": "Get runtime hosts",
+ "description": "Get the hosts used by the runtime",
+ "operationId": "getHosts",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Runtime hosts",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "hosts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error getting runtime hosts",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "hosts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/submit-feedback": {
+ "post": {
+ "summary": "Submit feedback",
+ "description": "Submit user feedback for a conversation",
+ "operationId": "submitFeedback",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ },
+ "version": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "string",
+ "default": "private"
+ },
+ "polarity": {
+ "type": "string"
+ },
+ "feedback": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Feedback submitted successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error submitting feedback",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/list-files": {
+ "get": {
+ "summary": "List files",
+ "description": "List files in the specified path",
+ "operationId": "listFiles",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Path to list files from"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of files",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Runtime not initialized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error listing files",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/select-file": {
+ "get": {
+ "summary": "Get file content",
+ "description": "Retrieve the content of a specified file",
+ "operationId": "selectFile",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "file",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Path of the file to be retrieved"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "File content",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Unable to open binary file",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error opening file",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/zip-directory": {
+ "get": {
+ "summary": "Download workspace as zip",
+ "description": "Download the current workspace as a zip file",
+ "operationId": "zipCurrentWorkspace",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Workspace zip file",
+ "content": {
+ "application/zip": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error zipping workspace",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/git/changes": {
+ "get": {
+ "summary": "Get git changes",
+ "description": "Get git changes in the workspace",
+ "operationId": "gitChanges",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Git changes",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error getting git changes",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/git/diff": {
+ "get": {
+ "summary": "Get git diff",
+ "description": "Get git diff for a specific file",
+ "operationId": "gitDiff",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Path of the file to get diff for"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Git diff",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error getting git diff",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/trajectory": {
+ "get": {
+ "summary": "Get trajectory",
+ "description": "Get the conversation trajectory",
+ "operationId": "getTrajectory",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Conversation trajectory",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "trajectory": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error getting trajectory",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "trajectory": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ },
+ "nullable": true
+ },
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}/security/{path}": {
+ "get": {
+ "summary": "Security analyzer API (GET)",
+ "description": "Catch-all route for security analyzer API GET requests",
+ "operationId": "securityApiGet",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Security analyzer API path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Security analyzer response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Security analyzer not initialized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detail": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "summary": "Security analyzer API (POST)",
+ "description": "Catch-all route for security analyzer API POST requests",
+ "operationId": "securityApiPost",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Security analyzer API path"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Security analyzer response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Security analyzer not initialized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detail": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "summary": "Security analyzer API (PUT)",
+ "description": "Catch-all route for security analyzer API PUT requests",
+ "operationId": "securityApiPut",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Security analyzer API path"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Security analyzer response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Security analyzer not initialized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detail": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Security analyzer API (DELETE)",
+ "description": "Catch-all route for security analyzer API DELETE requests",
+ "operationId": "securityApiDelete",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Security analyzer API path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Security analyzer response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Security analyzer not initialized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detail": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations": {
+ "post": {
+ "summary": "Create new conversation",
+ "description": "Initialize a new conversation",
+ "operationId": "newConversation",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repository": {
+ "type": "string",
+ "nullable": true,
+ "description": "Full name of the repository (e.g., owner/repo)"
+ },
+ "git_provider": {
+ "type": "string",
+ "nullable": true,
+ "description": "The Git provider (e.g., github or gitlab). If omitted, all configured providers are checked for the repository."
+ },
+ "selected_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "initial_user_msg": {
+ "type": "string",
+ "nullable": true
+ },
+ "conversation_instructions": {
+ "type": "string",
+ "nullable": true,
+ "description": "Optional instructions the agent must follow throughout the conversation while addressing the user's initial task"
+ },
+ "image_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "replay_json": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Conversation created successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "example": "ok"
+ },
+ "conversation_id": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Error creating conversation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "example": "error"
+ },
+ "message": {
+ "type": "string"
+ },
+ "msg_id": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "summary": "Search conversations",
+ "description": "Search for conversations",
+ "operationId": "searchConversations",
+ "parameters": [
+ {
+ "name": "page_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Page ID for pagination"
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 20
+ },
+ "description": "Number of conversations to return"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Conversations",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "conversation_id": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "last_updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "selected_repository": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": ["RUNNING", "STOPPED"]
+ },
+ "trigger": {
+ "type": "string",
+ "enum": ["GUI", "API"]
+ }
+ }
+ }
+ },
+ "next_page_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/conversations/{conversation_id}": {
+ "get": {
+ "summary": "Get conversation",
+ "description": "Get conversation details",
+ "operationId": "getConversation",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Conversation details",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "conversation_id": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "last_updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "selected_repository": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": ["RUNNING", "STOPPED"]
+ },
+ "trigger": {
+ "type": "string",
+ "enum": ["GUI", "API"]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Conversation not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "summary": "Update conversation",
+ "description": "Update conversation details",
+ "operationId": "updateConversation",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Conversation updated successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete conversation",
+ "description": "Delete a conversation",
+ "operationId": "deleteConversation",
+ "parameters": [
+ {
+ "name": "conversation_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Conversation ID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Conversation deleted successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/user/repositories": {
+ "get": {
+ "summary": "Get user repositories",
+ "description": "Get repositories for the authenticated user",
+ "operationId": "getUserRepositories",
+ "parameters": [
+ {
+ "name": "sort",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "pushed"
+ },
+ "description": "Sort order for repositories"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "User repositories",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unknown error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/user/info": {
+ "get": {
+ "summary": "Get user info",
+ "description": "Get information about the authenticated user",
+ "operationId": "getUser",
+ "responses": {
+ "200": {
+ "description": "User information",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unknown error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/user/search/repositories": {
+ "get": {
+ "summary": "Search repositories",
+ "description": "Search for repositories",
+ "operationId": "searchRepositories",
+ "parameters": [
+ {
+ "name": "query",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "Search query"
+ },
+ {
+ "name": "per_page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 5
+ },
+ "description": "Number of repositories to return per page"
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "stars"
+ },
+ "description": "Sort order for repositories"
+ },
+ {
+ "name": "order",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "desc"
+ },
+ "description": "Sort direction"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Search results",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unknown error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/user/suggested-tasks": {
+ "get": {
+ "summary": "Get suggested tasks",
+ "description": "Get suggested tasks for the authenticated user across their most recently pushed repositories",
+ "operationId": "getSuggestedTasks",
+ "responses": {
+ "200": {
+ "description": "Suggested tasks",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "repository": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Unknown error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/settings": {
+ "get": {
+ "summary": "Get settings",
+ "description": "Get user settings",
+ "operationId": "loadSettings",
+ "responses": {
+ "200": {
+ "description": "User settings",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "security_analyzer": {
+ "type": "string"
+ },
+ "confirmation_mode": {
+ "type": "boolean"
+ },
+ "llm_model": {
+ "type": "string"
+ },
+ "llm_api_key_set": {
+ "type": "boolean"
+ },
+ "llm_base_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "remote_runtime_resource_factor": {
+ "type": "number"
+ },
+ "enable_default_condenser": {
+ "type": "boolean"
+ },
+ "enable_sound_notifications": {
+ "type": "boolean"
+ },
+ "user_consents_to_analytics": {
+ "type": "boolean"
+ },
+ "provider_tokens_set": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Invalid token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Settings not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "summary": "Store settings",
+ "description": "Store user settings",
+ "operationId": "storeSettings",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "security_analyzer": {
+ "type": "string"
+ },
+ "confirmation_mode": {
+ "type": "boolean"
+ },
+ "llm_model": {
+ "type": "string"
+ },
+ "llm_api_key": {
+ "type": "string"
+ },
+ "llm_base_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "remote_runtime_resource_factor": {
+ "type": "number"
+ },
+ "enable_default_condenser": {
+ "type": "boolean"
+ },
+ "enable_sound_notifications": {
+ "type": "boolean"
+ },
+ "user_consents_to_analytics": {
+ "type": "boolean"
+ },
+ "provider_tokens": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Settings stored successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Invalid token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error storing settings",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/reset-settings": {
+ "post": {
+ "summary": "Reset settings (Deprecated)",
+ "description": "This endpoint is deprecated and will return a 410 Gone error. Reset functionality has been removed.",
+ "operationId": "resetSettings",
+ "deprecated": true,
+ "responses": {
+ "410": {
+ "description": "Feature removed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string",
+ "example": "Reset settings functionality has been removed."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/unset-settings-tokens": {
+ "post": {
+ "summary": "Unset settings tokens",
+ "description": "Unset provider tokens in settings",
+ "operationId": "unsetSettingsTokens",
+ "responses": {
+ "200": {
+ "description": "Tokens unset successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Error unsetting tokens",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/options/models": {
+ "get": {
+ "summary": "Get models",
+ "description": "Get all models supported by LiteLLM",
+ "operationId": "getLitellmModels",
+ "responses": {
+ "200": {
+ "description": "List of models",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/options/agents": {
+ "get": {
+ "summary": "Get agents",
+ "description": "Get all agents supported by OpenHands",
+ "operationId": "getAgents",
+ "responses": {
+ "200": {
+ "description": "List of agents",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/options/security-analyzers": {
+ "get": {
+ "summary": "Get security analyzers",
+ "description": "Get all supported security analyzers",
+ "operationId": "getSecurityAnalyzers",
+ "responses": {
+ "200": {
+ "description": "List of security analyzers",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/options/config": {
+ "get": {
+ "summary": "Get config",
+ "description": "Get current server configuration",
+ "operationId": "getConfig",
+ "responses": {
+ "200": {
+ "description": "Server configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Repository": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "User": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "SuggestedTask": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "repository": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "ConversationInfo": {
+ "type": "object",
+ "properties": {
+ "conversation_id": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "last_updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "selected_repository": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": ["RUNNING", "STOPPED"]
+ },
+ "trigger": {
+ "type": "string",
+ "enum": ["GUI", "API"]
+ }
+ }
+ },
+ "ConversationInfoResultSet": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ConversationInfo"
+ }
+ },
+ "next_page_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "FeedbackDataModel": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ },
+ "version": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "string",
+ "default": "private"
+ },
+ "polarity": {
+ "type": "string"
+ },
+ "feedback": {
+ "type": "string"
+ },
+ "trajectory": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "Settings": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "security_analyzer": {
+ "type": "string"
+ },
+ "confirmation_mode": {
+ "type": "boolean"
+ },
+ "llm_model": {
+ "type": "string"
+ },
+ "llm_api_key": {
+ "type": "string"
+ },
+ "llm_base_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "remote_runtime_resource_factor": {
+ "type": "number"
+ },
+ "enable_default_condenser": {
+ "type": "boolean"
+ },
+ "enable_sound_notifications": {
+ "type": "boolean"
+ },
+ "user_consents_to_analytics": {
+ "type": "boolean"
+ }
+ }
+ },
+ "GETSettingsModel": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "security_analyzer": {
+ "type": "string"
+ },
+ "confirmation_mode": {
+ "type": "boolean"
+ },
+ "llm_model": {
+ "type": "string"
+ },
+ "llm_api_key_set": {
+ "type": "boolean"
+ },
+ "llm_base_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "remote_runtime_resource_factor": {
+ "type": "number"
+ },
+ "enable_default_condenser": {
+ "type": "boolean"
+ },
+ "enable_sound_notifications": {
+ "type": "boolean"
+ },
+ "user_consents_to_analytics": {
+ "type": "boolean"
+ },
+ "provider_tokens_set": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "POSTSettingsModel": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string"
+ },
+ "agent": {
+ "type": "string"
+ },
+ "security_analyzer": {
+ "type": "string"
+ },
+ "confirmation_mode": {
+ "type": "boolean"
+ },
+ "llm_model": {
+ "type": "string"
+ },
+ "llm_api_key": {
+ "type": "string"
+ },
+ "llm_base_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "remote_runtime_resource_factor": {
+ "type": "number"
+ },
+ "enable_default_condenser": {
+ "type": "boolean"
+ },
+ "enable_sound_notifications": {
+ "type": "boolean"
+ },
+ "user_consents_to_analytics": {
+ "type": "boolean"
+ },
+ "provider_tokens": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "securitySchemes": {
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+}
diff --git a/docs/static/img/backend_architecture.png b/docs/static/img/backend_architecture.png
new file mode 100644
index 0000000000000000000000000000000000000000..c7eae5508960e41d90447bafadefa1284bb38232
--- /dev/null
+++ b/docs/static/img/backend_architecture.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ec7d7be3dc2240b7beefd169d9aadeb261a885ba036d48ee1c869f2f72c93cfe
+size 273400
diff --git a/docs/static/img/backend_architecture.puml b/docs/static/img/backend_architecture.puml
new file mode 100644
index 0000000000000000000000000000000000000000..c96651ab469baa827cd9f0a2ff59492191f22e17
--- /dev/null
+++ b/docs/static/img/backend_architecture.puml
@@ -0,0 +1,201 @@
+@startuml openhands
+!pragma useIntermediatePackages false
+
+class openhands.action.agent.AgentEchoAction {
+ content: str
+ runnable: bool
+ action: str
+}
+class openhands.action.agent.AgentFinishAction {
+ runnable: bool
+ action: str
+}
+class openhands.observation.AgentMessageObservation {
+ role: str
+ observation: str
+}
+class openhands.action.agent.AgentSummarizeAction {
+ summary: str
+ action: str
+}
+class openhands.action.agent.AgentThinkAction {
+ thought: str
+ runnable: bool
+ action: str
+}
+class openhands.action.base.ExecutableAction {
+}
+class openhands.action.base.NotExecutableAction {
+}
+class openhands.observation.Observation {
+ content: str
+}
+class openhands.action.base.Action {
+}
+class openhands.action.base.NullAction {
+ action: str
+}
+class openhands.action.bash.CmdRunAction {
+ command: str
+ action: str
+}
+class openhands.action.browse.BrowseURLAction {
+ url: str
+ action: str
+}
+class openhands.observation.BrowserOutputObservation {
+ url: str
+ status_code: int
+ error: bool
+ observation: str
+}
+class openhands.action.fileop.FileReadAction {
+ path: str
+ action: str
+}
+class openhands.observation.FileReadObservation {
+ path: str
+ observation: str
+}
+class openhands.action.fileop.FileWriteAction {
+ path: str
+ contents: str
+ action: str
+}
+class openhands.observation.FileWriteObservation {
+ path: str
+ observation: str
+}
+class openhands.action.tasks.AddTaskAction {
+ parent: str
+ goal: str
+ subtasks: list
+ action: str
+}
+class openhands.action.tasks.ModifyTaskAction {
+ id: str
+ state: str
+ action: str
+}
+abstract class openhands.agent.Agent {
+ _registry: Dict[str, Type[Agent]] {static}
+ llm: LLM
+ _complete: None
+}
+class openhands.llm.llm.LLM {
+ model: None
+ api_key: None
+ base_url: None
+ _debug_dir: None
+ _debug_idx: None
+ _debug_id: None
+ _completion: None
+}
+class openhands.controller.agent_controller.AgentController {
+ agent: Agent
+ max_iterations: int
+ workdir: str
+ command_manager: CommandManager
+ state: State
+ plan: Plan
+ callbacks: List[Callable]
+}
+class openhands.observation.AgentErrorObservation {
+ observation: str
+}
+class openhands.controller.command_manager.CommandManager {
+ directory: None
+ shell: None
+}
+class openhands.observation.NullObservation {
+ observation: str
+}
+class openhands.plan.Plan {
+ main_goal: str {static}
+ task: Task {static}
+ main_goal: str
+ task: None
+}
+class openhands.state.State {
+ plan: Plan
+ iteration: int
+ history: List[Tuple[Action, Observation]]
+ updated_info: List[Tuple[Action, Observation]]
+}
+class openhands.observation.CmdOutputObservation {
+ command: str
+ exit_code: int
+ observation: str
+}
+class openhands.sandbox.sandbox.DockerInteractive {
+ instance_id: None
+ instance_id: None
+ workspace_dir: None
+ workspace_dir: None
+ workspace_dir: None
+ timeout: int
+ base_container_image: None
+ container_name: None
+}
+class openhands.observation.UserMessageObservation {
+ role: str
+ observation: str
+}
+class openhands.plan.Task {
+ id: str {static}
+ goal: str {static}
+ parent: Task | None {static}
+ subtasks: List[Task] {static}
+ id: None
+ id: None
+ parent: None
+ goal: str
+ subtasks: None
+}
+
+class openhands.server.session.Session {
+ websocket: None
+ controller: Optional[AgentController]
+ agent: Optional[Agent]
+ agent_task: None
+}
+
+openhands.action.base.ExecutableAction <|-- openhands.action.agent.AgentEchoAction
+openhands.action.base.NotExecutableAction <|-- openhands.action.agent.AgentFinishAction
+openhands.observation.Observation <|-- openhands.observation.AgentMessageObservation
+openhands.action.base.NotExecutableAction <|-- openhands.action.agent.AgentSummarizeAction
+openhands.action.base.NotExecutableAction <|-- openhands.action.agent.AgentThinkAction
+openhands.action.base.Action <|-- openhands.action.base.ExecutableAction
+openhands.action.base.Action <|-- openhands.action.base.NotExecutableAction
+openhands.action.base.NotExecutableAction <|-- openhands.action.base.NullAction
+openhands.action.base.ExecutableAction <|-- openhands.action.bash.CmdRunAction
+openhands.action.base.ExecutableAction <|-- openhands.action.browse.BrowseURLAction
+openhands.observation.Observation <|-- openhands.observation.BrowserOutputObservation
+openhands.action.base.ExecutableAction <|-- openhands.action.fileop.FileReadAction
+openhands.observation.Observation <|-- openhands.observation.FileReadObservation
+openhands.action.base.ExecutableAction <|-- openhands.action.fileop.FileWriteAction
+openhands.observation.Observation <|-- openhands.observation.FileWriteObservation
+openhands.action.base.NotExecutableAction <|-- openhands.action.tasks.AddTaskAction
+openhands.action.base.NotExecutableAction <|-- openhands.action.tasks.ModifyTaskAction
+openhands.agent.Agent *-- openhands.agent.Agent
+openhands.agent.Agent *-- openhands.llm.llm.LLM
+openhands.controller.agent_controller.AgentController *-- openhands.agent.Agent
+openhands.observation.Observation <|-- openhands.observation.AgentErrorObservation
+openhands.observation.Observation <|-- openhands.observation.NullObservation
+openhands.plan.Plan *-- openhands.plan.Task
+openhands.state.State *-- openhands.plan.Plan
+openhands.state.State *-- openhands.observation.CmdOutputObservation
+openhands.state.State *-- openhands.action.base.Action
+openhands.state.State *-- openhands.observation.Observation
+openhands.observation.Observation <|-- openhands.observation.CmdOutputObservation
+openhands.observation.Observation <|-- openhands.observation.UserMessageObservation
+openhands.plan.Task *-- openhands.plan.Task
+openhands.server.session.Session *-- openhands.controller.agent_controller.AgentController
+openhands.server.session.Session *-- openhands.agent.Agent
+openhands.controller.agent_controller.AgentController -> openhands.state.State
+openhands.controller.agent_controller.AgentController -> openhands.plan.Plan
+openhands.controller.agent_controller.AgentController -> openhands.controller.command_manager.CommandManager
+openhands.controller.command_manager.CommandManager -> openhands.sandbox.sandbox.DockerInteractive
+
+footer Based on f3fda42; Generated by //py2puml//
+@enduml
diff --git a/docs/static/img/backend_architecture.svg b/docs/static/img/backend_architecture.svg
new file mode 100644
index 0000000000000000000000000000000000000000..a5fc173d5a844679f0a5f2089140fa80f1dd72b9
--- /dev/null
+++ b/docs/static/img/backend_architecture.svg
@@ -0,0 +1 @@
+
diff --git a/docs/static/img/connect-repo.png b/docs/static/img/connect-repo.png
new file mode 100644
index 0000000000000000000000000000000000000000..9eb86dc79a41fe5a36513115b71f8ca34bcc8ec3
Binary files /dev/null and b/docs/static/img/connect-repo.png differ
diff --git a/docs/static/img/docs/api-key-generation.png b/docs/static/img/docs/api-key-generation.png
new file mode 100644
index 0000000000000000000000000000000000000000..713a4a79d43abc83d1b6834bd94e6892214c157b
Binary files /dev/null and b/docs/static/img/docs/api-key-generation.png differ
diff --git a/docs/static/img/logo-square.png b/docs/static/img/logo-square.png
new file mode 100644
index 0000000000000000000000000000000000000000..624dad2fb22d4d2ac723d8e9f81ab56e0886c36d
--- /dev/null
+++ b/docs/static/img/logo-square.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:de58ad6132a9afb7d4924612c5e013695658af993a81a7611a6564f6a8063d59
+size 1189506
diff --git a/docs/static/img/logo.png b/docs/static/img/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..799c7ee7392f97f50eb6b91a35aa6c74c6ba0ae9
Binary files /dev/null and b/docs/static/img/logo.png differ
diff --git a/docs/static/img/oh-features.png b/docs/static/img/oh-features.png
new file mode 100644
index 0000000000000000000000000000000000000000..376ef750e5baed2d874b9bd4ec0dc8c48f2f84af
--- /dev/null
+++ b/docs/static/img/oh-features.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0e5022b7839f81b08e06b7b4f2f6e624259aa68ed6bfd95b47026cb940bacacb
+size 147978
diff --git a/docs/static/img/results.png b/docs/static/img/results.png
new file mode 100644
index 0000000000000000000000000000000000000000..7fdb83affef90ccf017c7c484f97d50c3a8cf003
--- /dev/null
+++ b/docs/static/img/results.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:920040c9ef19e8bed163da4b2ba337f8108e8636f55ce0a1b6388d5cd9ab32c2
+size 323430
diff --git a/docs/static/img/screenshot.png b/docs/static/img/screenshot.png
new file mode 100644
index 0000000000000000000000000000000000000000..6976b12a044873c720d9e1ab4c98ddc64ce3b517
--- /dev/null
+++ b/docs/static/img/screenshot.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4bb621a61826a12dc8eea4fb2b8d270e8b6a12dcb77ac84665982452a48cb6c4
+size 679233
diff --git a/docs/static/img/system_architecture.png b/docs/static/img/system_architecture.png
new file mode 100644
index 0000000000000000000000000000000000000000..42c05b1d4a86d8fb15e54075bb5df962c6aea7c1
Binary files /dev/null and b/docs/static/img/system_architecture.png differ
diff --git a/docs/static/img/system_architecture.puml b/docs/static/img/system_architecture.puml
new file mode 100644
index 0000000000000000000000000000000000000000..b1b9713ef45fb55eb1cd418dbd5ae7c0c434e187
--- /dev/null
+++ b/docs/static/img/system_architecture.puml
@@ -0,0 +1,67 @@
+@startuml "System Architecture"
+
+
+node frontend as frontend{
+
+ component App
+
+ package components{
+
+ component Terminal
+
+ component ChatInterface
+
+ component BannerSettings
+
+ }
+
+ package services{
+ component chatService
+
+ component settingsService
+
+ chatService -[hidden]u-> settingsService
+ }
+
+ package socket
+
+ App -> Terminal
+ App -> ChatInterface
+ App -> BannerSettings
+ ChatInterface -> chatService
+ BannerSettings -> settingsService
+ Terminal -> socket
+ chatService -d-> socket
+ settingsService -d-> socket
+ services -[hidden]d-> socket
+
+ Terminal -[hidden]u-> ChatInterface
+ ChatInterface -[hidden]u-> BannerSettings
+
+
+
+ interface "HTTP (:3001)" as HTTP
+ HTTP - App
+
+}
+
+node backend{
+ package server as serverpackage{
+ component Server
+
+ 'defined in server/server.py, port is defined at startup with uvicorn
+ interface "Client WS\n(:3000/ws)" as client_socket
+ client_socket - Server
+
+
+ }
+ node AgentController{
+
+ }
+ Server -d-> AgentController
+}
+
+
+socket -d-> client_socket: connects to \n VITE_TERMINAL_WS_URL
+
+@enduml
diff --git a/docs/static/img/system_architecture.svg b/docs/static/img/system_architecture.svg
new file mode 100644
index 0000000000000000000000000000000000000000..d259a4ca3be652065ed67f11ec352fce9faee973
--- /dev/null
+++ b/docs/static/img/system_architecture.svg
@@ -0,0 +1 @@
+
diff --git a/docs/static/img/system_architecture_overview.png b/docs/static/img/system_architecture_overview.png
new file mode 100644
index 0000000000000000000000000000000000000000..290972eb78592d3d88b7016e67b551b41b8ae96d
--- /dev/null
+++ b/docs/static/img/system_architecture_overview.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8059e09a3a6cadda2f0e19eb6d16dc05b2179c56b6604998be70076bd6bd70a6
+size 175252
diff --git a/docs/static/img/teaser.mp4 b/docs/static/img/teaser.mp4
new file mode 100644
index 0000000000000000000000000000000000000000..6e7891c85d296a11fee49cdffb02098c3da2094e
--- /dev/null
+++ b/docs/static/img/teaser.mp4
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a2b9dfd699226a4e6d3e2bb0926941f954cc11c68024e011c861215bb81ff381
+size 36187951
diff --git a/docs/usage/about.mdx b/docs/usage/about.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..0d52f410ba4ac1bcd9fdc7f07e63458e1fb1a33c
--- /dev/null
+++ b/docs/usage/about.mdx
@@ -0,0 +1,30 @@
+---
+title: About OpenHands
+---
+
+## Research Strategy
+
+Achieving full replication of production-grade applications with LLMs is a complex endeavor. Our strategy involves:
+
+- **Core Technical Research:** Focusing on foundational research to understand and improve the technical aspects of code generation and handling.
+- **Task Planning:** Developing capabilities for bug detection, codebase management, and optimization.
+- **Evaluation:** Establishing comprehensive evaluation metrics to better understand and improve our agents.
+
+## Default Agent
+
+Our default Agent is currently the [CodeActAgent](./agents), which is capable of generating code and handling files.
+
+## Built With
+
+OpenHands is built using a combination of powerful frameworks and libraries, providing a robust foundation for its
+development. Here are the key technologies used in the project:
+
+       
+
+Please note that the selection of these technologies is in progress, and additional technologies may be added or
+existing ones may be removed as the project evolves. We strive to adopt the most suitable and efficient tools to
+enhance the capabilities of OpenHands.
+
+## License
+
+Distributed under MIT [License](https://github.com/All-Hands-AI/OpenHands/blob/main/LICENSE).
diff --git a/docs/usage/agents.mdx b/docs/usage/agents.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..ec51228bcf1638a3289b5b56d5e7c65cf1b584ba
--- /dev/null
+++ b/docs/usage/agents.mdx
@@ -0,0 +1,26 @@
+---
+title: Main Agent and Capabilities
+---
+
+## CodeActAgent
+
+### Description
+
+This agent implements the CodeAct idea ([paper](https://arxiv.org/abs/2402.01030), [tweet](https://twitter.com/xingyaow_/status/1754556835703751087)) that consolidates LLM agents’ **act**ions into a
+unified **code** action space for both _simplicity_ and _performance_.
+
+The conceptual idea is illustrated below. At each turn, the agent can:
+
+1. **Converse**: Communicate with humans in natural language to ask for clarification, confirmation, etc.
+2. **CodeAct**: Choose to perform the task by executing code
+
+- Execute any valid Linux `bash` command
+- Execute any valid `Python` code with [an interactive Python interpreter](https://ipython.org/). This is simulated through `bash` command, see plugin system below for more details.
+
+
+
+### Demo
+
+https://github.com/All-Hands-AI/OpenHands/assets/38853559/f592a192-e86c-4f48-ad31-d69282d5f6ac
+
+_Example of CodeActAgent with `gpt-4-turbo-2024-04-09` performing a data science task (linear regression)_.
diff --git a/docs/usage/architecture/backend.mdx b/docs/usage/architecture/backend.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..b49c5b45b250bf82cb46d46abbe666ec6872b2af
--- /dev/null
+++ b/docs/usage/architecture/backend.mdx
@@ -0,0 +1,56 @@
+---
+title: Backend Architecture
+---
+
+
+
+
OpenHands System Architecture Diagram (July 4, 2024)
+
+
+This is a high-level overview of the system architecture. The system is divided into two main components: the frontend and the backend. The frontend is responsible for handling user interactions and displaying the results. The backend is responsible for handling the business logic and executing the agents.
+
+# Frontend architecture
+
+
+
+This Overview is simplified to show the main components and their interactions. For a more detailed view of the backend architecture, see the Backend Architecture section below.
+
+# Backend Architecture
+
+_**Disclaimer**: The backend architecture is a work in progress and is subject to change. The following diagram shows the current architecture of the backend based on the commit that is shown in the footer of the diagram._
+
+
+
+
+ Updating this Diagram
+
+ The generation of the backend architecture diagram is partially automated.
+ The diagram is generated from the type hints in the code using the py2puml
+ tool. The diagram is then manually reviewed, adjusted and exported to PNG
+ and SVG.
+
+ ## Prerequisites
+
+ - Running python environment in which openhands is executable
+ (according to the instructions in the README.md file in the root of the repository)
+ - [py2puml](https://github.com/lucsorel/py2puml) installed
+
+## Steps
+
+1. Autogenerate the diagram by running the following command from the root of the repository:
+ `py2puml openhands openhands > docs/architecture/backend_architecture.puml`
+
+2. Open the generated file in a PlantUML editor, e.g. Visual Studio Code with the PlantUML extension or [PlantText](https://www.planttext.com/)
+
+3. Review the generated PUML and make all necessary adjustments to the diagram (add missing parts, fix mistakes, improve positioning).
+ _py2puml creates the diagram based on the type hints in the code, so missing or incorrect type hints may result in an incomplete or incorrect diagram._
+
+4. Review the diff between the new and the previous diagram and manually check if the changes are correct.
+ _Make sure not to remove parts that were manually added to the diagram in the past and are still relevant._
+
+5. Add the commit hash of the commit that was used to generate the diagram to the diagram footer.
+
+6. Export the diagram as PNG and SVG files and replace the existing diagrams in the `docs/architecture` directory. This can be done with (e.g. [PlantText](https://www.planttext.com/))
+
+
+
diff --git a/docs/usage/architecture/runtime.mdx b/docs/usage/architecture/runtime.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..5ebcf3bafc21348c88b86abb9b5088d5d2d3021c
--- /dev/null
+++ b/docs/usage/architecture/runtime.mdx
@@ -0,0 +1,136 @@
+---
+title: Runtime Architecture
+---
+
+The OpenHands Docker Runtime is the core component that enables secure and flexible execution of AI agent's action.
+It creates a sandboxed environment using Docker, where arbitrary code can be run safely without risking the host system.
+
+## Why do we need a sandboxed runtime?
+
+OpenHands needs to execute arbitrary code in a secure, isolated environment for several reasons:
+
+1. Security: Executing untrusted code can pose significant risks to the host system. A sandboxed environment prevents malicious code from accessing or modifying the host system's resources
+2. Consistency: A sandboxed environment ensures that code execution is consistent across different machines and setups, eliminating "it works on my machine" issues
+3. Resource Control: Sandboxing allows for better control over resource allocation and usage, preventing runaway processes from affecting the host system
+4. Isolation: Different projects or users can work in isolated environments without interfering with each other or the host system
+5. Reproducibility: Sandboxed environments make it easier to reproduce bugs and issues, as the execution environment is consistent and controllable
+
+## How does the Runtime work?
+
+The OpenHands Runtime system uses a client-server architecture implemented with Docker containers. Here's an overview of how it works:
+
+```mermaid
+graph TD
+ A[User-provided Custom Docker Image] --> B[OpenHands Backend]
+ B -->|Builds| C[OH Runtime Image]
+ C -->|Launches| D[Action Executor]
+ D -->|Initializes| E[Browser]
+ D -->|Initializes| F[Bash Shell]
+ D -->|Initializes| G[Plugins]
+ G -->|Initializes| L[Jupyter Server]
+
+ B -->|Spawn| H[Agent]
+ B -->|Spawn| I[EventStream]
+ I <--->|Execute Action to
+ Get Observation
+ via REST API
+ | D
+
+ H -->|Generate Action| I
+ I -->|Obtain Observation| H
+
+ subgraph "Docker Container"
+ D
+ E
+ F
+ G
+ L
+ end
+```
+
+1. User Input: The user provides a custom base Docker image
+2. Image Building: OpenHands builds a new Docker image (the "OH runtime image") based on the user-provided image. This new image includes OpenHands-specific code, primarily the "runtime client"
+3. Container Launch: When OpenHands starts, it launches a Docker container using the OH runtime image
+4. Action Execution Server Initialization: The action execution server initializes an `ActionExecutor` inside the container, setting up necessary components like a bash shell and loading any specified plugins
+5. Communication: The OpenHands backend (`openhands/runtime/impl/eventstream/eventstream_runtime.py`) communicates with the action execution server over RESTful API, sending actions and receiving observations
+6. Action Execution: The runtime client receives actions from the backend, executes them in the sandboxed environment, and sends back observations
+7. Observation Return: The action execution server sends execution results back to the OpenHands backend as observations
+
+The role of the client:
+
+- It acts as an intermediary between the OpenHands backend and the sandboxed environment
+- It executes various types of actions (shell commands, file operations, Python code, etc.) safely within the container
+- It manages the state of the sandboxed environment, including the current working directory and loaded plugins
+- It formats and returns observations to the backend, ensuring a consistent interface for processing results
+
+## How OpenHands builds and maintains OH Runtime images
+
+OpenHands' approach to building and managing runtime images ensures efficiency, consistency, and flexibility in creating and maintaining Docker images for both production and development environments.
+
+Check out the [relevant code](https://github.com/All-Hands-AI/OpenHands/blob/main/openhands/runtime/utils/runtime_build.py) if you are interested in more details.
+
+### Image Tagging System
+
+OpenHands uses a three-tag system for its runtime images to balance reproducibility with flexibility.
+Tags may be in one of 2 formats:
+
+- **Versioned Tag**: `oh_v{openhands_version}_{base_image}` (e.g.: `oh_v0.9.9_nikolaik_s_python-nodejs_t_python3.12-nodejs22`)
+- **Lock Tag**: `oh_v{openhands_version}_{16_digit_lock_hash}` (e.g.: `oh_v0.9.9_1234567890abcdef`)
+- **Source Tag**: `oh_v{openhands_version}_{16_digit_lock_hash}_{16_digit_source_hash}`
+ (e.g.: `oh_v0.9.9_1234567890abcdef_1234567890abcdef`)
+
+#### Source Tag - Most Specific
+
+This is the first 16 digits of the MD5 of the directory hash for the source directory. This gives a hash
+for only the openhands source
+
+#### Lock Tag
+
+This hash is built from the first 16 digits of the MD5 of:
+
+- The name of the base image upon which the image was built (e.g.: `nikolaik/python-nodejs:python3.12-nodejs22`)
+- The content of the `pyproject.toml` included in the image.
+- The content of the `poetry.lock` included in the image.
+
+This effectively gives a hash for the dependencies of Openhands independent of the source code.
+
+#### Versioned Tag - Most Generic
+
+This tag is a concatenation of openhands version and the base image name (transformed to fit in tag standard).
+
+#### Build Process
+
+When generating an image...
+
+- **No re-build**: OpenHands first checks whether an image with the same **most specific source tag** exists. If there is such an image,
+ no build is performed - the existing image is used.
+- **Fastest re-build**: OpenHands next checks whether an image with the **generic lock tag** exists. If there is such an image,
+ OpenHands builds a new image based upon it, bypassing all installation steps (like `poetry install` and
+ `apt-get`) except a final operation to copy the current source code. The new image is tagged with a
+ **source** tag only.
+- **Ok-ish re-build**: If neither a **source** nor **lock** tag exists, an image will be built based upon the **versioned** tag image.
+ In versioned tag image, most dependencies should already been installed hence saving time.
+- **Slowest re-build**: If all of the three tags don't exists, a brand new image is built based upon the base
+ image (Which is a slower operation). This new image is tagged with all the **source**, **lock**, and **versioned** tags.
+
+This tagging approach allows OpenHands to efficiently manage both development and production environments.
+
+1. Identical source code and Dockerfile always produce the same image (via hash-based tags)
+2. The system can quickly rebuild images when minor changes occur (by leveraging recent compatible images)
+3. The **lock** tag (e.g., `runtime:oh_v0.9.3_1234567890abcdef`) always points to the latest build for a particular base image, dependency, and OpenHands version combination
+
+## Runtime Plugin System
+
+The OpenHands Runtime supports a plugin system that allows for extending functionality and customizing the runtime environment. Plugins are initialized when the runtime client starts up.
+
+Check [an example of Jupyter plugin here](https://github.com/All-Hands-AI/OpenHands/blob/ecf4aed28b0cf7c18d4d8ff554883ba182fc6bdd/openhands/runtime/plugins/jupyter/__init__.py#L21-L55) if you want to implement your own plugin.
+
+*More details about the Plugin system are still under construction - contributions are welcomed!*
+
+Key aspects of the plugin system:
+
+1. Plugin Definition: Plugins are defined as Python classes that inherit from a base `Plugin` class
+2. Plugin Registration: Available plugins are registered in an `ALL_PLUGINS` dictionary
+3. Plugin Specification: Plugins are associated with `Agent.sandbox_plugins: list[PluginRequirement]`. Users can specify which plugins to load when initializing the runtime
+4. Initialization: Plugins are initialized asynchronously when the runtime client starts
+5. Usage: The runtime client can use initialized plugins to extend its capabilities (e.g., the JupyterPlugin for running IPython cells)
diff --git a/docs/usage/cloud/cloud-api.mdx b/docs/usage/cloud/cloud-api.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..c4565cccaae831088deb9c6ae04a8c8b2096ffc9
--- /dev/null
+++ b/docs/usage/cloud/cloud-api.mdx
@@ -0,0 +1,176 @@
+---
+title: Cloud API
+description: OpenHands Cloud provides a REST API that allows you to programmatically interact with the service. This guide explains how to obtain an API key and use the API to start conversations.
+---
+
+For more detailed information about the API, refer to the [OpenHands API Reference](https://docs.all-hands.dev/swagger-ui/).
+
+## Obtaining an API Key
+
+To use the OpenHands Cloud API, you'll need to generate an API key:
+
+1. Log in to your [OpenHands Cloud](https://app.all-hands.dev) account.
+2. Navigate to the [Settings page](https://app.all-hands.dev/settings).
+3. Select the `API Keys` tab.
+4. Click `Create API Key`.
+5. Give your key a descriptive name (Example: "Development" or "Production") and select `Create`.
+6. Copy the generated API key and store it securely. It will only be shown once.
+
+
+
+## API Usage
+
+### Starting a New Conversation
+
+To start a new conversation with OpenHands to perform a task, you'll need to make a POST request to the conversation endpoint.
+
+#### Request Parameters
+
+| Parameter | Type | Required | Description |
+|--------------------|----------|----------|------------------------------------------------------------------------------------------------------|
+| `initial_user_msg` | string | Yes | The initial message to start the conversation. |
+| `repository` | string | No | Git repository name to provide context in the format `owner/repo`. You must have access to the repo. |
+
+#### Examples
+
+
+cURL
+
+```bash
+curl -X POST "https://app.all-hands.dev/api/conversations" \
+ -H "Authorization: Bearer YOUR_API_KEY" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "initial_user_msg": "Check whether there is any incorrect information in the README.md file and send a PR to fix it if so.",
+ "repository": "yourusername/your-repo"
+ }'
+```
+
+
+
+Python (with requests)
+
+```python
+import requests
+
+api_key = "YOUR_API_KEY"
+url = "https://app.all-hands.dev/api/conversations"
+
+headers = {
+ "Authorization": f"Bearer {api_key}",
+ "Content-Type": "application/json"
+}
+
+data = {
+ "initial_user_msg": "Check whether there is any incorrect information in the README.md file and send a PR to fix it if so.",
+ "repository": "yourusername/your-repo"
+}
+
+response = requests.post(url, headers=headers, json=data)
+conversation = response.json()
+
+print(f"Conversation Link: https://app.all-hands.dev/conversations/{conversation['conversation_id']}")
+print(f"Status: {conversation['status']}")
+```
+
+
+
+TypeScript/JavaScript (with fetch)
+
+```typescript
+const apiKey = "YOUR_API_KEY";
+const url = "https://app.all-hands.dev/api/conversations";
+
+const headers = {
+ "Authorization": `Bearer ${apiKey}`,
+ "Content-Type": "application/json"
+};
+
+const data = {
+ initial_user_msg: "Check whether there is any incorrect information in the README.md file and send a PR to fix it if so.",
+ repository: "yourusername/your-repo"
+};
+
+async function startConversation() {
+ try {
+ const response = await fetch(url, {
+ method: "POST",
+ headers: headers,
+ body: JSON.stringify(data)
+ });
+
+ const conversation = await response.json();
+
+ console.log(`Conversation Link: https://app.all-hands.dev/conversations/${conversation.id}`);
+ console.log(`Status: ${conversation.status}`);
+
+ return conversation;
+ } catch (error) {
+ console.error("Error starting conversation:", error);
+ }
+}
+
+startConversation();
+```
+
+
+
+#### Response
+
+The API will return a JSON object with details about the created conversation:
+
+```json
+{
+ "status": "ok",
+ "conversation_id": "abc1234",
+}
+```
+
+You may receive an `AuthenticationError` if:
+
+- You provided an invalid API key.
+- You provided the wrong repository name.
+- You don't have access to the repository.
+
+
+### Retrieving Conversation Status
+
+You can check the status of a conversation by making a GET request to the conversation endpoint.
+
+#### Endpoint
+
+```
+GET https://app.all-hands.dev/api/conversations/{conversation_id}
+```
+
+#### Example
+
+
+cURL
+
+```bash
+curl -X GET "https://app.all-hands.dev/api/conversations/{conversation_id}" \
+ -H "Authorization: Bearer YOUR_API_KEY"
+```
+
+
+#### Response
+
+The response is formatted as follows:
+
+```json
+{
+ "conversation_id":"abc1234",
+ "title":"Update README.md",
+ "created_at":"2025-04-29T15:13:51.370706Z",
+ "last_updated_at":"2025-04-29T15:13:57.199210Z",
+ "status":"RUNNING",
+ "selected_repository":"yourusername/your-repo",
+ "trigger":"gui"
+}
+```
+
+## Rate Limits
+
+If you have too many conversations running at once, older conversations will be paused to limit the number of concurrent conversations.
+If you're running into issues and need a higher limit for your use case, please contact us at [contact@all-hands.dev](mailto:contact@all-hands.dev).
diff --git a/docs/usage/cloud/cloud-ui.mdx b/docs/usage/cloud/cloud-ui.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..8b6d7bcf9733d3b038f9670dc7595e5cb4288597
--- /dev/null
+++ b/docs/usage/cloud/cloud-ui.mdx
@@ -0,0 +1,36 @@
+---
+title: Cloud UI
+description: The Cloud UI provides a web interface for interacting with OpenHands. This page explains how to use the
+ OpenHands Cloud UI.
+---
+
+## Landing Page
+
+The landing page is where you can:
+
+- [Add GitHub repository access](/usage/cloud/github-installation#adding-github-repository-access) to OpenHands.
+- [Select a GitHub repo](/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud) or
+ [a GitLab repo](/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) to start working on.
+- See `Suggested Tasks` for repositories that OpenHands has access to.
+- Launch an empty conversation using `Launch from Scratch`.
+
+## Settings
+
+The Settings page allows you to:
+
+- [Configure GitHub repository access](/usage/cloud/github-installation#modifying-repository-access) for OpenHands.
+- Set application settings like your preferred language, notifications and other preferences.
+- Add credits to your account.
+- Generate custom secrets.
+- Create API keys to work with OpenHands programmatically.
+
+## Key Features
+
+For an overview of the key features available inside a conversation, please refer to the [Key Features](../key-features)
+section of the documentation.
+
+## Next Steps
+
+- [Install GitHub Integration](/usage/cloud/github-installation) to use OpenHands with your GitHub repositories.
+- [Install GitLab Integration](/usage/cloud/gitlab-installation) to use OpenHands with your GitLab repositories.
+- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
diff --git a/docs/usage/cloud/github-installation.mdx b/docs/usage/cloud/github-installation.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..eb25cab10e4f9745e858696afd3f864f5f266287
--- /dev/null
+++ b/docs/usage/cloud/github-installation.mdx
@@ -0,0 +1,71 @@
+---
+title: GitHub Integration
+description: This guide walks you through the process of installing OpenHands Cloud for your GitHub repositories. Once
+ set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub!
+---
+
+## Prerequisites
+
+- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitHub account](/usage/cloud/openhands-cloud).
+
+## Adding GitHub Repository Access
+
+You can grant OpenHands access to specific GitHub repositories:
+
+1. Click on `Add GitHub repos` on the landing page.
+2. Select your organization and choose the specific repositories to grant OpenHands access to.
+
+ - OpenHands requests short-lived tokens (8-hour expiration) with these permissions:
+ - Actions: Read and write
+ - Commit statuses: Read and write
+ - Contents: Read and write
+ - Issues: Read and write
+ - Metadata: Read-only
+ - Pull requests: Read and write
+ - Webhooks: Read and write
+ - Workflows: Read and write
+ - Repository access for a user is granted based on:
+ - Permission granted for the repository
+ - User's GitHub permissions (owner/collaborator)
+
+
+3. Click `Install & Authorize`.
+
+## Modifying Repository Access
+
+You can modify GitHub repository access at any time by:
+- Selecting `Add GitHub repos` on the landing page or
+- Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Git` tab
+
+## Working With GitHub Repos in Openhands Cloud
+
+Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the `select a repo`
+and `select a branch` dropdowns to select the appropriate repository and branch you'd like OpenHands to work on. Then
+click on `Launch` to start the conversation!
+
+
+
+## Working on Github Issues and Pull Requests Using Openhands
+
+Giving GitHub repository access to OpenHands also allows you to work on GitHub issues and pull requests directly.
+
+### Working with Issues
+
+On your repository, label an issue with `openhands` or add a message starting with
+`@openhands`. OpenHands will:
+1. Comment on the issue to let you know it is working on it.
+ - You can click on the link to track the progress on OpenHands Cloud.
+2. Open a pull request if it determines that the issue has been successfully resolved.
+3. Comment on the issue with a summary of the performed tasks and a link to the PR.
+
+### Working with Pull Requests
+
+To get OpenHands to work on pull requests, mention `@openhands` in the comments to:
+- Ask questions
+- Request updates
+- Get code explanations
+
+## Next Steps
+
+- [Learn about the Cloud UI](/usage/cloud/cloud-ui).
+- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
diff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..028b984facc23e10bf2902fc0380c62ec5ec0338
--- /dev/null
+++ b/docs/usage/cloud/gitlab-installation.mdx
@@ -0,0 +1,25 @@
+---
+title: GitLab Integration
+description: This guide walks you through the process of installing OpenHands Cloud for your GitLab repositories. Once
+ set up, it will allow OpenHands to work with your GitLab repository.
+---
+
+## Prerequisites
+
+- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitLab account](/usage/cloud/openhands-cloud).
+
+## Adding GitLab Repository Access
+
+Upon signing into OpenHands Cloud with a GitLab account, OpenHands will have access to your repositories.
+
+## Working With GitLab Repos in Openhands Cloud
+
+After signing in with a Gitlab account, use the `select a repo` and `select a branch` dropdowns to select the
+appropriate repository and branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!
+
+
+
+## Next Steps
+
+- [Learn about the Cloud UI](/usage/cloud/cloud-ui).
+- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
diff --git a/docs/usage/cloud/openhands-cloud.mdx b/docs/usage/cloud/openhands-cloud.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..053453afb2b6a4b6c52c07d764132f507b3f6d43
--- /dev/null
+++ b/docs/usage/cloud/openhands-cloud.mdx
@@ -0,0 +1,26 @@
+---
+title: Getting Started
+description: Getting started with OpenHands Cloud.
+---
+
+## Accessing OpenHands Cloud
+
+OpenHands Cloud is the hosted cloud version of All Hands AI's OpenHands. To get started with OpenHands Cloud,
+visit [app.all-hands.dev](https://app.all-hands.dev).
+
+You'll be prompted to connect with your GitHub or GitLab account:
+
+1. Click `Log in with GitHub` or `Log in with GitLab`.
+2. Review the permissions requested by OpenHands and authorize the application.
+ - OpenHands will require certain permissions from your account. To read more about these permissions,
+ you can click the `Learn more` link on the authorization page.
+3. Review and accept the `terms of service` and select `Continue`.
+
+## Next Steps
+
+Once you've connected your account, you can:
+
+- [Install GitHub Integration](/usage/cloud/github-installation) to use OpenHands with your GitHub repositories.
+- [Install GitLab Integration](/usage/cloud/gitlab-installation) to use OpenHands with your GitLab repositories.
+- [Learn about the Cloud UI](/usage/cloud/cloud-ui).
+- [Use the Cloud API](/usage/cloud/cloud-api) to programmatically interact with OpenHands.
diff --git a/docs/usage/configuration-options.mdx b/docs/usage/configuration-options.mdx
new file mode 100644
index 0000000000000000000000000000000000000000..e39c5eca958e03f8b986b47abd4fa3de6bd8f4a1
--- /dev/null
+++ b/docs/usage/configuration-options.mdx
@@ -0,0 +1,413 @@
+---
+title: Configuration Options
+description: This page outlines all available configuration options for OpenHands, allowing you to customize its behavior and integrate it with other services. In GUI Mode, any settings applied through the Settings UI will take precedence.
+---
+
+## Core Configuration
+
+The core configuration options are defined in the `[core]` section of the `config.toml` file.
+
+### API Keys
+- `e2b_api_key`
+ - Type: `str`
+ - Default: `""`
+ - Description: API key for E2B
+
+- `modal_api_token_id`
+ - Type: `str`
+ - Default: `""`
+ - Description: API token ID for Modal
+
+- `modal_api_token_secret`
+ - Type: `str`
+ - Default: `""`
+ - Description: API token secret for Modal
+
+### Workspace
+- `workspace_base` **(Deprecated)**
+ - Type: `str`
+ - Default: `"./workspace"`
+ - Description: Base path for the workspace. **Deprecated: Use `SANDBOX_VOLUMES` instead.**
+
+- `cache_dir`
+ - Type: `str`
+ - Default: `"/tmp/cache"`
+ - Description: Cache directory path
+
+### Debugging and Logging
+- `debug`
+ - Type: `bool`
+ - Default: `false`
+ - Description: Enable debugging
+
+- `disable_color`
+ - Type: `bool`
+ - Default: `false`
+ - Description: Disable color in terminal output
+
+### Trajectories
+- `save_trajectory_path`
+ - Type: `str`
+ - Default: `"./trajectories"`
+ - Description: Path to store trajectories (can be a folder or a file). If it's a folder, the trajectories will be saved in a file named with the session id name and .json extension, in that folder.
+
+- `replay_trajectory_path`
+ - Type: `str`
+ - Default: `""`
+ - Description: Path to load a trajectory and replay. If given, must be a path to the trajectory file in JSON format. The actions in the trajectory file would be replayed first before any user instruction is executed.
+
+### File Store
+- `file_store_path`
+ - Type: `str`
+ - Default: `"/tmp/file_store"`
+ - Description: File store path
+
+- `file_store`
+ - Type: `str`
+ - Default: `"memory"`
+ - Description: File store type
+
+- `file_uploads_allowed_extensions`
+ - Type: `list of str`
+ - Default: `[".*"]`
+ - Description: List of allowed file extensions for uploads
+
+- `file_uploads_max_file_size_mb`
+ - Type: `int`
+ - Default: `0`
+ - Description: Maximum file size for uploads, in megabytes
+
+- `file_uploads_restrict_file_types`
+ - Type: `bool`
+ - Default: `false`
+ - Description: Restrict file types for file uploads
+
+- `file_uploads_allowed_extensions`
+ - Type: `list of str`
+ - Default: `[".*"]`
+ - Description: List of allowed file extensions for uploads
+
+### Task Management
+- `max_budget_per_task`
+ - Type: `float`
+ - Default: `0.0`
+ - Description: Maximum budget per task (0.0 means no limit)
+
+- `max_iterations`
+ - Type: `int`
+ - Default: `100`
+ - Description: Maximum number of iterations
+
+### Sandbox Configuration
+- `volumes`
+ - Type: `str`
+ - Default: `None`
+ - Description: Volume mounts in the format 'host_path:container_path[:mode]', e.g. '/my/host/dir:/workspace:rw'. Multiple mounts can be specified using commas, e.g. '/path1:/workspace/path1,/path2:/workspace/path2:ro'
+
+- `workspace_mount_path_in_sandbox` **(Deprecated)**
+ - Type: `str`
+ - Default: `"/workspace"`
+ - Description: Path to mount the workspace in the sandbox. **Deprecated: Use `SANDBOX_VOLUMES` instead.**
+
+- `workspace_mount_path` **(Deprecated)**
+ - Type: `str`
+ - Default: `""`
+ - Description: Path to mount the workspace. **Deprecated: Use `SANDBOX_VOLUMES` instead.**
+
+- `workspace_mount_rewrite` **(Deprecated)**
+ - Type: `str`
+ - Default: `""`
+ - Description: Path to rewrite the workspace mount path to. You can usually ignore this, it refers to special cases of running inside another container. **Deprecated: Use `SANDBOX_VOLUMES` instead.**
+
+### Miscellaneous
+- `run_as_openhands`
+ - Type: `bool`
+ - Default: `true`
+ - Description: Run as OpenHands
+
+- `runtime`
+ - Type: `str`
+ - Default: `"docker"`
+ - Description: Runtime environment
+
+- `default_agent`
+ - Type: `str`
+ - Default: `"CodeActAgent"`
+ - Description: Name of the default agent
+
+- `jwt_secret`
+ - Type: `str`
+ - Default: `uuid.uuid4().hex`
+ - Description: JWT secret for authentication. Please set it to your own value.
+
+## LLM Configuration
+
+The LLM (Large Language Model) configuration options are defined in the `[llm]` section of the `config.toml` file.
+
+To use these with the docker command, pass in `-e LLM_
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+To learn more about the project, and for tips on using OpenHands,
+check out our [documentation](https://docs.all-hands.dev/usage/getting-started).
+
+There you'll find resources on how to use different LLM providers,
+troubleshooting resources, and advanced configuration options.
+
+## 🤝 How to Join the Community
+
+OpenHands is a community-driven project, and we welcome contributions from everyone. We do most of our communication
+through Slack, so this is the best place to start, but we also are happy to have you contact us on Discord or Github:
+
+- [Join our Slack workspace](https://join.slack.com/t/openhands-ai/shared_invite/zt-34zm4j0gj-Qz5kRHoca8DFCbqXPS~f_A) - Here we talk about research, architecture, and future development.
+- [Join our Discord server](https://discord.gg/ESHStjSjD4) - This is a community-run server for general discussion, questions, and feedback.
+- [Read or post Github Issues](https://github.com/All-Hands-AI/OpenHands/issues) - Check out the issues we're working on, or add your own ideas.
+
+See more about the community in [COMMUNITY.md](./COMMUNITY.md) or find details on contributing in [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## 📈 Progress
+
+See the monthly OpenHands roadmap [here](https://github.com/orgs/All-Hands-AI/projects/1) (updated at the maintainer's meeting at the end of each month).
+
+