Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenHands is All-Hands’ agent SDK for autonomous software engineering. It models a Workspace and a Terminal tool, Mirage ships drop-in implementations of both so the agent operates entirely inside a Mirage workspace.

​
Install

uv add 'mirage-ai[openhands]'
This pulls in openhands-sdk>=1.18.0 and openhands-tools>=1.18.0.

​
Usage

import os
from openhands.sdk import LLM, Agent, Conversation, Tool

from mirage import MountMode, Workspace
from mirage.agents.openhands import MirageWorkspace, register_mirage_terminal
from mirage.resource.ram import RAMResource

ws = Workspace({"/": RAMResource()}, mode=MountMode.WRITE)

llm = LLM(
    model=os.getenv("LLM_MODEL", "anthropic/claude-sonnet-4-6"),
    api_key=os.getenv("LLM_API_KEY"),
)

with MirageWorkspace(workspace=ws, working_dir="/") as mirage_ws:
    tool_name = register_mirage_terminal(mirage_ws)
    agent = Agent(
        llm=llm,
        tools=[Tool(name=tool_name)],
        system_message=ws.file_prompt,
    )
    conversation = Conversation(agent=agent, workspace=mirage_ws)
    conversation.send_message("Create /hello.txt with 'hi' and ls /.")
    conversation.run()

​
Exports

SymbolPurpose
MirageWorkspaceOpenHands Workspace implementation backed by a Mirage workspace.
MirageTerminalExecutorTerminal executor that pipes through Workspace.execute().
register_mirage_terminalRegisters the Mirage terminal tool so the agent can Tool(name=...) it.

​
Examples