API reference

See the generated Corral API reference. The default export is an attach-only shiitake.client/v1 entry. attachCorral is the lower-level integration for hosts that supply an activity stream directly.

Exports

Kind	Export	Description
Ttype alias	CorralEnvironment	Pane environment supplied by the local Herdr host.
Ttype alias	CorralActivity	Activity supplied by the client; blocked means a human response is pending.
constconstant	default	Ordinary Fungi client extension; disabled outside a Herdr pane.
fnfunction	attachCorral()	Attach to borrowed activity; never opens a Session watch or starts Herdr.

CorralEnvironmentTtype alias

Signature

type CorralEnvironment = Readonly<{
  HERDR_ENV?: string;
  HERDR_PANE_ID?: string;
  HERDR_SOCKET_PATH?: string;
}>;

Pane environment supplied by the local Herdr host.

---

CorralActivityTtype alias

Signature

type CorralActivity = ClientActivityV0;

Activity supplied by the client; blocked means a human response is pending.

defaultconstconstant

Signature

const default: Readonly<{
  protocol: "shiitake.client/v1";
  id: string & Brand<"ExtensionId">;
  promptPresentation?: "footer";
  attach?: (context) => Effect<void, Error, Scope>;
  contribute?: (slot) => object;
}>;

Ordinary Fungi client extension; disabled outside a Herdr pane.

attachCorral()fnfunction

Signature

function attachCorral(activity, options): Effect<void, Error, Scope>;

Attach to borrowed activity; never opens a Session watch or starts Herdr.

Parameters

Parameter	Type
activity	Stream<Readonly<{ state: ClientActivityStateV0; header?: string; }>, Error>
options	Readonly<{ environment: CorralEnvironment; onError: (cause) => void; }>

Returns

Effect<void, Error, Scope>