Skip to content
dbx tools

Variable: sshProjectTerminalResponseSchema

const sshProjectTerminalResponseSchema: ZodObject<{ project: ZodObject<{ directory: ZodString; error: ZodOptional<ZodString>; id: ZodString; machineId: ZodString; name: ZodString; openUrl: ZodOptional<ZodString>; path: ZodString; port: ZodNumber; state: ZodEnum<{ error: "error"; ready: "ready"; starting: "starting"; stopped: "stopped"; }>; stripPrefix: ZodBoolean; }, $strict>; service: ZodObject<{ error: ZodOptional<ZodString>; kind: ZodEnum<{ desktop: "desktop"; stats: "stats"; terminal: "terminal"; }>; openUrl: ZodString; path: ZodString; state: ZodEnum<{ error: "error"; ready: "ready"; starting: "starting"; stopped: "stopped"; }>; }, $strict>; }, $strict>

sshProjectTerminalResponse fields

Section titled “sshProjectTerminalResponse fields”

Project terminal response.

  • project: Project opened in the terminal.
  • project.id: Stable identifier for the Sandbox project.
  • project.name: Project display name.
  • project.machineId: Machine that hosts the project.
  • project.directory: Project directory below the Sandbox user’s home.
  • project.path: AppKit path that exposes the project server.
  • project.openUrl (optional): AppKit URL opened by project links, including any configured entry page.
  • project.port: Loopback HTTP port reserved for the project.
  • project.stripPrefix: Whether the registered AppKit path is removed before forwarding.
  • project.state: Current project route state.
  • project.error (optional): Latest forwarding failure.
  • service: DinoTTY service containing the new project tab.
  • service.kind: Service type.
  • service.path: Stable AppKit path for the service.
  • service.openUrl: AppKit URL that opens the service at its intended entry page.
  • service.state: Current service provisioning state.
  • service.error (optional): Latest service provisioning failure.