@falkenslab/agent-kit

Namespaces

Namespace	Description
ui	The terminal palette: one function per theme role, drawing text in the current theme.

Interfaces

Interface	Description
AgentRun	A running session, as runQuery() returns it: its events and the controls of the SDK's Query.
AgentSpec	Everything actually about the domain that buildSessionOptions() needs but doesn't decide itself: which system prompt to build, which MCP servers to talk to besides the generic human-in-the-loop/knowledge ones this kit already wires up, which local plugin roots (skills/commands) to load, and which opt-in subagents (if any) to register.
ApprovalPrompt	What a checkpoint shows the person: a title, detail lines and, in a plain terminal, the question.
BaseSessionConfig	The minimum a config object needs to drive buildSessionOptions() — a concrete agent's own config type (e.g. a Config) extends this with whatever domain fields it needs (a course URL, credentials, ...), which buildSessionOptions() itself never looks at directly: only AgentSpec's methods receive the full concrete config.
ChatTuiOptions	Options of the chats (runChatTui(), and runChatInk() through InkChatOptions).
CheckReport	What check() finds: the mechanical problems, for the agent to fix or report.
ChoiceAnswer	What the person chose: the options they picked, and their own answer if they gave one.
ChoiceSettings	How askChoice() asks: the options to pick from, and whether several can be picked.
ClaudeAuthConfig	What resolveClaudeAuth() and ensureClaudeAuth() accept besides the environment.
ConfirmStep	A yes/no question; the answer is a boolean.
ConsoleRenderer	Prints runQuery()'s events as plain console lines (see createConsoleRenderer()).
ConsoleRendererOptions	Options of createConsoleRenderer().
ContextUsage	How full the session's context window is (see AgentRun.contextUsage()).
ConversationMessage	One message of a kept conversation: something the person wrote, or the agent's text reply.
FileKnowledgeStoreOptions	Options of createFileKnowledgeStore().
FileScope	Where the built-in file tools may act. Without this, the only boundary is the SDK's own working-directory scope — the whole project directory — so keeping the agent out of the user's own files (a config file holding a password, the originals in sources/) would rest on the system prompt alone.
HeaderInfo	The top of the Ink chat: a title, optional fields and an optional logo.
HumanApprovalTexts	The approval tool's texts: its description (when the model should call it) and what it returns when approved or rejected.
InkChatOptions	Options of runChatInk(): the chat's options plus the Ink-only ones.
InputStep	A line of text.
InteractionPort	The UI side of a human-in-the-loop checkpoint: how a host shows the question and reads a person's answer. askForDecision() races it against the response file, so a port only covers the keyboard (or window) channel and never needs to know about the file.
KnowledgePage	One page, as the store returns it.
KnowledgeStore	Where the knowledge base lives. The kit ships one over markdown files (createFileKnowledgeStore()); another one (a database, a vector store) implements this interface and is passed with AgentSpec.knowledgeStore. Pages are never deleted or renamed: their ids are what links point to.
KnowledgeToolsOptions	Options of createKnowledgeServer().
LanguageSources	Where the language can come from, in order of precedence.
ManualInterventionTexts	The manual-intervention tool's texts: for the model (toolDescription, confirmedMessage) and for the person (the checkpoint).
Messages	Every text the kit shows a person, in one language. Texts for the model (tool descriptions, hook deny reasons, the knowledge base's prompt section) aren't here: they stay in English whatever the language.
ModeControl	The supervision mode of a running session. "guided", "interactive" and "plan" switch into one another: they share the same tools (the approval tool), and the step gate and the plan gate are registered in all three, deciding only in their own mode. "autonomous" has no approval tool at all, and a tool can't appear or vanish mid-session, so a session that starts autonomous stays autonomous, and one that doesn't can't become autonomous. The system prompt keeps the mode it was built with, so entering or leaving plan mode is told to the model with the next message instead (takeNotice()).
NewPage	A page to create.
PageInfo	A page's line in a listing.
PageType	A kind of page: the kit's four, or one an agent declares (AgentSpec.knowledgePageTypes).
PasswordStep	A line of text, masked while typed and in the summary.
PlanModeSpec	The domain's part of "plan" mode: which files hold the plan and which of its own tools only read.
PlanScope	What plan mode lets through besides reading: see createPlanGate().
ProgressView	A one-shot run's live view: a console renderer drawn with Ink, plus close().
ProgressViewOptions	Options of createProgressView().
ResolvedLanguage	The result of resolveLanguage(): the language to use and why any asked-for code was skipped.
RunFolder	One run of an agent: a folder under the agent's runs folder (<runsDir>/<timestamp>/) holding its session log, its transcript of tool calls and, with a run store, the SDK's own transcript of the conversation, so a person can resume it later.
RunSummary	A run that kept a conversation, as listRuns() lists it for a person to pick (see /resume).
SearchHit	-
SelectStep	A choice among choices; the answer is the chosen value.
SessionUsage	Running totals for the whole query() session so far, not for one turn: the SDK's own total_cost_usd and modelUsage are cumulative across turns in a streaming-input session, so the latest turn-end carries the session total (never sum them).
SourceToolsOptions	Options of createSaveToSourcesServer().
Theme	The terminal UI's colors, by what they're for.
TranscriptLogger	The two hooks that write transcript.jsonl: register preToolUse as a PreToolUse hook and postToolUse as a PostToolUse one.
WizardOptions	Options of runWizard().

Type Aliases

Type Alias	Description
AgentEvent	A transport-agnostic view of one turn's worth of output from query() — the same normalized shape whether the caller is going to print it to a console, forward it to a chat REPL, or serialize it over Electron IPC (a real consuming agent had four separate entry points — CLI run, CLI chat, an exploration mode and a desktop chat — that all parsed the SDK's raw message stream themselves, nearly identically).
FieldChanges	A change to a page's frontmatter fields: a string sets it, null removes it.
Language	The languages the kit's own texts come in.
Mode	The human-supervision spectrum every agent built on this kit shares, independent of domain: "interactive" pauses before every single action, "guided" only pauses before a hard-to-undo/visible-to-others action, "autonomous" has no human-in-the-loop channel at all, and "plan" only reads and plans: nothing is changed until the human leaves it (see hooks/planGate.ts). See session.ts's buildSessionOptions() for exactly what each mode changes.
RenderApproval	Replaces the default preview (title and lines) of an approval panel; the choices stay.
ResultFormatter	The line shown under a tool call for its result: a string replaces the kit's (plain text, drawn in the result's color, or the error color if it failed), null hides it, and undefined keeps the kit's (the result's first line).
SessionOpener	Builds the session's options for a run folder, e.g. (run) => buildSessionOptions(config, run.dir, spec, { run }): called for the first run and again for each one resumed with /resume (MCP servers, the step gate and the transcript are bound to the run's folder, so they're built anew).
ThemeColor	A color for one role of the theme: a color name ("gray", "cyanBright": picocolors' and Ink's names), a hex ("#ff8800"), or a function that styles the text itself (bold, a background...). Roles drawn by Ink props (border, selection, the panels' accent) need a name or a hex: a function there falls back to the default color.
ToolDescriber	An agent's labels for its own tools: the tool's short name and input, to a label, or undefined for the kit's default.
ToolDetail	How much of its tool calls a chat shows: "full", every call with its result line; "calls", the calls without their results (a failed call says so in one short line); "summary", one line per group. Ctrl+O unfolds any of them into the full view.
ToolPhrase	How a tool counts in a folded group's summary: the phrase for one call and for several, "{n}" standing for the count.
WizardAnswers	The wizard's answers, by step name.
WizardStep	One question of runWizard().

Variables

Variable	Description
allowAnyMcpTool	Approves any MCP tool call ("mcp__"), regardless of which server it comes from, and denies everything else. This is what lets a project's own .mcp.json declare arbitrary additional MCP servers without the host agent's code needing to know their names ahead of time: a fixed allowedTools wildcard like "mcp__playwright" only matches that one named server — confirmed empirically that a bare "mcp__" entry does NOT match "mcp____" the way a real per-server wildcard does — so a dynamic decision here is the only way to cover every MCP server generically.
BUILT_IN_PAGE_TYPES	The kit's page types (ADR-008).
DEFAULT_HUMAN_APPROVAL_TEXTS	Domain-neutral defaults — a concrete agent should normally override these via AgentSpec.humanApprovalTexts with wording specific to what "publishing" means in its domain.
DEFAULT_THEME	The kit's own look.
SUPPORTED_LANGUAGES	The language codes the kit's texts come in.
terminalInteractionPort	The default InteractionPort, installed by the package entry point: prints the checkpoint and reads the answer on the terminal, on the chat's own readline when one is registered via setSharedReadline(). Without a TTY it prints nothing and never answers.

Functions

Function	Description
askForChoice	A choice between options, through the port's askChoice() (or askDecision() with the options numbered in the prompt) and the response file, which takes the same answer: the numbers, or the person's own words.
askForDecision	Asks the human for a decision through two channels in parallel, whichever answers first wins: (1) the installed InteractionPort (the keyboard, for a person running the process in their own terminal, see tui/terminalInteraction.ts), and (2) a response file, for when something else (e.g. Claude Code, or a non-terminal host driving its own UI — an Electron main process, a Tauri sidecar) is piloting the run and has no interactive stdin to write to.
askForManualIntervention	Like askForDecision(), for a manual-intervention checkpoint (see tools/manualLogin.ts).
askForText	A free-text answer, through the port's askText() (or askDecision() when it has none) and the response file: trimmed, with its case kept.
buildSessionOptions	Builds the options object passed to the Agent SDK's query() — everything about how the agent runs a session (system prompt, tools, MCP servers, hooks), independent of what is said to start it off (that's the caller's prompt, a plain string for a one-shot run or an AsyncIterable for a multi-turn chat).
checkFileScope	The reason to deny toolName with input under scope, or undefined to let it through. Tools other than Read/Write/Edit/Grep are never judged here, and a call without a path is left for the tool itself to reject.
checkPlanScope	The reason to deny toolName with input in plan mode, or undefined to let it through. Anything not known to only read is denied, so a tool nobody thought of can't change anything while the human reviews the plan.
createConsoleRenderer	The console rendering of runQuery()'s event stream, shared by runChatTui() and by any one-shot run that prints the same events. Streamed text rarely ends in a newline, so every other line (actions, notices, errors) starts by ending the current line only if it isn't already ended — never with a fixed "\n", which leaves a blank line between consecutive actions.
createDeferred	Externally-controllable promise — used to know when a chat turn has finished.
createFileKnowledgeStore	A KnowledgeStore over the markdown files of knowledgeDir.
createFileScopeGate	PreToolUse hook enforcing scope on Read/Write/Edit/Grep, for the main agent and its subagents alike. Bash, when a subagent has it, is not covered: it can reach any path, which is why Bash-granting features stay opt-in.
createFriendlyToolLabel	Builds a friendlyToolLabel(toolName, toolInput) — describe lets the host agent layer its own domain-specific cases (e.g. Playwright's browser_* tools) on top of this kit's generic ones; extraLocalServers names any additional MCP server (beyond this kit's own "approvals"/"manualLogin"/"sourceFiles"/"time") whose tools should be unwrapped without a "[server] " prefix, e.g. "playwright".
createHumanApprovalServer	The tools that ask the person, in every mode but autonomous: request_human_approval (right before an action that publishes something visible to others and that's hard to undo), ask_human (a choice between options, in a panel, within the turn) and, when the session can be in plan mode (modeControl), present_plan, the kit's own way out of plan mode (ADR-023): the person runs the plan, keeps planning or cancels.
createInputQueue	User message queue backed by a single long-lived generator, for any multi-turn (chat-shaped) caller of query().
createKnowledgeServer	The knowledge MCP server over store.
createManualLoginServer	Checkpoint tool for when the agent hits something it can't do itself (typically a login it has no credentials for, or one that fails unexpectedly). Pauses execution until a human confirms they've intervened by hand in whatever live interface the agent is driving (a browser window, say), and then lets the agent continue. There is deliberately no default wording: what counts as a manual intervention is entirely the domain's, so the concrete agent always supplies texts (see AgentSpec.manualInterventionTexts).
createModeControl	A ModeControl starting at initial (buildSessionOptions() returns one for its session).
createPlanGate	PreToolUse hook for "plan" mode: the agent only reads and plans (see checkPlanScope()). Registered for every session that can be in plan mode and deciding only while isActive() says it is; otherwise it gives no decision, so the call goes on as if it weren't there. It's the kit's own gate, not the SDK's permissionMode: "plan" (ADR-023).
createProgressView	The Ink counterpart of createConsoleRenderer() for one-shot ("run"-style) sessions: the same methods and the same text (so onWrite logs exactly what the console version would), plus a spinner with the current action, approval panels and a status bar. Checkpoints go through an Ink InteractionPort until close().
createPromptLoader	Builds a loadPrompt(relativePath, vars) bound to rootDir — so each agent built on this kit supplies its own prompts directory (its own domain content) and gets the same {{key}} substitution/fail-loudly behavior for free.
createRunFolder	Creates a new, empty run folder under runsDir.
createRunStore	A SessionStore (the SDK's adapter for keeping transcripts elsewhere) that keeps one session in one run folder: conversation.jsonl for the main transcript, subagents/*.jsonl for each subagent's, and session.json with the session's id and which file is which subagent's. The SDK appends to it as the transcript grows and loads from it before resuming (confirmed empirically: a resumed session remembers the conversation, its subagents' transcripts included, even with the CLI's own copy deleted). The CLI still writes that copy under ~/.claude/projects/: it can't be turned off while a store is in use.
createSaveToSourcesServer	The tools that keep sourcesDir, the originals the agent reads but never edits (Write/Edit are scoped to the notes folder, see hooks/fileScopeGate.ts): save_to_sources, list_sources and download_to_sources, plus request_file and retire_source when a person can be asked. Nothing is ever overwritten or deleted; the bookkeeping is in sources.ts.
createStepGate	PreToolUse hook for "interactive" mode: pauses before every action and asks for confirmation (by keyboard or by file, see humanInput.ts), like reviewing a plan step by step.
createSubagentBashGate	PreToolUse hook restricting the Bash tool to subagents only, never the main agent directly. See session.ts's buildSessionOptions(), which attaches this hook whenever AgentSpec.buildSubagents() returned something for this config.
createSubagentForegroundGate	PreToolUse hook forcing run_in_background: false on every Agent-tool call that spawns one of this session's own subagents. The Agent tool's own input schema defaults to background execution ("Agents run in the background by default", its own description says) unless the model explicitly opts out per call — confirmed empirically (in a real consuming agent) that with a less directive prompt, the model left it on that default, the main turn's "result" fired before the subagent had done anything at all, and the whole invocation was silently lost: no file written, no error, nothing — because the caller's message loop had no code watching for background-task completion (SDKTaskStartedMessage/SDKTaskUpdatedMessage/etc. are never handled). Setting background: false on the AgentDefinition itself (session.ts's agents: {...}) does NOT fix this — confirmed empirically it has no effect on which way the model's own per-call run_in_background input resolves. Rewriting the tool input here, before it ever executes, is the only lever that actually forces synchronous execution regardless of what the model asked for.
createSubagentTypeGate	PreToolUse hook restricting the Agent tool to the subagent types this session actually registered (session.ts's agents: {...}, from AgentSpec.buildSubagents()) — confirmed empirically that the Agent SDK also exposes a built-in "general-purpose" subagent_type regardless of what agents lists, and that spawning one that way inherits the whole session's own tools (including Bash, whenever any opt-in subagent turned it on) rather than the narrow AgentDefinition.tools each declared subagent actually declares. Without this hook, that built-in type is a way to route around subagentBashGate.ts entirely: once inside it, agent_id is set exactly like an intended subagent, so the Bash-from-main-thread check alone can't tell them apart — this is exactly what happened in practice in a real consuming agent (the model delegated a plain file deletion to a spontaneous "general-purpose" agent to get at Bash, instead of using its own tools and leaving the stray file alone).
createTranscriptLogger	Logs every tool call (request + result) as one JSON line, redacting secrets (e.g. a domain-specific password — see BaseSessionConfig.secrets) plus CLAUDE_CODE_OAUTH_TOKEN, which this kit always scrubs regardless of domain since it owns the auth-token concept (see claudeAuth.ts).
detectLanguage	resolveLanguage() with the running process's arguments, locale and environment.
ensureClaudeAuth	The terminal-facing counterpart to resolveClaudeAuth() (core/claudeAuth.ts), which only looks up a token. This one also gets you one: if resolveClaudeAuth(config) comes back empty, it prints why, offers to run "claude setup-token" interactively, and sets the result on process.env.CLAUDE_CODE_OAUTH_TOKEN for this run. Exits the process if the user declines or cancels — there's no agent to run without a token.
getInteractionPort	The port checkpoints ask through right now, or null.
getLanguage	The language of the kit's texts right now.
getSharedReadline	The registered readline interface, or null.
getTheme	The theme in use right now.
isExitPromptError	True for the error @inquirer/prompts throws when the user cancels (Ctrl+C) a prompt.
isSlug	Whether slug is lowercase ASCII words joined by hyphens.
knowledgePluginRoot	Absolute path of the plugin shipped with the kit, next to dist/ (or src/ under tsx): assets/knowledge-plugin, whose skills work through the knowledge_* tools, or with "files" assets/knowledge-plugin-files, whose skills work on the files (ADR-024).
knowledgePromptSection	The "Knowledge base" section appended to the system prompt: the layout and the working rules. With tools (the kit's default since ADR-024), for a knowledge base reached through the knowledge_* tools, listing pageTypes; otherwise for one kept with the file tools, whose page templates live in the knowledge-pages skill.
linkedIds	The ids every [text](id) link in markdown points to (links that look like page ids).
listRuns	The runs under runsDir that kept a conversation, newest first; runs without session.json are left out.
messagesFor	A language's texts; any it lacks come from English (nested groups key by key).
parseId	type/slug split, or null when it isn't one.
readConversation	The human's messages and the agent's replies in a run's conversation, in order.
resolveClaudeAuth	Pure lookup, no I/O and no console output of any kind — safe to call from a headless/non-interactive consumer (a server, an Electron main process) as much as from a terminal one.
resolveLanguage	The language for the kit's texts and the agent's replies: --language=<code>, then the agent's option, then the system's language, then English. A code that is asked for but isn't supported falls through to the next source, with a warning. Pure: detectLanguage() fills the sources from the running process.
runChatInk	The Ink counterpart of runChatTui(), with the same options, session log and history file: history in the scrollback, the reply streaming in place, a spinner with the current action (and a subagent's), approval panels, "/command" completion and a status bar. Checkpoints go through an Ink InteractionPort while the chat runs, so no second stdin reader ever competes with Ink's; the response file keeps working as always.
runChatTui	A ready-to-run interactive terminal chat loop, assembled from this kit's own chat primitives: createInputQueue() feeds typed lines into a multi-turn query() session, runQuery()'s normalized event stream is rendered to the console (streamed text, friendly action labels via createFriendlyToolLabel(), turn failures), and this loop's own readline.Interface is registered via setSharedReadline() so any human-in-the-loop checkpoint the session hits (the interactive-mode step gate, or the guided-mode approval/ manual-login tools — see terminalInteraction.ts) prompts on the same interface instead of a second one fighting it for stdin's raw mode.
runQuery	Thin wrapper around the SDK's own query(): same two-argument shape (a plain string for a one-shot run, or an AsyncIterable<SDKUserMessage> — see createInputQueue() — for a multi-turn chat), translating its raw message stream into AgentEvents as described above. Every other control surface of the underlying Query (interrupt, close, supportedCommands) is passed through unchanged.
runWizard	Asks steps in order and resolves with every answer by step name. A step's message, choices or default can depend on earlier answers, and when skips it, so a consumer's whole interactive menu becomes a list of step definitions.
setInteractionPort	Installs the port every checkpoint asks through (null: answer through the response file only). One per process.
setLanguage	Sets the language of the kit's texts directly (a host that resolved it itself, tests).
setSharedReadline	Registers the chat's readline interface, so checkpoints ask on it instead of opening a second one (null to unregister).
setTheme	The kit's default theme with overrides on top: only the roles given change.
summarizeToolResponse	Avoids bloating the transcript with large payloads (browser-tool screenshots/base64).
togglePlanMode	What the chats' /plan does: switches control into plan mode, or, when it's already there, back to the mode it was entered from ("guided" if it started in plan mode). Returns the new mode, or null when this session can't be in plan mode (an autonomous one).
truncate	Cuts text to max characters, with "…" at the end.
truncatePath	Cuts a path to max characters from the front, with "…": unlike truncate() (which cuts the tail off long freeform text), a path's most useful part, the file name, is at the end.