Project

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

Project

id instance-attribute

id: ProjectID

canonical instance-attribute

canonical: AbsolutePath

vcs class-attribute instance-attribute

vcs: ProjectVcs | None = Field(
    default=None, exclude_if=is_none
)

name class-attribute instance-attribute

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

icon class-attribute instance-attribute

icon: ProjectIcon | None = Field(
    default=None, exclude_if=is_none
)

commands class-attribute instance-attribute

commands: ProjectCommands | None = Field(
    default=None, exclude_if=is_none
)

time instance-attribute

time: ProjectTime

sandboxes instance-attribute

sandboxes: list[str]

ProjectCommands

start class-attribute instance-attribute

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

Startup script to run when creating a new workspace (worktree)

ProjectID module-attribute

ProjectID: TypeAlias = str

ProjectIcon

url class-attribute instance-attribute

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

override class-attribute instance-attribute

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

color class-attribute instance-attribute

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

ProjectTime

created instance-attribute

created: int

updated instance-attribute

updated: int

active instance-attribute

active: int

archived class-attribute instance-attribute

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

ProjectUpdatedEventData

id instance-attribute

id: ProjectID

canonical instance-attribute

canonical: AbsolutePath

vcs class-attribute instance-attribute

vcs: ProjectVcs | None = Field(
    default=None, exclude_if=is_none
)

name class-attribute instance-attribute

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

icon class-attribute instance-attribute

icon: ProjectIcon | None = Field(
    default=None, exclude_if=is_none
)

commands class-attribute instance-attribute

commands: ProjectCommands | None = Field(
    default=None, exclude_if=is_none
)

time instance-attribute

time: ProjectTime

sandboxes instance-attribute

sandboxes: list[str]

ProjectVcs module-attribute

ProjectVcs: TypeAlias = str