Persistent PTY

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

PersistentPtyAddedEventData

session_id class-attribute instance-attribute

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

terminal instance-attribute

terminal: PersistentPtyInfo

PersistentPtyHandoff

directory instance-attribute

directory: str

instance_id class-attribute instance-attribute

instance_id: str = Field(
    validation_alias="instanceID",
    serialization_alias="instanceID",
)

ticket instance-attribute

ticket: str

expires_at class-attribute instance-attribute

expires_at: (
    float
    | OpenEnum[Literal["Infinity", "-Infinity", "NaN"]]
) = Field(
    validation_alias="expiresAt",
    serialization_alias="expiresAt",
)

PersistentPtyInfo

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,
)

session_id class-attribute instance-attribute

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

foreground_process class-attribute instance-attribute

foreground_process: str | None = Field(
    validation_alias="foregroundProcess",
    serialization_alias="foregroundProcess",
)

size instance-attribute

size: PersistentPtyInfoSize

output instance-attribute

output: PersistentPtyInfoOutput

PersistentPtyInfoOutput

head instance-attribute

head: int

tail instance-attribute

tail: int

PersistentPtyInfoSize

cols instance-attribute

cols: int

rows instance-attribute

rows: int

PersistentPtyReadLines module-attribute

PersistentPtyReadLines: TypeAlias = int

PersistentPtyReadResult

pty_id class-attribute instance-attribute

pty_id: PtyID = Field(
    validation_alias="ptyID", serialization_alias="ptyID"
)

title instance-attribute

title: str

cwd instance-attribute

cwd: str

foreground_process class-attribute instance-attribute

foreground_process: str | None = Field(
    validation_alias="foregroundProcess",
    serialization_alias="foregroundProcess",
)

screen instance-attribute

screen: PersistentPtyReadResultScreen

PersistentPtyReadResultScreen

text instance-attribute

text: str

cols instance-attribute

cols: int

rows instance-attribute

rows: int

cursor instance-attribute

cursor: PersistentPtyReadResultScreenCursor

PersistentPtyReadResultScreenCursor

x instance-attribute

x: int

y instance-attribute

y: int

PersistentPtyRemovedEventData

session_id class-attribute instance-attribute

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

pty_id class-attribute instance-attribute

pty_id: PtyID = Field(
    validation_alias="ptyID", serialization_alias="ptyID"
)

PersistentPtySnapshot

info instance-attribute

info: PersistentPtyInfo

text instance-attribute

text: str

checkpoint instance-attribute

checkpoint: bytes

cursor instance-attribute

cursor: PersistentPtySnapshotCursor

PersistentPtySnapshotCursor

x instance-attribute

x: int

y instance-attribute

y: int