runner

runner

Agent

backend instance-attribute

backend: SkipValidation[AgentBackend]

capabilities class-attribute instance-attribute

capabilities: list[object] = Field(default_factory=list)

env class-attribute instance-attribute

env: dict[str, str] = Field(default_factory=dict)

instructions class-attribute instance-attribute

instructions: str | None = None

mcp_servers class-attribute instance-attribute

mcp_servers: list[MCPServer] = Field(default_factory=list)

metadata class-attribute instance-attribute

metadata: dict[str, str] = Field(default_factory=dict)

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute

name: str

permission class-attribute instance-attribute

permission: PermissionPolicy | None = None

skills class-attribute instance-attribute

skills: list[Skill] = Field(default_factory=list)

strict class-attribute instance-attribute

strict: bool = True

MaterialiseContext

metadata class-attribute instance-attribute

metadata: dict[str, Any] = Field(default_factory=dict)

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

sandbox instance-attribute

sandbox: Any

workspace instance-attribute

workspace: Path

PermissionPolicy

default class-attribute instance-attribute

default: PermissionAction | None = None

tools class-attribute instance-attribute

tools: dict[str, PermissionRule] = Field(
    default_factory=dict
)

to_opencode

to_opencode() -> (
    PermissionAction | dict[str, PermissionRule]
)

RunConfig

attachments class-attribute instance-attribute

attachments: list[Path] = Field(default_factory=list)

continue_last class-attribute instance-attribute

continue_last: bool = False

env class-attribute instance-attribute

env: dict[str, str] = Field(default_factory=dict)

extra_args class-attribute instance-attribute

extra_args: list[str] = Field(default_factory=list)

fork_session class-attribute instance-attribute

fork_session: bool = False

forward_env class-attribute instance-attribute

forward_env: list[str] = Field(default_factory=list)

json_events class-attribute instance-attribute

json_events: bool = False

metadata class-attribute instance-attribute

metadata: dict[str, Any] = Field(default_factory=dict)

network class-attribute instance-attribute

network: str | None = None

output_schema class-attribute instance-attribute

output_schema: Path | dict[str, Any] | None = None

permission class-attribute instance-attribute

permission: PermissionPolicy | None = None

remove_on_exit class-attribute instance-attribute

remove_on_exit: bool = True

resume_session_id class-attribute instance-attribute

resume_session_id: str | None = None

secret_env class-attribute instance-attribute

secret_env: list[str] = Field(default_factory=list)

secrets class-attribute instance-attribute

secrets: list[str] = Field(default_factory=list)

stream_events class-attribute instance-attribute

stream_events: bool = False

stream_output class-attribute instance-attribute

stream_output: bool = False

timeout_seconds class-attribute instance-attribute

timeout_seconds: int | None = None

RunResult

agent_backend instance-attribute

agent_backend: str

agent_name instance-attribute

agent_name: str

artifacts class-attribute instance-attribute

artifacts: list[Artifact] = Field(default_factory=list)

command instance-attribute

command: list[str]

diff class-attribute instance-attribute

diff: str | None = None

duration_ms class-attribute instance-attribute

duration_ms: int | None = None

events class-attribute instance-attribute

events: list[dict[str, Any]] = Field(default_factory=list)

metadata class-attribute instance-attribute

metadata: dict[str, Any] = Field(default_factory=dict)

output instance-attribute

output: str

returncode instance-attribute

returncode: int

sandbox_backend instance-attribute

sandbox_backend: str

sandbox_name class-attribute instance-attribute

sandbox_name: str | None = None

session_id class-attribute instance-attribute

session_id: str | None = None

stderr instance-attribute

stderr: str

stdout instance-attribute

stdout: str

thread_id class-attribute instance-attribute

thread_id: str | None = None

usage class-attribute instance-attribute

usage: dict[str, Any] | None = None

from_parts classmethod

from_parts(
    *,
    agent_name: str,
    agent_backend: str,
    sandbox_backend: str,
    sandbox_name: str | None,
    command_result: CommandResult,
    artifacts: RunArtifacts,
    events: list[dict[str, Any]] | None = None,
) -> RunResult

Runner

Runner(
    agent: Agent,
    *,
    sandbox: SandboxBackend,
    run_config: RunConfig | None = None,
    default_prompt: str | None = None,
)

agent instance-attribute

agent = agent

default_prompt instance-attribute

default_prompt = default_prompt

run_config instance-attribute

run_config = run_config

run_sync instance-attribute

run_sync: Any

sandbox instance-attribute

sandbox = sandbox

SandboxBackend

id instance-attribute

id: str

name instance-attribute

name: str | None

cleanup

cleanup(session: SandboxSession) -> None

Stop/remove sandbox if configured.

collect

collect(session: SandboxSession) -> RunArtifacts

Collect diff, logs, output files.

prepare

prepare(
    agent: AgentLike, run_config: RunConfigLike | None
) -> SandboxSession

Create workspace, worktree, sandbox, pod, etc.

run

run(
    session: SandboxSession, command: list[str]
) -> CommandResult

Execute command inside sandbox.

_RunSyncDescriptor

_parse_json_events

_parse_json_events(output: str) -> list[dict[str, Any]]