Documentation Index
Fetch the complete documentation index at: https://docs.cline.bot/llms.txt
Use this file to discover all available pages before exploring further.
Most common types are exported from @cline/shared; runtime entry-point packages re-export selected helpers.
AgentRuntime Types
import type {
AgentMessage,
AgentMessagePart,
AgentRunResult,
AgentRuntimeEvent,
AgentRuntimeStateSnapshot,
AgentUsage,
} from "@cline/sdk"
AgentRunResult is returned by direct AgentRuntime / Agent runs:
interface AgentRunResult {
agentId: string
agentRole?: string
runId: string
status: "completed" | "aborted" | "failed"
iterations: number
outputText: string
messages: readonly AgentMessage[]
usage: AgentUsage
error?: Error
}
Host-Facing Agent Types
import type {
AgentConfig,
AgentEvent,
AgentResult,
AgentPlugin,
AgentTool,
AgentToolContext,
ToolPolicy,
} from "@cline/sdk"
AgentResult is the host/core-facing result shape:
interface AgentResult {
text: string
usage: LegacyAgentUsage
messages: MessageWithMetadata[]
toolCalls: ToolCallRecord[]
iterations: number
finishReason: "completed" | "max_iterations" | "aborted" | "mistake_limit" | "error"
model: { id: string; provider: string; info?: ModelInfo }
startedAt: Date
endedAt: Date
durationMs: number
}
ClineCore Types
import type {
ClineCoreOptions,
ClineCoreStartInput,
CoreSessionConfig,
SessionRecord,
} from "@cline/sdk"
interface ToolPolicy {
enabled?: boolean
autoApprove?: boolean
}
