Skip to content

PTY

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

Pty

id instance-attribute

id: PtyID

title instance-attribute

title: str

command instance-attribute

command: str

args instance-attribute

args: list[str]

cwd instance-attribute

cwd: str

status instance-attribute

status: OpenEnum[Literal['running', 'exited']]

pid instance-attribute

pid: int

exit_code class-attribute instance-attribute

exit_code: int | None = Field(
    default=None,
    validation_alias="exitCode",
    serialization_alias="exitCode",
    exclude_if=is_none,
)

PtyConnectTokenResponse

location instance-attribute

data instance-attribute

PtyCreateResponse

location instance-attribute

data instance-attribute

data: Pty

PtyCreatedEventData

info instance-attribute

info: Pty

PtyDeletedEventData

id instance-attribute

id: PtyID

PtyExitedEventData

id instance-attribute

id: PtyID

exit_code class-attribute instance-attribute

exit_code: int = Field(
    validation_alias="exitCode",
    serialization_alias="exitCode",
)

PtyGetResponse

location instance-attribute

data instance-attribute

data: Pty

PtyID module-attribute

PtyID: TypeAlias = str

PtyListResponse

location instance-attribute

data instance-attribute

data: list[Pty]

PtyTicketConnectToken

ticket instance-attribute

ticket: str

expires_in instance-attribute

expires_in: int

PtyUpdateResponse

location instance-attribute

data instance-attribute

data: Pty

PtyUpdateSize

rows instance-attribute

rows: int

cols instance-attribute

cols: int

PtyUpdatedEventData

info instance-attribute

info: Pty