mirror of
https://github.com/OpenHands/OpenHands.git
synced 2026-10-07 14:47:53 +08:00
README update (#1124)
Updates README with new screenshots, links, and updated install instructions (using rc11 image) --------- Co-authored-by: Rohit Malhotra <rohitvinodmalhotra@gmail.com> Co-authored-by: Robert Brennan <accounts@rbren.io>
This commit is contained in:
committed by
GitHub
co-authored by
Rohit Malhotra
Robert Brennan
parent
746a8b4a4f
commit
b8079c28d7
@@ -1,37 +1,52 @@
|
||||
# agent-canvas
|
||||
<a name="readme-top"></a>
|
||||
<div align="center">
|
||||
<img src="https://assets.openhands.dev/logo-whitebackground.png" alt="OpenHands logo" width="340">
|
||||
<h1 align="center" style="border-bottom: none">Agent Canvas</h1>
|
||||
<p align="center">
|
||||
<strong>The self-hosted developer control center for coding agents and automations.</strong>
|
||||
</p>
|
||||
<p align="center">
|
||||
Run OpenHands, Claude Code, Codex, Gemini, or any ACP-compatible agent across local, remote, and cloud backends.
|
||||
</p>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://github.com/OpenHands/incubator-program"><img src="https://img.shields.io/badge/status-beta-blue?style=for-the-badge" alt="Project status beta"></a>
|
||||
<a href="https://github.com/OpenHands/agent-canvas/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/OpenHands/agent-canvas/ci.yml?branch=main&style=for-the-badge" alt="CI status"></a>
|
||||
<a href="https://www.npmjs.com/package/@openhands/agent-canvas"><img src="https://img.shields.io/npm/v/%40openhands%2Fagent-canvas?style=for-the-badge&logo=npm" alt="npm version"></a>
|
||||
<a href="https://docs.openhands.dev/openhands/usage/agent-canvas/backends"><img src="https://img.shields.io/badge/Documentation-000?logo=googledocs&logoColor=FFE165&style=for-the-badge" alt="Documentation"></a>
|
||||
<a href="https://go.openhands.dev/slack"><img src="https://img.shields.io/badge/Slack-Join%20the%20community-611f69?logo=slack&logoColor=white&style=for-the-badge" alt="Join us on Slack"></a>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="#quickstart">Quickstart</a> |
|
||||
<a href="./docs/README.md">Docs</a> |
|
||||
<a href="./docs/SELF_HOSTING.md">Self-Hosting</a> |
|
||||
<a href="https://docs.openhands.dev/openhands/usage/agent-canvas/acp-agents">ACP Agents</a> |
|
||||
<a href="https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt-automations">Automations</a> |
|
||||
<a href="https://go.openhands.dev/slack">Slack</a>
|
||||
</div>
|
||||
<p align="center">
|
||||
<img src="https://assets.openhands.dev/screenshot/automation-preview.png" alt="Agent Canvas automation preview" width="100%">
|
||||
</p>
|
||||
<hr>
|
||||
|
||||
> [!WARNING]
|
||||
> This project is in the **Beta** phase. It may be vibecoded, untested, or out of date. OpenHands takes no responsibility for the code or its support. [Learn more](https://github.com/OpenHands/incubator-program).
|
||||
OpenHands Agent Canvas turns your coding agents into a self-hosted, always-on engineering team. It's a developer control center for starting conversations and automating everyday tasks — like generating reports that publish to Slack or automatically decomposing GitHub issues into tasks.
|
||||
|
||||
[](https://github.com/OpenHands/incubator-program)
|
||||
It runs locally on your machine by default, but can connect to multiple “agent backends”, e.g. running agents in Docker containers, on VMs, or within your company infrastructure. You can optionally choose to run agents on OpenHands Cloud or OpenHands Enterprise infrastructure.
|
||||
|
||||
OpenHands is a platform for orchestrating coding agents across different environments. You can:
|
||||
Agent Canvas runs the open source OpenHands agent out-of-the-box, but can use any third-party agent like Claude Code and Codex.
|
||||
|
||||
- ⌨️ prompt agents manually
|
||||
- 🕐 run agents on a schedule
|
||||
- ⚡ trigger agents automatically — e.g. from Slack, GitHub, or Datadog.
|
||||
| | |
|
||||
|---|---|
|
||||
| [**Self-host your way**](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/vm) | Run agents locally, in Docker, on VMs, or anywhere you can run an agent server backend |
|
||||
| [**Switch between different backends**](https://docs.openhands.dev/openhands/usage/agent-canvas/backends) | Switch between local, remote, and cloud agents without losing focus |
|
||||
| [**Create automations**](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt-automations) | Create automations and workflows that integrate with Slack, GitHub, Linear, and more. Run on a schedule or in response to webhook events |
|
||||
| [**Integrate with the tools you use**](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt-automations) | Connect your automations with third-party services like Slack, GitHub, Notion, and more to automate workflows |
|
||||
| [**Bring your own model**](https://docs.openhands.dev/openhands/usage/settings/llm-settings#llm-profiles) | Use with any LLM |
|
||||
| [**Use with any agent**](https://docs.openhands.dev/openhands/usage/agent-canvas/acp-agents) | Use with OpenHands, Claude Code, Codex, Gemini, or any agent with Agent-Client Protocol (ACP). |
|
||||
|
||||
Agents can run anywhere:
|
||||
|
||||
- 🧑💻 on your laptop
|
||||
- 🖥️ on a remote virtual machine
|
||||
- ☁️ in our hosted cloud
|
||||
- 🏢 or inside your company’s infrastructure
|
||||
|
||||
The same Agent Canvas frontend can swap between each of these environments, so you can see everything in one place.
|
||||
|
||||
OpenHands works with any agent harness (e.g. Claude Code, Codex)
|
||||
or connect directly to an LLM (e.g. Anthropic, OpenAI, Gemini, Mistral, Minimax, Kimi).
|
||||
|
||||
If you have questions or feedback, please open a GitHub issue or join the [#proj-agent-canvas channel in Slack](https://openhands.dev/joinslack).
|
||||
|
||||
<img width="1509" height="826" alt="Screenshot 2026-05-11 at 10 13 19 AM" src="https://github.com/user-attachments/assets/71ef41ae-8f6d-4fbf-990f-d672175d93d1" />
|
||||
|
||||
## Project ownership and support
|
||||
|
||||
- **Current status**: Beta.
|
||||
- **Support channel**: [#proj-agent-canvas](https://openhands.dev/joinslack).
|
||||
- **Support level**: Best effort while the project remains in Beta.
|
||||
|
||||
## Quickstart
|
||||
|
||||
@@ -82,7 +97,7 @@ docker run -it --rm \
|
||||
-p 8000:8000 \
|
||||
-v "$HOME/.openhands:/home/openhands/.openhands" \
|
||||
-v "${PROJECTS_PATH}:/projects" \
|
||||
ghcr.io/openhands/agent-canvas:1.0.0-rc.6
|
||||
ghcr.io/openhands/agent-canvas:1.0.0-rc.11
|
||||
```
|
||||
|
||||
**Windows (PowerShell / Windows Terminal):** See [README.windows.md](./README.windows.md) for the equivalent commands.
|
||||
|
||||
+2
-2
@@ -12,7 +12,7 @@ For the main install options and overall context, see [README.md](./README.md).
|
||||
- A host directory for `PROJECTS_PATH` containing the project folders you want the agent to access (create it before starting the container)
|
||||
|
||||
```powershell
|
||||
docker pull ghcr.io/openhands/agent-canvas:1.0.0-rc.6
|
||||
docker pull ghcr.io/openhands/agent-canvas:1.0.0-rc.11
|
||||
|
||||
$env:PROJECTS_PATH = Join-Path $HOME "projects" # directory containing your project folders
|
||||
New-Item -ItemType Directory -Force -Path $env:PROJECTS_PATH, (Join-Path $env:USERPROFILE ".openhands") | Out-Null
|
||||
@@ -21,7 +21,7 @@ docker run -it --rm `
|
||||
-p 8000:8000 `
|
||||
-v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
|
||||
-v "$($env:PROJECTS_PATH):/projects" `
|
||||
ghcr.io/openhands/agent-canvas:1.0.0-rc.6
|
||||
ghcr.io/openhands/agent-canvas:1.0.0-rc.11
|
||||
```
|
||||
|
||||
The agent will be able to access any project under `PROJECTS_PATH`.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
"versions": {
|
||||
"agentServer": "1.28.1",
|
||||
"agentCanvas": "1.0.0-rc.6",
|
||||
"agentCanvas": "1.0.0-rc.11",
|
||||
"automation": "1.0.0a9",
|
||||
"automationSdk": "1.28.1"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user