Orca is the place for working with a fleet of agents (e.g. Grok Bot, Claude Code). Run any coding agent with your own subscription. Available on desktop, mobile and remote runtime.
TypeScript adeagent-ideai-agentsautomationbotclaude-codecodexghosttygrok-bothermes-agentmobile-appmuseopenclawopencodeorchestrationpiruntimeterminalworktreesyc-backed
import type { OrcaHooks } from '../../shared/orca-yaml-hook-types'
import type { PublicKnownRuntimeEnvironment } from '../../shared/runtime-environments'
import type { EphemeralVmRecipeDoctorResult } from '../../shared/ephemeral-vm-recipes'
import type { EphemeralVmRecipeResultWarning } from '../../shared/ephemeral-vm-recipe-diagnostics'
import type { EphemeralVmRuntimeRecord } from '../../shared/ephemeral-vm-runtimes'
import type { EphemeralVmFailure } from '../../shared/ephemeral-vm-failure-copy'
export type EphemeralVmApi = {
listRecipes: (args: { repoId: string }) => Promise<{
status: 'ok' | 'error'
repoPath: string | null
recipes: OrcaHooks['environmentRecipes']
diagnostics: NonNullable<OrcaHooks['environmentRecipeDiagnostics']>
message?: string
messageCode?: string
messageParams?: Record<string, string | number>
}>
listRecipeCatalog: () => Promise<
{
repoId: string
repoName: string
repoPath: string
recipes: NonNullable<OrcaHooks['environmentRecipes']>
diagnostics: NonNullable<OrcaHooks['environmentRecipeDiagnostics']>
}[]
>
doctor: (args: { repoId: string; recipeId: string }) => Promise<EphemeralVmRecipeDoctorResult>
provision: (args: {
repoId: string
recipeId: string
workspaceName?: string
projectId?: string
workspaceId?: string
branch?: string
ref?: string
provisionId?: string
}) => Promise<
| {
ok: true
connectionType: 'orca-server'
runtime: EphemeralVmRuntimeRecord
environment: PublicKnownRuntimeEnvironment
stderr: string
warnings: EphemeralVmRecipeResultWarning[]
}
| {
ok: true
connectionType: 'ssh'
runtime: EphemeralVmRuntimeRecord
sshTargetId: string
/** The managed Orca server the host runs; its workspace lives there. */
environmentId?: string
expectedRefHead?: string
stderr: string
warnings: EphemeralVmRecipeResultWarning[]
}
| ({ ok: false; stderr: string; stdout: string } & EphemeralVmFailure)
>
cancelProvision: (args: { provisionId: string }) => Promise<{ cancelled: boolean }>
onProvisionEvent: (
callback: (event: { provisionId: string; stream: 'stdout' | 'stderr'; chunk: string }) => void
) => () => void
listRuntimes: () => Promise<EphemeralVmRuntimeRecord[]>
attachWorkspace: (args: {
runtimeId: string
workspaceId: string
}) => Promise<EphemeralVmRuntimeRecord>
resumeWorkspace: (args: { workspaceId: string }) => Promise<EphemeralVmRuntimeRecord | null>
cleanup: (args: { runtimeId: string }) => Promise<EphemeralVmRuntimeRecord>
stopCleanup: (args: { runtimeId: string }) => Promise<EphemeralVmRuntimeRecord>
getCleanupCommand: (args: { runtimeId: string }) => Promise<{
runtimeId: string
command: string | null
payloadJson: string
cleanupDisabled: boolean
message?: string
}>
}