@fungi.computer/shiitake 0.0.0-stage → 0.1.0

package/docs/api/client.md

@@ -0,0 +1,1112 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/shiitake**](README.md)
+
+---
+
+[@fungi.computer/shiitake](README.md) / client
+
+# client
+
+## Type Aliases
+
+### Accepted
+
+```ts
+type Accepted = Readonly<{
+  status: "accepted";
+  commandId: string;
+}>;
+```
+
+Semantic acknowledgement returned after one durable acceptance commit.
+
+---
+
+### TooLate
+
+```ts
+type TooLate = Readonly<{
+  status: "too_late";
+  commandId: string;
+}>;
+```
+
+Cancelling found nothing left to cancel: the command is unknown to this Session,
+has already started (for an `onlyIfPending` cancel) or has already settled. It
+is an ordinary outcome, never an error.
+
+---
+
+### CancelResult
+
+```ts
+type CancelResult = Accepted | TooLate;
+```
+
+Outcome of one cancel command.
+
+---
+
+### ForkedSession
+
+```ts
+type ForkedSession = Readonly<{
+  sessionId: string;
+}>;
+```
+
+Result returned after a fork commits a new cold-readable Session.
+
+---
+
+### SessionCommandHandler
+
+```ts
+type SessionCommandHandler = {
+  (input): Promise<
+    Readonly<{
+      status: "accepted";
+      commandId: string;
+    }>
+  >;
+  (input): Promise<CancelResult>;
+  (input): Promise<undefined>;
+  (input): Promise<
+    Readonly<{
+      sessionId: string;
+    }>
+  >;
+  (input): Promise<
+    | CancelResult
+    | Readonly<{
+        sessionId: string;
+      }>
+    | undefined
+  >;
+};
+```
+
+Execute one retained type-discriminated Session command.
+
+#### Call Signature
+
+```ts
+(input): Promise<Readonly<{
+  status: "accepted";
+  commandId: string;
+}>>;
+```
+
+Accept a prompt or a compaction request as queued Session work.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                         |
+| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `delivery`: `"followUp"` \| `"steer"`; `requestId`: `string`; `type`: `"prompt"`; `text`: `string`; `images?`: readonly `object`[]; \} \| \{ `type`: `"compact"`; `requestId`: `string`; `instructions?`: `string`; \} |
+
+##### Returns
+
+`Promise`\<`Readonly`\<\{ `status`: `"accepted"`; `commandId`: `string`; \}\>\>
+
+#### Call Signature
+
+```ts
+(input): Promise<CancelResult>;
+```
+
+Cancel one accepted command, or report that it is too late.
+
+##### Parameters
+
+| Parameter              | Type                                                                          |
+| ---------------------- | ----------------------------------------------------------------------------- |
+| `input`                | \{ `commandId`: `string`; `onlyIfPending?`: `boolean`; `type`: `"cancel"`; \} |
+| `input.commandId`      | `string`                                                                      |
+| `input.onlyIfPending?` | `boolean`                                                                     |
+| `input.type`           | `"cancel"`                                                                    |
+
+##### Returns
+
+`Promise`\<[`CancelResult`](#cancelresult)\>
+
+#### Call Signature
+
+```ts
+(input): Promise<undefined>;
+```
+
+Abort the active run, select a lineage leaf, record an operator line, or set the
+title.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `type`: `"abort"`; \} \| \{ `type`: `"branch"`; `entryId`: `string`; \} \| \{ `type`: `"operator"`; `requestId`: `string`; `author`: `"operator"` \| `"party"`; `text`: `string`; \} \| \{ `type`: `"title"`; `title`: `string` \| `null`; \} |
+
+##### Returns
+
+`Promise`\<`undefined`\>
+
+#### Call Signature
+
+```ts
+(input): Promise<Readonly<{
+  sessionId: string;
+}>>;
+```
+
+Fork one complete entry lineage into a new Session.
+
+##### Parameters
+
+| Parameter       | Type                                         |
+| --------------- | -------------------------------------------- |
+| `input`         | \{ `type`: `"fork"`; `entryId`: `string`; \} |
+| `input.type`    | `"fork"`                                     |
+| `input.entryId` | `string`                                     |
+
+##### Returns
+
+`Promise`\<`Readonly`\<\{ `sessionId`: `string`; \}\>\>
+
+#### Call Signature
+
+```ts
+(input): Promise<
+  | CancelResult
+  | Readonly<{
+  sessionId: string;
+}>
+| undefined>;
+```
+
+Execute an already-decoded command union.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `delivery`: `"followUp"` \| `"steer"`; `requestId`: `string`; `type`: `"prompt"`; `text`: `string`; `images?`: readonly `object`[]; \} \| \{ `type`: `"abort"`; \} \| \{ `commandId`: `string`; `onlyIfPending?`: `boolean`; `type`: `"cancel"`; \} \| \{ `type`: `"branch"`; `entryId`: `string`; \} \| \{ `type`: `"fork"`; `entryId`: `string`; \} \| \{ `type`: `"operator"`; `requestId`: `string`; `author`: `"operator"` \| `"party"`; `text`: `string`; \} \| \{ `type`: `"compact"`; `requestId`: `string`; `instructions?`: `string`; \} \| \{ `type`: `"title"`; `title`: `string` \| `null`; \} |
+
+##### Returns
+
+`Promise`\< \| [`CancelResult`](#cancelresult) \| `Readonly`\<\{ `sessionId`:
+`string`; \}\> \| `undefined`\>
+
+---
+
+### SendOptions
+
+```ts
+type SendOptions = Readonly<{
+  images?: PromptCommand["images"];
+  delivery?: PromptDelivery;
+  requestId?: string;
+}>;
+```
+
+Optional controls for the Promise-friendly text sender.
+
+---
+
+### SessionMessage
+
+```ts
+type SessionMessage = Readonly<{
+  meta?: Json;
+  origin?: Readonly<{
+    extensionId: string;
+    correlation: string | null;
+  }>;
+  id: string;
+  sequence: number;
+  commandId: string | null;
+  value: Message;
+}>;
+```
+
+One exact completed Pi message on the selected Session lineage.
+
+---
+
+### ShiitakeEventSourceConstructor
+
+```ts
+type ShiitakeEventSourceConstructor = (
+  url,
+) => Pick<EventTarget, "addEventListener"> &
+  Pick<EventSource, "close"> &
+  object;
+```
+
+Minimal constructor seam for runtimes without a global EventSource.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `url`     | `string` |
+
+#### Returns
+
+`Pick`\<`EventTarget`, `"addEventListener"`\> & `Pick`\<`EventSource`,
+`"close"`\> & `object`
+
+---
+
+### SessionTerminal
+
+```ts
+type SessionTerminal = Readonly<{
+  commandId: string;
+  outcome: "completed" | "cancelled" | "failed" | "interrupted";
+  sequence: number;
+  diagnostic: string | null;
+  meta?: Json;
+}>;
+```
+
+Durable outcome for one accepted work item on the selected Session lineage.
+
+---
+
+### AgentRunningWork
+
+```ts
+type AgentRunningWork =
+  | Readonly<{
+      kind: "session";
+      sessionId: string;
+      commandId: string;
+    }>
+  | Readonly<{
+      kind: "host";
+      lane: string;
+      jobId: string;
+    }>;
+```
+
+Work occupying the executor partition that this queued command requires, without
+message or provider data.
+
+---
+
+### SessionActivity
+
+```ts
+type SessionActivity = Readonly<{
+  queue:
+    | Readonly<{
+        state: "idle";
+      }>
+    | Readonly<{
+        state: "queued";
+        commandId: string;
+        runningWork: AgentRunningWork | null;
+      }>
+    | Readonly<{
+        state: "running";
+        commandId: string;
+      }>;
+  cancellationRequested: boolean;
+  retry: Readonly<{
+    attempt: number;
+    maxAttempts: number;
+    delayMs: number;
+    errorMessage: string;
+    scheduledAt: number;
+  }> | null;
+  activeTool: string | null;
+  lastModelChoiceSequence: number | null;
+  compaction: Readonly<{
+    trigger: SessionCompactionTrigger;
+  }> | null;
+}>;
+```
+
+Raw facts about what a Session is doing now. Shiitake publishes facts only; a
+client decides what they mean (see Parakeet's `sessionViewState`).
+
+---
+
+### SessionExtensionSlots
+
+```ts
+type SessionExtensionSlots = Readonly<Record<string, ExtensionSlotV0>>;
+```
+
+Encoded extension slots keyed by extension identity; absent means unavailable.
+
+---
+
+### SessionExtensionControls
+
+```ts
+type SessionExtensionControls = Readonly<{
+  call: (command, input) => Promise<Json>;
+}>;
+```
+
+Generic Session-scope extension commands.
+
+---
+
+### AgentExtensionControls
+
+```ts
+type AgentExtensionControls = Readonly<{
+  list: () => Promise<readonly ExtensionStatusV0[]>;
+  resume: (extensionId) => Promise<ExtensionStatusV0>;
+  call: (extensionId, command, input) => Promise<Json>;
+}>;
+```
+
+Generic Agent-scope extension controls.
+
+---
+
+### SessionProgress
+
+```ts
+type SessionProgress = Readonly<{
+  messageId: string;
+  revision: number;
+  text: string;
+  thinking: string;
+  textTruncated: boolean;
+  thinkingTruncated: boolean;
+}>;
+```
+
+Process-local assistant progress; never a durable Session fact.
+
+---
+
+### SessionPendingPrompt
+
+```ts
+type SessionPendingPrompt = Readonly<{
+  meta?: SessionMessage["meta"];
+  origin?: SessionMessage["origin"];
+  commandId: string;
+  text: string;
+  images?: PromptCommand["images"];
+  delivery: PromptDelivery;
+}>;
+```
+
+Accepted prompt waiting to enter the conversation, not a scheduling command.
+
+---
+
+### SessionPendingPrompts
+
+```ts
+type SessionPendingPrompts = Readonly<{
+  total: number;
+  prompts: readonly SessionPendingPrompt[];
+  hasMore: boolean;
+}>;
+```
+
+Bounded current admission view, in acceptance order rather than execution order.
+
+---
+
+### SessionCompactionMarker
+
+```ts
+type SessionCompactionMarker = Readonly<{
+  id: string;
+  sequence: number;
+  at: number;
+  tokensBefore: number;
+  tokensAfter: number | null;
+  trigger: SessionCompactionTrigger | null;
+}>;
+```
+
+Minimal full-history compaction boundary marker. `sequence` is the Woodstock
+order of the row this marker precedes (ties sort the marker first); `at` is when
+the compaction ran. The agent's model context is unaffected by this marker; it
+exists only for the client timeline.
+
+---
+
+### SessionCompactionTrigger
+
+```ts
+type SessionCompactionTrigger = "manual" | "threshold" | "overflow";
+```
+
+What started a compaction: the user, the context threshold, or an overflow.
+
+---
+
+### SessionCompactionNotice
+
+```ts
+type SessionCompactionNotice = Readonly<{
+  id: string;
+  sequence: number;
+  at: number;
+  trigger: SessionCompactionTrigger;
+  result: "nothing_to_compact" | "failed";
+  diagnostic: string | null;
+}>;
+```
+
+A compaction that changed nothing: a manual request with nothing to summarize
+yet, or a compaction that failed. Automatic failures are never silent; each one
+is a notice at its own place in the timeline.
+
+---
+
+### SessionContext
+
+```ts
+type SessionContext = Readonly<{
+  tokens: number;
+  window: number | null;
+}>;
+```
+
+The Session's context use as compaction measures it, against the window of the
+model a run would select now; the window is null when that model reports none.
+
+---
+
+### SessionSnapshot
+
+```ts
+type SessionSnapshot = Readonly<{
+  sessionId: string;
+  cursor: string | null;
+  hasMore: boolean;
+  oldestCursor?: string | null;
+  messages: readonly SessionMessage[];
+  terminals: readonly SessionTerminal[];
+  compactions?: readonly SessionCompactionMarker[];
+  compactionNotices?: readonly SessionCompactionNotice[];
+  sandboxFailures?: readonly SandboxFailureEvent[];
+  pending: SessionPendingPrompts;
+  activity: SessionActivity;
+  progress: SessionProgress | null;
+  extensions: SessionExtensionSlots;
+  attention: readonly SessionAttention[];
+  context?: SessionContext;
+}>;
+```
+
+Bounded Session baseline at one opaque owner cursor.
+
+---
+
+### SessionFrame
+
+```ts
+type SessionFrame =
+  | Readonly<{
+      kind: "update";
+      delivery: "replay" | "live";
+      cursor: string | null;
+      pending: SessionPendingPrompts;
+      messages: readonly SessionMessage[];
+      terminals: readonly SessionTerminal[];
+      compactions?: readonly SessionCompactionMarker[];
+      compactionNotices?: readonly SessionCompactionNotice[];
+      sandboxFailures?: readonly SandboxFailureEvent[];
+      activity: SessionActivity;
+      extensions: SessionExtensionSlots;
+      attention: readonly SessionAttention[];
+      context?: SessionContext;
+    }>
+  | Readonly<{
+      kind: "progress";
+      progress: SessionProgress;
+      activity: SessionActivity;
+    }>
+  | Readonly<{
+      kind: "reset";
+      reason: "history_unavailable";
+      cursor: string | null;
+      baseline: SessionSnapshot;
+    }>;
+```
+
+One bounded replay or live frame.
+
+---
+
+### SubscribeOptions
+
+```ts
+type SubscribeOptions = Readonly<{
+  includeSandboxFailures?: boolean;
+  after?: string;
+}>;
+```
+
+Strict-after replay request.
+
+---
+
+### ReadOptions
+
+```ts
+type ReadOptions = Readonly<{
+  includeSandboxFailures?: boolean;
+  limit?: number;
+  before?: string;
+}>;
+```
+
+Bounded baseline request.
+
+---
+
+### WatchOptions
+
+```ts
+type WatchOptions = ReadOptions;
+```
+
+Race-safe observation request.
+
+---
+
+### SessionWatch
+
+```ts
+type SessionWatch = Readonly<{
+  snapshot: SessionSnapshot;
+  changes: AsyncIterable<SessionFrame>;
+  close: () => Promise<void>;
+}>;
+```
+
+Race-safe baseline plus live changes resource.
+
+---
+
+### ShiitakeSession
+
+```ts
+type ShiitakeSession = Readonly<{
+  address: string;
+  command: SessionCommandHandler;
+  abort: () => Promise<void>;
+  send: (text, options?) => Promise<Accepted>;
+  cancel: (input) => Promise<CancelResult>;
+  extension: (extensionId) => SessionExtensionControls;
+  modelPreference: Readonly<{
+    read: () => Promise<ModelPreference | null>;
+    set: (preference) => Promise<void>;
+  }>;
+  read: (input?) => Promise<SessionSnapshot>;
+  subscribe: (input) => AsyncIterable<SessionFrame>;
+  watch: (input?) => Promise<SessionWatch>;
+}>;
+```
+
+Addressable Session interface. Addressing itself performs no I/O.
+
+---
+
+### SessionInboxState
+
+```ts
+type SessionInboxState = "needs_you" | "running" | "errored" | "done";
+```
+
+Owner-decided inbox state, from Watchdog's queue head and latest outcome.
+`running` covers queued, thinking, streaming, retrying and cancelling; `errored`
+covers failed, interrupted and `outcome_unknown`; `done` covers completed,
+cancelled and never run. Any open extension attention produces `needs_you`,
+taking priority over live and settled work.
+
+---
+
+### SessionSummary
+
+```ts
+type SessionSummary = Readonly<{
+  createdAt: number;
+  lastActivityAt: number;
+  settledAt?: number;
+  title: string;
+  state: SessionInboxState;
+}>;
+```
+
+Read-only saved conversation projection; opening does not update recency.
+
+---
+
+### SessionSummaryRow
+
+```ts
+type SessionSummaryRow =
+  | (SessionSummary &
+      Readonly<{
+        sessionId: string;
+      }>)
+  | Readonly<{
+      sessionId: string;
+      state: "unavailable";
+    }>;
+```
+
+One listed conversation, or a saved Session its owner could not read.
+
+---
+
+### SessionSummaryPage
+
+```ts
+type SessionSummaryPage = Readonly<{
+  sessions: readonly SessionSummaryRow[];
+  next: string | undefined;
+}>;
+```
+
+One owner-bounded page: `needs_you`, then `running`, then settled rows, each
+newest activity first. `next` is an opaque owner cursor.
+
+---
+
+### ShiitakeAgent
+
+```ts
+type ShiitakeAgent = Readonly<{
+  createSession: (requestId) => Promise<string>;
+  deleteSession: (sessionId) => Promise<boolean>;
+  listSessions: (after?) => Promise<SessionSummaryPage>;
+  extensions: AgentExtensionControls;
+  session: (sessionId) => ShiitakeSession;
+  close: () => Promise<void>;
+}>;
+```
+
+Constructed durable harness.
+
+---
+
+### ExtensionViewV0
+
+```ts
+type ExtensionViewV0<P> =
+  | Readonly<{
+      status: "unavailable";
+    }>
+  | Readonly<{
+      status: "stopped";
+      reason: string;
+    }>
+  | Readonly<{
+      status: "running";
+      value: P | null;
+    }>;
+```
+
+What one client sees of an extension in a Session observation.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `P`            |
+
+---
+
+### ScopedCommandsV0
+
+```ts
+type ScopedCommandsV0<C, S> = {
+  [K in keyof C & string]: C[K]["scope"] extends S ? K : never;
+}[keyof C & string];
+```
+
+Command names of one scope, typed by the shared contract.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `C` _extends_ [`CommandsV0`](extensions.md#commandsv0) |
+| `S` _extends_ `"session"` \| `"agent"`                 |
+
+---
+
+### BoundCallV0
+
+```ts
+type BoundCallV0<C, S> = <K>(name, input) => Promise<C[K]["output"]["Type"]>;
+```
+
+Typed call surface of one contract's commands in one scope.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `C` _extends_ [`CommandsV0`](extensions.md#commandsv0) |
+| `S` _extends_ `"session"` \| `"agent"`                 |
+
+#### Type Parameters
+
+| Type Parameter                                                    |
+| ----------------------------------------------------------------- |
+| `K` _extends_ [`ScopedCommandsV0`](#scopedcommandsv0)\<`C`, `S`\> |
+
+#### Parameters
+
+| Parameter | Type                                |
+| --------- | ----------------------------------- |
+| `name`    | `K`                                 |
+| `input`   | `C`\[`K`\]\[`"input"`\]\[`"Type"`\] |
+
+#### Returns
+
+`Promise`\<`C`\[`K`\]\[`"output"`\]\[`"Type"`\]\>
+
+---
+
+### BoundSessionExtensionV0
+
+```ts
+type BoundSessionExtensionV0<C, P> = Readonly<{
+  view: (observation) => ExtensionViewV0<P>;
+  call: BoundCallV0<C, "session">;
+}>;
+```
+
+One Session bound to one extension contract.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `C` _extends_ [`CommandsV0`](extensions.md#commandsv0) |
+| `P`                                                    |
+
+---
+
+### BoundAgentExtensionV0
+
+```ts
+type BoundAgentExtensionV0<C> = Readonly<{
+  call: BoundCallV0<C, "agent">;
+}>;
+```
+
+One Agent bound to one extension contract.
+
+#### Type Parameters
+
+| Type Parameter                                         |
+| ------------------------------------------------------ |
+| `C` _extends_ [`CommandsV0`](extensions.md#commandsv0) |
+
+---
+
+### OperatorCommand
+
+```ts
+type OperatorCommand = Extract<
+  SessionCommand,
+  Readonly<{
+    type: "operator";
+  }>
+>;
+```
+
+Public command that records one operator or party line without a run.
+
+---
+
+### TitleCommand
+
+```ts
+type TitleCommand = Extract<
+  SessionCommand,
+  Readonly<{
+    type: "title";
+  }>
+>;
+```
+
+Public command that sets or clears the user's Session title.
+
+---
+
+### ShiitakeClientOptions
+
+```ts
+type ShiitakeClientOptions = Readonly<{
+  baseUrl: string;
+  fetch?: typeof globalThis.fetch;
+  eventSource?: ShiitakeEventSourceConstructor;
+}>;
+```
+
+Network location of one remotely hosted Shiitake agent.
+
+---
+
+### SessionAttention
+
+```ts
+type SessionAttention = typeof SessionAttentionSchema.Type;
+```
+
+One open attention item in a Session observation.
+
+## Variables
+
+### AcceptedSchema
+
+```ts
+const AcceptedSchema: Schema.Codec<Accepted>;
+```
+
+Decode a durable command acceptance value at an RPC boundary.
+
+## Functions
+
+### parseAccepted()
+
+```ts
+function parseAccepted(value): Accepted;
+```
+
+Parse one serialized command acceptance using Shiitake's public grammar.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `string` |
+
+#### Returns
+
+[`Accepted`](#accepted)
+
+---
+
+### parseCancelResult()
+
+```ts
+function parseCancelResult(value): CancelResult;
+```
+
+Parse one serialized cancel outcome: accepted, or too late.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `string` |
+
+#### Returns
+
+[`CancelResult`](#cancelresult)
+
+---
+
+### parseShiitakeError()
+
+```ts
+function parseShiitakeError(value): ShiitakeError;
+```
+
+Parse one serialized canonical Shiitake failure.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `string` |
+
+#### Returns
+
+[`ShiitakeError`](index.md#shiitakeerror)
+
+---
+
+### parseSessionSummaryPage()
+
+```ts
+function parseSessionSummaryPage(value): SessionSummaryPage;
+```
+
+Decode the existing bounded saved-conversation projection.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `string` |
+
+#### Returns
+
+[`SessionSummaryPage`](#sessionsummarypage)
+
+---
+
+### bindSessionExtension()
+
+```ts
+function bindSessionExtension<C, P, PI>(
+  session,
+  contract,
+): BoundSessionExtensionV0<C, P>;
+```
+
+Bind one Session to one extension contract; the contract's schemas decode.
+
+#### Type Parameters
+
+| Type Parameter                                                                                                                                                          |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `C` _extends_ `Readonly`\<`Record`\<`string`, `Readonly`\<\{ `scope`: `"session"` \| `"agent"`; `input`: `Codec`\<`unknown`\>; `output`: `Codec`\<`unknown`\>; \}\>\>\> |
+| `P`                                                                                                                                                                     |
+| `PI`                                                                                                                                                                    |
+
+#### Parameters
+
+| Parameter  | Type                                                                         |
+| ---------- | ---------------------------------------------------------------------------- |
+| `session`  | `Pick`\<[`ShiitakeSession`](#shiitakesession), `"extension"`\>               |
+| `contract` | [`ExtensionContractV0`](extensions.md#extensioncontractv0)\<`C`, `P`, `PI`\> |
+
+#### Returns
+
+[`BoundSessionExtensionV0`](#boundsessionextensionv0)\<`C`, `P`\>
+
+---
+
+### bindAgentExtension()
+
+```ts
+function bindAgentExtension<C, P, PI>(
+  agent,
+  contract,
+): BoundAgentExtensionV0<C>;
+```
+
+Bind one Agent to one extension contract's Agent-scope commands.
+
+#### Type Parameters
+
+| Type Parameter                                                                                                                                                          |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `C` _extends_ `Readonly`\<`Record`\<`string`, `Readonly`\<\{ `scope`: `"session"` \| `"agent"`; `input`: `Codec`\<`unknown`\>; `output`: `Codec`\<`unknown`\>; \}\>\>\> |
+| `P`                                                                                                                                                                     |
+| `PI`                                                                                                                                                                    |
+
+#### Parameters
+
+| Parameter  | Type                                                                         |
+| ---------- | ---------------------------------------------------------------------------- |
+| `agent`    | `Pick`\<[`ShiitakeAgent`](#shiitakeagent), `"extensions"`\>                  |
+| `contract` | [`ExtensionContractV0`](extensions.md#extensioncontractv0)\<`C`, `P`, `PI`\> |
+
+#### Returns
+
+[`BoundAgentExtensionV0`](#boundagentextensionv0)\<`C`\>
+
+---
+
+### createShiitakeClient()
+
+```ts
+function createShiitakeClient(options): ShiitakeAgent;
+```
+
+Connect to a remotely hosted Shiitake agent.
+
+#### Parameters
+
+| Parameter | Type                                              |
+| --------- | ------------------------------------------------- |
+| `options` | [`ShiitakeClientOptions`](#shiitakeclientoptions) |
+
+#### Returns
+
+[`ShiitakeAgent`](#shiitakeagent)
+
+## References
+
+### parseForkedSession
+
+Re-exports [parseForkedSession](index.md#parseforkedsession)
+
+---
+
+### parseSessionFrame
+
+Re-exports [parseSessionFrame](index.md#parsesessionframe)
+
+---
+
+### parseSessionSnapshot
+
+Re-exports [parseSessionSnapshot](index.md#parsesessionsnapshot)
+
+---
+
+### AbortCommand
+
+Re-exports [AbortCommand](index.md#abortcommand)
+
+---
+
+### BranchCommand
+
+Re-exports [BranchCommand](index.md#branchcommand)
+
+---
+
+### CompactCommand
+
+Re-exports [CompactCommand](index.md#compactcommand)
+
+---
+
+### CancelCommand
+
+Re-exports [CancelCommand](index.md#cancelcommand)
+
+---
+
+### ForkCommand
+
+Re-exports [ForkCommand](index.md#forkcommand)
+
+---
+
+### PromptCommand
+
+Re-exports [PromptCommand](index.md#promptcommand)
+
+---
+
+### PromptDelivery
+
+Re-exports [PromptDelivery](index.md#promptdelivery)
+
+---
+
+### SessionCommand
+
+Re-exports [SessionCommand](index.md#sessioncommand)
+
+---
+
+### ModelPreference
+
+Re-exports [ModelPreference](index.md#modelpreference)