Skip to content

TUI

4 types. Import any of them from opencode.types.

TuiCommandExecuteEventData

command instance-attribute

command: (
    OpenEnum[
        Literal[
            "session.list",
            "session.new",
            "session.interrupt",
            "session.background",
            "session.compact",
            "session.page.up",
            "session.page.down",
            "session.line.up",
            "session.line.down",
            "session.half.page.up",
            "session.half.page.down",
            "session.first",
            "session.last",
            "prompt.clear",
            "prompt.submit",
            "agent.cycle",
        ]
    ]
    | str
)

TuiPromptAppendEventData

text instance-attribute

text: str

TuiSessionSelectEventData

session_id class-attribute instance-attribute

session_id: SessionID = Field(
    validation_alias="sessionID",
    serialization_alias="sessionID",
)

TuiToastShowEventData

title class-attribute instance-attribute

title: str | None = Field(default=None, exclude_if=is_none)

message instance-attribute

message: str

variant instance-attribute

variant: OpenEnum[
    Literal["info", "success", "warning", "error"]
]

duration class-attribute instance-attribute

duration: int | None = None