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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@
{
"group": "Release Notes",
"pages": [
"openhands/usage/agent-canvas/release-notes/v1.23.0",
"openhands/usage/agent-canvas/release-notes/v1.22.0",
"openhands/usage/agent-canvas/release-notes/v1.21.0",
"openhands/usage/agent-canvas/release-notes/v1.20.0",
Expand Down
4 changes: 3 additions & 1 deletion openhands/usage/agent-canvas/conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Child Conversations

When an agent uses `launch_child_conversation`, Agent Canvas can launch a child conversation on a local or Cloud target. Local children can use either an isolated worktree or the parent's shared workspace. Cloud children use the repository and branch selected for the launch.

Check warning on line 10 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L10

Did you really mean 'worktree'?

The child remains linked to its parent, and its result is returned to the parent conversation. Agent Canvas validates the launch inputs before creating the child conversation.

Expand All @@ -15,9 +15,9 @@

Use the conversation list controls to manage automation runs and visible tags:

- Choose `All`, `Hide`, or `Only` to include, exclude, or show only automation-run conversations. You can further select individual automation names, including unnamed automations.

Check warning on line 18 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L18

Did you really mean 'automations'?
- Pinned conversations remain visible when automation-run filtering would otherwise hide them.
- Enable the `Tags` preference to show conversation tag chips. Tags are off by default; when there are more tags than fit, Agent Canvas shows a `+N` chip with the remaining count.
- Enable the `Tags` preference to show conversation tag chips. Tags are off by default. Each chip shows the tag key and value as a `Key: value` pair, such as `Artifacts: 1`. When there are more tags than fit, Agent Canvas shows a `+N` chip with the remaining count.

Agent Canvas omits reserved tags and raw automation IDs from the chips. LLM metadata is also hidden by default.

Expand All @@ -29,17 +29,19 @@

If a message fails to send, select `Retry` to send it again or `Dismiss` to remove the failed message bubble. Dismissing a message does not restore its text to the composer.

A "Failed to send" bubble can appear while the connection is slow or reconnecting. Once the server confirms the message and it appears in the conversation, Agent Canvas clears the stale bubble automatically. Select `Retry` only if the message never arrives.

## Inline Markdown Artifact Previews

When an agent creates a Markdown file, Agent Canvas renders it inline as a height-limited rich preview with an internal scrollbar instead of showing only the raw file content. Select `View` to open the full file in the Files drawer.

Check warning on line 36 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L36

Did you really mean 'scrollbar'?

## Image Attachments

When you upload an image as part of a message or an image is produced in a conversation, Agent Canvas displays it as a thumbnail. Click the thumbnail to open the image full size in a lightbox overlay. Dismiss the lightbox by pressing Escape, clicking the close button, or clicking the backdrop.

Check warning on line 40 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L40

Did you really mean 'lightbox'?

Check warning on line 40 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L40

Did you really mean 'lightbox'?

## Conversation Overview Panel

The conversation overview panel displays project context for the active conversation, including workspace information, git state, and loaded resources such as skills, MCP servers, and automations.

Check warning on line 44 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L44

Did you really mean 'automations'?

Toggle the overview using the info control in the conversation header. The panel peeks beside the chat area and closes when you open the Files drawer.

Expand All @@ -54,9 +56,9 @@

### Files View

The **Files** tab is a focused file browser with open-file tabs and close controls. The file tree is resizable and persists its state across refreshes.

Check warning on line 59 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L59

Did you really mean 'resizable'?

Above the file tree, the active workspace path is displayed with a copy button. Hover the truncated path to see the full value in a tooltip, then click to copy it.

Check warning on line 61 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L61

Did you really mean 'tooltip'?

<Note>
The workspace path row is hidden when the conversation has no working directory.
Expand Down Expand Up @@ -188,7 +190,7 @@

## Archive a Conversation

Archiving a conversation hides it from the sidebar list without deleting it. The conversation's full history stays on the backend, and you can unarchive it at any time.

Check warning on line 193 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L193

Did you really mean 'unarchive'?

**To archive a conversation:**

Expand All @@ -210,7 +212,7 @@
</Note>

<Note>
After an installation switches from host-local conversation runtimes to Docker runtimes, conversations created under the previous local runtime have no Docker provisioning identity. Agent Canvas presents these conversations as archived. Their persisted event history remains readable, and Agent Canvas does not open a WebSocket connection for them.

Check warning on line 215 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L215

Did you really mean 'runtimes'?

Check warning on line 215 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L215

Did you really mean 'runtimes'?
</Note>

## Related Guides
Expand Down
11 changes: 11 additions & 0 deletions openhands/usage/agent-canvas/managing-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
title: Managing automations

Check warning on line 2 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L2

Did you really mean 'automations'?
description: Browse, export, import, enable, disable, and run automations from the Agent Canvas Automate view.

Check warning on line 3 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L3

Did you really mean 'automations'?
---

The **Automate** view in Agent Canvas is the in-app control center for your automations. From here you can see all automations on the active backend, inspect their configuration and run history, and manage their lifecycle without leaving the app.

Check warning on line 6 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L6

Did you really mean 'automations'?

Check warning on line 6 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L6

Did you really mean 'automations'?

<Note>
Automations run on the active backend. Switch backends from [Connect and Manage Backends](/openhands/usage/agent-canvas/backends) to see automations on a different backend.

Check warning on line 9 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L9

Did you really mean 'Automations'?

Check warning on line 9 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L9

Did you really mean 'automations'?
</Note>

## Browse and inspect automations

Check warning on line 12 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L12

Did you really mean 'automations'?

Open the **Automate** tab in the sidebar to see all automations on the active backend. Each row shows the automation name, trigger type, and enabled state. When the active backend is healthy but has no automations, the Automate pane remains available and includes an option to add one.

Check warning on line 14 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L14

Did you really mean 'automations'?

Check warning on line 14 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L14

Did you really mean 'automations'?

Click an automation to open its detail view. The detail view shows:

- The full prompt the automation runs
- The automation's script, for automations that run a script bundle instead of a prompt

Check warning on line 19 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L19

Did you really mean 'automations'?
- Trigger configuration (schedule, webhook, or event)
- LLM profile used for runs
- Recent run history and status
Expand All @@ -28,15 +29,25 @@

Automation runs surface a live **phase** that reflects a run's current state: `PENDING`, `RUNNING`, or `FAILED`. The phase appears on automation cards, in the Activity Log, and on the home screen, and updates live as a run progresses. A failed run retains its last phase after it stops.

### Script Automation Run Logs

An automation that runs a script bundle executes its entrypoint directly instead of starting a conversation. For these runs, the run record has no conversation. Use **View logs** on the run to read the script's output; Agent Canvas resolves the logs from the run's sandbox on cloud backends. A run that executed a script shows `No conversation — this run executed a script. Use View logs for its output.` instead of `No Conversation`.

<Note>
On cloud backends, a run's sandbox is deleted shortly after the run finishes unless the backend keeps it for a cleanup delay. Once the sandbox is gone, the logs are no longer available and the run shows a deleted-sandbox message. Open **View logs** while the run is in progress to read its output.
</Note>

To see what a script automation runs, open its detail view and read the **Script** section, which replaces the prompt section for prompt-less automations and lists the bundle's files.

Check warning on line 40 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L40

Did you really mean 'automations'?

### Activity Log Costs and Exports

The Activity Log displays a completed run's reported LLM cost in USD to four decimal places. A measured zero cost appears as `$0.0000`; when the backend does not report a cost, no cost appears in the log.

Use the Activity Log export controls to download run data as CSV or JSON. Both formats include a raw numeric `cost` field for every run, as well as the run's `phase`. An unavailable cost is exported as `null`.

## Enable and disable automations

Check warning on line 48 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L48

Did you really mean 'automations'?

Toggle an automation on or off from the kebab menu (⋮) on the automation row, or from the detail view. Disabled automations do not fire on their scheduled trigger or in response to events, but their configuration is preserved.

Check warning on line 50 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L50

Did you really mean 'automations'?

### Disablement reasons

Expand Down Expand Up @@ -112,7 +123,7 @@

5. Confirm to create the automation.

Imported automations are created **disabled**. After importing, open the automation from the list, review its configuration, and enable it when ready.

Check warning on line 126 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L126

Did you really mean 'automations'?

## Related guides

Expand Down
33 changes: 33 additions & 0 deletions openhands/usage/agent-canvas/release-notes/v1.23.0.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Agent Canvas 1.23.0
description: Release notes for Agent Canvas version 1.23.0
---

# Agent Canvas 1.23.0

Released September 23, 2026.

[View the full release on GitHub](https://github.com/OpenHands/OpenHands/releases/tag/v1.23.0).

## Highlights

- **Universal macOS desktop installer** — The macOS desktop build is now a single universal disk image that runs on both Apple silicon and Intel Macs, with bundled `uv` and Node.js runtimes selected per architecture. See [Desktop App (Preview Build)](/openhands/usage/agent-canvas/setup#desktop-app-preview-build).

Check warning on line 14 in openhands/usage/agent-canvas/release-notes/v1.23.0.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/release-notes/v1.23.0.mdx#L14

Did you really mean 'runtimes'?
- **Light and Solarized color themes** — Agent Canvas adds `Light+` and `Solarized Light` themes to the `Settings > Application` color-theme setting. See [Customize and Settings](/openhands/usage/agent-canvas/customize-and-settings).

Check warning on line 15 in openhands/usage/agent-canvas/release-notes/v1.23.0.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/release-notes/v1.23.0.mdx#L15

Did you really mean 'Solarized'?

## Fixes

- Script (bundle) automation runs now load their logs on cloud backends, and the automation detail view shows the automation's script in a **Script** section. See [Managing Automations](/openhands/usage/agent-canvas/managing-automations#script-automation-run-logs).
- A "Failed to send" bubble now clears on its own once the server confirms the message, instead of persisting after a delayed or reconnected delivery. See [Conversations](/openhands/usage/agent-canvas/conversations#handle-a-failed-message).
- Conversation tag chips now show the tag key and value as a `Key: value` pair, such as `Artifacts: 1`. See [Conversations](/openhands/usage/agent-canvas/conversations#conversation-list-controls).
- Restored the 11px mode label on the change-agent button.
- Historical Markdown messages that have not changed are no longer re-rendered, reducing work while scrolling a long conversation.

## Maintenance

- Released agent runtime dependencies bumped: SDK, Agent Server, and TypeScript client 1.49.5, Automation 1.15.0.
- Removed merged PR artifacts from `main`.

## Full Changelog

- [GitHub release notes](https://github.com/OpenHands/OpenHands/releases/tag/v1.23.0)
- [Compare v1.22.0 to v1.23.0](https://github.com/OpenHands/OpenHands/compare/v1.22.0...v1.23.0)
6 changes: 3 additions & 3 deletions openhands/usage/agent-canvas/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
description: Install, run, update, or uninstall Agent Canvas.
---

The `agent-canvas` launcher can run the Canvas client with Agent Server, Automation Server, and ingress as an all-in-one local stack. Use npm or npx for direct local execution, or Docker for a containerized stack with explicit project mounts. You can also run the client separately and connect it to an existing backend.

Check warning on line 6 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L6

Did you really mean 'npx'?

<Warning>
Treat agents and ACP processes as untrusted: they can run shell commands, read files, write files, and use connected tools within their execution environment. Agent Canvas is the client and does not provide isolation. If the backend runs directly on your machine, the agent can act with your user account's permissions. Use a container, sandbox, or VM to define a tighter boundary. Before exposing backend services to a network you do not control, review [VM / Self-Hosted Installation](/openhands/usage/agent-canvas/backend-setup/vm).

Check warning on line 9 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L9

Did you really mean 'untrusted'?
</Warning>

## Choose An Install Method
Expand All @@ -15,12 +15,12 @@
|--------|-------------|---------------------------|
| **npm local install** | You want the quickest local browser setup. | Runs directly on your machine and can work in local workspaces you open. |
| **Docker** | You want a local sandbox with clearer file boundaries. | Runs inside a container and can access mounted project directories. |
| **npx** | You want to try Agent Canvas without installing the package globally. | Runs directly on your machine and can work in local workspaces you open. |

Check warning on line 18 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L18

Did you really mean 'npx'?
| **VM / self-hosted** | You want an always-on backend, stronger hardware, or a team-accessible server. | Runs on the VM or dedicated host you configure. |
| **From source** | You are contributing to Agent Canvas or changing the frontend/backend stack. | Runs your local development checkout. |

<Note>
If you are new to Agent Canvas, use `npx` for a quick first run or npm local install if you want a reusable `agent-canvas` command. Use Docker when you specifically want sandboxing.

Check warning on line 23 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L23

Did you really mean 'sandboxing'?
</Note>

## Verify Prerequisites
Expand Down Expand Up @@ -65,7 +65,7 @@
</Tabs>

<Note>
Termux and other mobile Linux environments are not a primary supported target. For the most reliable local setup, use macOS, Linux, Windows with PowerShell, or Windows with WSL2.

Check warning on line 68 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L68

Did you really mean 'Termux'?
</Note>

## Install And Run
Expand Down Expand Up @@ -121,7 +121,7 @@
PowerShell uses backticks (`` ` ``) for line continuation. If Docker reports that it cannot connect to the daemon, start Docker Desktop and run the command again.
</Note>
</Tab>
<Tab title="npx">

Check warning on line 124 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L124

Did you really mean 'npx'?
Run the latest published package without installing it globally:

```bash
Expand Down Expand Up @@ -308,7 +308,7 @@

## Desktop App (Preview Build)

The Agent Canvas desktop app for macOS, Windows, and Linux is an early preview build ready for user testing. It bundles the Node.js and `uv` runtimes, so you do not need to install prerequisites or keep a terminal open.

Check warning on line 311 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L311

Did you really mean 'runtimes'?

<Note>
Please [join the OpenHands Slack community](https://openhands.dev/joinslack) to share feedback and [open an issue](https://github.com/OpenHands/OpenHands/issues) for problems you find while testing the preview.
Expand All @@ -318,13 +318,13 @@

Download the installer for your operating system from the [OpenHands releases page](https://github.com/OpenHands/OpenHands/releases).

**macOS (Apple silicon)**
**macOS**

1. Download the `Agent-Canvas-<version>-arm64.dmg` file.
1. Download the `Agent-Canvas-<version>-universal.dmg` file.
2. Open the disk image and drag **Agent Canvas** to **Applications**.
3. Launch Agent Canvas from Applications.

Pre-built desktop releases support Apple silicon Macs. On an Intel Mac, use the npm or [from-source](#install-and-run) installation method.
The universal disk image runs on both Apple silicon and Intel Macs, and bundles the `uv` and Node.js runtimes for each architecture. You do not need a separate install method on an Intel Mac.

Check warning on line 327 in openhands/usage/agent-canvas/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/setup.mdx#L327

Did you really mean 'runtimes'?

**Windows**

Expand Down
Loading