# OpenHands Docs

## Docs

- [Introduction](https://allhandsai-mh-space.mintlify.app/index.md): OpenHands - Code Less, Make More.
- [Configuration Options](https://allhandsai-mh-space.mintlify.app/openhands/usage/advanced/configuration-options.md): This page outlines all available configuration options for OpenHands, allowing you to customize its behavior and integrate it with other services.
- [Custom Sandbox](https://allhandsai-mh-space.mintlify.app/openhands/usage/advanced/custom-sandbox-guide.md): This guide is for users that would like to use their own custom Docker image for the runtime. For example, with certain tools or programming languages pre-installed.
- [Search Engine Setup](https://allhandsai-mh-space.mintlify.app/openhands/usage/advanced/search-engine-setup.md): Configure OpenHands to use Tavily as a search engine.
- [Backend Architecture](https://allhandsai-mh-space.mintlify.app/openhands/usage/architecture/backend.md)
- [Runtime Architecture](https://allhandsai-mh-space.mintlify.app/openhands/usage/architecture/runtime.md)
- [Bitbucket Integration](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/bitbucket-installation.md): This guide walks you through the process of installing OpenHands Cloud for your Bitbucket repositories. Once set up, it will allow OpenHands to work with your Bitbucket repository.
- [Cloud API](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/cloud-api.md): OpenHands Cloud provides a REST API that allows you to programmatically interact with OpenHands. This guide explains how to obtain an API key and use the API to start conversations and retrieve their status.
- [Cloud UI](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/cloud-ui.md): The Cloud UI provides a web interface for interacting with OpenHands. This page provides references on how to use the OpenHands Cloud UI.
- [GitHub Integration](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/github-installation.md): 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!
- [GitLab Integration](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/gitlab-installation.md): 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 through the Cloud UI or straight from GitLab!.
- [Getting Started](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/openhands-cloud.md): Getting started with OpenHands Cloud.
- [Pro Subscription](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/pro-subscription.md): Learn about OpenHands Cloud Pro Subscription features and pricing.
- [Jira Data Center Integration (Coming soon...)](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/project-management/jira-dc-integration.md): Complete guide for setting up Jira Data Center integration with OpenHands Cloud, including service account creation, personal access token generation, webhook configuration, and workspace integration setup.
- [Jira Cloud Integration (Coming soon...)](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/project-management/jira-integration.md): Complete guide for setting up Jira Cloud integration with OpenHands Cloud, including service account creation, API token generation, webhook configuration, and workspace integration setup.
- [Linear Integration (Coming soon...)](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/project-management/linear-integration.md): Complete guide for setting up Linear integration with OpenHands Cloud, including service account creation, API key generation, webhook configuration, and workspace integration setup.
- [Project Management Tool Integrations (Coming soon...)](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/project-management/overview.md): Overview of OpenHands Cloud integrations with project management platforms including Jira Cloud, Jira Data Center, and Linear. Learn about setup requirements, usage methods, and troubleshooting.
- [Slack Integration (Beta)](https://allhandsai-mh-space.mintlify.app/openhands/usage/cloud/slack-installation.md): This guide walks you through installing the OpenHands Slack app.
- [Repository Customization](https://allhandsai-mh-space.mintlify.app/openhands/usage/customization/repository.md): You can customize how OpenHands interacts with your repository by creating a `.openhands` directory at the root level.
- [Debugging](https://allhandsai-mh-space.mintlify.app/openhands/usage/developers/debugging.md)
- [Development Overview](https://allhandsai-mh-space.mintlify.app/openhands/usage/developers/development-overview.md): This guide provides an overview of the key documentation resources available in the OpenHands repository. Whether you're looking to contribute, understand the architecture, or work on specific components, these resources will help you navigate the codebase effectively.
- [Evaluation Harness](https://allhandsai-mh-space.mintlify.app/openhands/usage/developers/evaluation-harness.md)
- [WebSocket Connection](https://allhandsai-mh-space.mintlify.app/openhands/usage/developers/websocket-connection.md)
- [FAQs](https://allhandsai-mh-space.mintlify.app/openhands/usage/faqs.md): Frequently asked questions about OpenHands.
- [Key Features](https://allhandsai-mh-space.mintlify.app/openhands/usage/key-features.md)
- [Azure](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/azure-llms.md): OpenHands uses LiteLLM to make calls to Azure's chat models. You can find their documentation on using Azure as a provider [here](https://docs.litellm.ai/docs/providers/azure).
- [Google Gemini/Vertex](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/google-llms.md): OpenHands uses LiteLLM to make calls to Google's chat models. You can find their documentation on using Google as a provider -> [Gemini - Google AI Studio](https://docs.litellm.ai/docs/providers/gemini), [VertexAI - Google Cloud Platform](https://docs.litellm.ai/docs/providers/vertex)
- [Groq](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/groq.md): OpenHands uses LiteLLM to make calls to chat models on Groq. You can find their documentation on using Groq as a provider [here](https://docs.litellm.ai/docs/providers/groq).
- [LiteLLM Proxy](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/litellm-proxy.md): OpenHands supports using the [LiteLLM proxy](https://docs.litellm.ai/docs/proxy/quick_start) to access various LLM providers.
- [Overview](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/llms.md): OpenHands can connect to any LLM supported by LiteLLM. However, it requires a powerful model to work.
- [Local LLMs](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/local-llms.md): When using a Local LLM, OpenHands may have limited functionality. It is highly recommended that you use GPUs to serve local models for optimal experience.
- [Moonshot AI](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/moonshot.md): How to use Moonshot AI models with OpenHands
- [OpenAI](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/openai-llms.md): OpenHands uses LiteLLM to make calls to OpenAI's chat models. You can find their documentation on using OpenAI as a provider [here](https://docs.litellm.ai/docs/providers/openai).
- [OpenHands](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/openhands-llms.md): OpenHands LLM provider with access to state-of-the-art (SOTA) agentic coding models.
- [OpenRouter](https://allhandsai-mh-space.mintlify.app/openhands/usage/llms/openrouter.md): OpenHands uses LiteLLM to make calls to chat models on OpenRouter. You can find their documentation on using OpenRouter as a provider [here](https://docs.litellm.ai/docs/providers/openrouter).
- [Keyword-Triggered Microagents](https://allhandsai-mh-space.mintlify.app/openhands/usage/microagents/microagents-keyword.md): Keyword-triggered microagents provide OpenHands with specific instructions that are activated when certain keywords appear in the prompt. This is useful for tailoring behavior based on particular tools, languages, or frameworks.
- [Organization and User Microagents](https://allhandsai-mh-space.mintlify.app/openhands/usage/microagents/microagents-org.md): Organizations and users can define microagents that apply to all repositories belonging to the organization or user.
- [Microagents Overview](https://allhandsai-mh-space.mintlify.app/openhands/usage/microagents/microagents-overview.md): Microagents are specialized prompts that enhance OpenHands with domain-specific knowledge. They provide expert guidance, automate common tasks, and ensure consistent practices across projects.
- [Global Microagents](https://allhandsai-mh-space.mintlify.app/openhands/usage/microagents/microagents-public.md): Global microagents are [keyword-triggered microagents](/openhands/usage/microagents/microagents-keyword) that apply to all OpenHands users. A list of the current global microagents can be found [in the OpenHands repository](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents).
- [General Microagents](https://allhandsai-mh-space.mintlify.app/openhands/usage/microagents/microagents-repo.md): General guidelines for OpenHands to work more effectively with the repository.
- [Quick Start](https://allhandsai-mh-space.mintlify.app/openhands/usage/quick-start.md): Running OpenHands Cloud or running on your own.
- [CLI](https://allhandsai-mh-space.mintlify.app/openhands/usage/run-openhands/cli-mode.md): The Command-Line Interface (CLI) provides a powerful interface that lets you engage with OpenHands directly from your terminal.
- [OpenHands GitHub Action](https://allhandsai-mh-space.mintlify.app/openhands/usage/run-openhands/github-action.md): This guide explains how to use the OpenHands GitHub Action in your own projects.
- [GUI](https://allhandsai-mh-space.mintlify.app/openhands/usage/run-openhands/gui-mode.md): High level overview of the Graphical User Interface (GUI) in OpenHands.
- [Headless](https://allhandsai-mh-space.mintlify.app/openhands/usage/run-openhands/headless-mode.md): You can run OpenHands with a single command, without starting the web application. This makes it easy to write scripts and automate tasks with OpenHands.
- [Getting Started](https://allhandsai-mh-space.mintlify.app/openhands/usage/run-openhands/local-setup.md): Getting started with running OpenHands on your own.
- [Daytona Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/daytona.md): You can use [Daytona](https://www.daytona.io/) as a runtime provider.
- [Docker Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/docker.md): This is the default Runtime that's used when you start OpenHands.
- [E2B Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/e2b.md): E2B is an open-source secure cloud environment (sandbox) made for running AI-generated code and agents.
- [Local Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/local.md): The Local Runtime allows the OpenHands agent to execute actions directly on your local machine without using Docker. This runtime is primarily intended for controlled environments like CI pipelines or testing scenarios where Docker is not available.
- [Modal Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/modal.md)
- [Overview](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/overview.md): This section is for users that would like to use a runtime other than Docker for OpenHands.
- [Remote Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/remote.md): This runtime is specifically designed for agent evaluation purposes only through the [OpenHands evaluation harness](https://github.com/All-Hands-AI/OpenHands/tree/main/evaluation). It should not be used to launch production OpenHands applications.
- [Runloop Runtime](https://allhandsai-mh-space.mintlify.app/openhands/usage/runtimes/runloop.md): Runloop provides a fast, secure and scalable AI sandbox (Devbox). Check out the [runloop docs](https://docs.runloop.ai/overview/what-is-runloop) for more detail.
- [Model Context Protocol (MCP)](https://allhandsai-mh-space.mintlify.app/openhands/usage/settings/mcp-settings.md): This page outlines how to configure and use the Model Context Protocol (MCP) in OpenHands, allowing you to extend the agent's capabilities with custom tools.
- [Secrets Management](https://allhandsai-mh-space.mintlify.app/openhands/usage/settings/secrets-settings.md): How to manage secrets in OpenHands.
- [Start Building](https://allhandsai-mh-space.mintlify.app/openhands/usage/start-building.md): So you've [run OpenHands](/openhands/usage/quick-start). Now what?
- [Prompting Best Practices](https://allhandsai-mh-space.mintlify.app/openhands/usage/tips/prompting-best-practices.md): When working with OpenHands AI software developer, providing clear and effective prompts is key to getting accurate and useful responses. This guide outlines best practices for crafting effective prompts.
- [Feedback](https://allhandsai-mh-space.mintlify.app/openhands/usage/troubleshooting/feedback.md)
- [Troubleshooting](https://allhandsai-mh-space.mintlify.app/openhands/usage/troubleshooting/troubleshooting.md)
- [Introduction](https://allhandsai-mh-space.mintlify.app/sdk/index.md): A clean, modular SDK for building AI agents. Core agent framework and production-ready tool implementations.
- [Success Stories](https://allhandsai-mh-space.mintlify.app/success-stories/index.md): Real-world examples of what you can achieve with OpenHands

## Optional

- [Company](https://www.all-hands.dev/)
- [Blog](https://www.all-hands.dev/blog)
- [OpenHands Cloud](https://app.all-hands.dev)