Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
{
"tab": "Docs",
"pages": [
"openhands/usage/introduction",
"index",
"openhands/usage/quick-start",
"openhands/usage/start-building",
"openhands/usage/key-features",
Expand Down Expand Up @@ -244,7 +244,6 @@
{ "source": "/openhands/usage/how-to/development-overview", "destination": "/openhands/usage/developers/development-overview" },
{ "source": "/openhands/usage/how-to/evaluation-harness", "destination": "/openhands/usage/developers/evaluation-harness" },
{ "source": "/openhands/usage/how-to/websocket-connection", "destination": "/openhands/usage/developers/websocket-connection" },
{ "source": "/openhands", "destination": "/openhands/usage/introduction" },
{ "source": "/openhands/usage/prompting/microagents-keyword", "destination": "/openhands/usage/microagents/microagents-keyword" },
{ "source": "/openhands/usage/prompting/microagents-org", "destination": "/openhands/usage/microagents/microagents-org" },
{ "source": "/openhands/usage/prompting/microagents-overview", "destination": "/openhands/usage/microagents/microagents-overview" },
Expand Down
113 changes: 112 additions & 1 deletion index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ 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.

Use AI to tackle the toil in your backlog. OpenHands has all the same tools as a human developer:
it can modify code, run commands, browse the web, call APIs, and yes-even copy code snippets from StackOverflow.

<iframe
className="w-full aspect-video"
Expand All @@ -14,3 +16,112 @@ Use AI to tackle the toil in your backlog. Our agents have all the same tools as
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

## Integrations

<Columns cols={3}>
<Card
title="Version Control Tools"
href="/openhands/usage/cloud/github-installation"
>
OpenHands can work directly with your GitHub, GitLab and Bitbucket repositories.
</Card>
<Card
title="Slack"
href="/openhands/usage/cloud/slack-installation"
>
Summon OpenHands directly to do work based on conversations in Slack!
</Card>
<Card
title="Project Management Tools"
href="/openhands/usage/cloud/project-management/overview"
>
Ask OpenHands to help you manage your projects on your favorite project management tooling.
</Card>
</Columns>

## Flexibility in Running OpenHands

<Columns cols={1}>
<Card
title="OpenHands Cloud"
href="/openhands/usage/cloud/openhands-cloud"
>
Jump right into it with OpenHands Cloud!
</Card>
<Card
title="Run the GUI Locally"
href="/openhands/usage/run-openhands/local-setup"
>
Run the full OpenHands GUI locally.
</Card>
<Card
title="OpenHands CLI"
href="/openhands/usage/run-openhands/cli-mode"
>
Use OpenHands CLI and directly work on your repositories from your terminal!
</Card>
<Card
title="Headless"
href="/openhands/usage/run-openhands/headless-mode"
>
Automate tasks and write scripts using the headless mode.
</Card>
</Columns>

## Extend OpenHands' Capabilities

<Columns cols={3}>
<Card
title="MCP Support"
href="/openhands/usage/settings/mcp-settings"
>
Add MCP servers to interact with your favorite every day tools.
</Card>
<Card
title="Add Tavily Search Engine"
href="/openhands/usage/advanced/search-engine-setup"
>
Add Tavily as a search engine and let OpenHands search the web for information when needed!
</Card>
<Card
title="Custom Sandbox"
href="/openhands/usage/advanced/custom-sandbox-guide"
>
Use your own custom docker image as a sandbox for OpenHands .
</Card>
</Columns>

## Customize OpenHands to Your Repository

<Columns cols={2}>
<Card
title="Microagents"
href="/openhands/usage/microagents/microagents-overview"
>
Create specialized prompts to enhance OpenHands with specific knowledge.
</Card>
<Card
title="Setup Scripts"
href="/openhands/usage/customization/repository#setup-script"
>
Add initialization scripts that run every time OpenHands starts work on your repository.
</Card>
</Columns>

## Community

<Columns cols={2}>
<Card
title="Slack Server"
href="https://all-hands.dev/joinslack"
>
OpenHands has an active community on Slack.
</Card>
<Card
title="Create GitHub Issues"
href="https://github.com/All-Hands-AI/OpenHands/issues"
>
Report and look for issues in Github.
</Card>
</Columns>
8 changes: 7 additions & 1 deletion openhands/usage/advanced/search-engine-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ description: Configure OpenHands to use Tavily as a search engine.

## Setting Up Search Engine in OpenHands

OpenHands can be configured to use [Tavily](https://tavily.com/) as a search engine, which allows the agent to search the web for information when needed. This capability enhances the agent's ability to provide up-to-date information and solve problems that require external knowledge.
OpenHands can be configured to use [Tavily](https://tavily.com/) as a search engine, which allows the agent to
search the web for information when needed. This capability enhances the agent's ability to provide up-to-date
information and solve problems that require external knowledge.

<Note>
Tavily is configured as a search engine by default in OpenHands Cloud!
</Note>

### Getting a Tavily API Key

Expand Down
2 changes: 1 addition & 1 deletion openhands/usage/faqs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: FAQs
description: Frequently asked questions about OpenHands
description: Frequently asked questions about OpenHands.
icon: question
---

Expand Down
17 changes: 0 additions & 17 deletions openhands/usage/introduction.mdx

This file was deleted.