Skip to content

Shell

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

ShellCreateResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: ShellInfo

ShellCreatedEventData

info instance-attribute 

info: ShellInfo

ShellDeletedEventData

id instance-attribute 

id: ShellID

ShellExitedEventData

id instance-attribute 

id: ShellID

exit class-attribute instance-attribute 

exit: float | None = Field(default=None, exclude_if=is_none)

status instance-attribute 

status: OpenEnum[
    Literal["running", "exited", "timeout", "killed"]
]

ShellGetResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: ShellInfo

ShellID module-attribute 

ShellID: TypeAlias = str

ShellInfo

id instance-attribute 

id: ShellID

status instance-attribute 

status: OpenEnum[
    Literal["running", "exited", "timeout", "killed"]
]

command instance-attribute 

command: str

cwd instance-attribute 

cwd: str

shell instance-attribute 

shell: str

file instance-attribute 

file: str

pid class-attribute instance-attribute 

pid: int | None = Field(default=None, exclude_if=is_none)

exit class-attribute instance-attribute 

exit: float | None = Field(default=None, exclude_if=is_none)

signal class-attribute instance-attribute 

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

metadata instance-attribute 

metadata: dict[str, Any]

time instance-attribute 

time: ShellInfoTime

ShellInfoTime

started instance-attribute 

started: float

Start time in milliseconds since the Unix epoch

completed class-attribute instance-attribute 

completed: float | None = Field(
    default=None, exclude_if=is_none
)

ShellListResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: list[ShellInfo]

ShellOutputResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: ShellOutputResponseData

ShellOutputResponseData

output instance-attribute 

output: str

cursor instance-attribute 

cursor: int

size instance-attribute 

size: int

truncated instance-attribute 

truncated: bool