@falkenslab/agent-kit 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,105 +1,110 @@
1
- # agent-kit
2
-
3
- [![npm](https://img.shields.io/npm/v/@falkenslab/agent-kit?logo=npm)](https://www.npmjs.com/package/@falkenslab/agent-kit)
4
- [![npm downloads](https://img.shields.io/npm/dm/@falkenslab/agent-kit)](https://www.npmjs.com/package/@falkenslab/agent-kit)
5
- [![types](https://img.shields.io/npm/types/@falkenslab/agent-kit)](https://www.npmjs.com/package/@falkenslab/agent-kit)
6
- [![node](https://img.shields.io/node/v/@falkenslab/agent-kit)](https://nodejs.org/)
7
- [![license](https://img.shields.io/npm/l/@falkenslab/agent-kit)](LICENSE)
8
- [![docs](https://img.shields.io/badge/docs-falkenslab.github.io%2Fagent--kit-d77757)](https://falkenslab.github.io/agent-kit/)
9
-
10
- A foundation for building AI agents on top of the [Claude Agent SDK](https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk). It isn't an agent itself: it solves once what every agent needs (human oversight, safety, memory and a good terminal interface), so each concrete agent only has to write what belongs to its own domain: what it knows how to do, with which tools, and how it talks.
11
-
12
- ## What an agent built with it can do
13
-
14
- - **Work at different levels of oversight.** Autonomous, guided (it asks for permission before anything that can't be undone or that other people will see) or step by step (it asks before every action). Within the same conversation you can switch from guided to step by step and back.
15
- - **Ask a person for help.** It asks for approvals, or stops so someone can do something by hand, such as signing in to a website. It can be answered from the keyboard or from another program driving it, for example a desktop app.
16
- - **Remember between sessions.** It keeps its own knowledge base, a small wiki of notes that grows with every session, and keeps the original documents you give it or that it downloads untouched. Each conversation stays in the project's folder, so you can pick it up again with `--continue` (the latest one) or `/resume` (any of them).
17
- - **Speak your language.** Its interface comes in English, Spanish, French or German, the system's by default or the one you ask for with `--language=fr`, and it answers in that language unless you write to it in another one.
18
- - **Delegate to subagents safely.** Only to the ones it declares, always waiting for their result, and without the main agent being able to slip past its own limits through them.
19
- - **Stay within limits.** It only reads and writes in the folders that belong to it, and never in protected files, such as one holding passwords.
20
- - **Use external tools.** MCP servers of its own or of the project, and skills and commands organized in plugins.
21
- - **Leave a trail.** It records every action and the whole conversation, with secrets hidden.
22
- - **Look the way you want.** The terminal's colors come from a theme by roles (the agent's replies, tool results, the focused option, borders…): pass only the ones you want to change, as a color name, a hex or a function.
23
- - **Chat in a terminal the way Claude Code does.** Full screen, with the reply written live and its markdown already formatted, the tools it uses summed up in one line (Ctrl+O unfolds it), panels for approvals, history and search, a suggestion for the next message, pasted blocks, file mentions with `@`, mouse selection (right-click to copy), and the agent's status in the tab and in the Windows taskbar.
24
- - **Also work without a terminal.** The same foundation runs inside a desktop app or a server, which bring their own interface.
25
-
26
- ## Examples
27
-
28
- ### Captain Whiskers
29
-
30
- [Captain Whiskers](./examples/captain-whiskers) is a toy agent to see the kit in action: a retired pirate cat who tells jokes in the terminal, in your language. It starts full screen with its logo and has a small crew of subagents: one looks for new jokes on the web, another rates them before they're told, and a third tells the time with a tool of the captain's own. It lets you try the different levels of oversight and is the best starting point for an agent of your own. Its README explains how to run it.
31
-
32
- ![Captain Whiskers in Windows Terminal: its logo at the top, the conversation in the middle and the framed prompt at the bottom, with a suggestion for the next message](docs/assets/captain-whiskers.png)
33
-
34
- ### teacher-agent
35
-
36
- [teacher-agent](https://github.com/falkenslab/teacher-agent) is a real assistant for Moodle teachers. It signs in with your account in a Chrome window and works as you would: it grades submissions, answers in the forum, creates or reviews content and sums up how the class is going. It asks for your permission before publishing anything students will see, and takes notes about the course to remember everything in the next session.
37
-
38
- Oversight, memory, safety and the chat come from the kit; teacher-agent brings what it knows about Moodle and driving the browser.
39
-
40
- ## Installation
41
-
42
- ```
43
- npm install @falkenslab/agent-kit
44
- ```
45
-
46
- To try changes to the kit without publishing them, point to a local clone with `"file:../agent-kit"` in your `package.json` and build it with `npm run build` after each change.
47
-
48
- Requires Node.js 20 or later.
49
-
50
- ## A minimal agent
51
-
52
- An agent only describes what belongs to it (who it is, which MCP servers, skills and subagents it has) and picks a level of oversight; the kit sets up the session and the chat:
53
-
54
- ```ts
55
- import path from "node:path";
56
- import { buildSessionOptions, ensureClaudeAuth, runChatInk, type AgentSpec, type BaseSessionConfig } from "@falkenslab/agent-kit";
57
-
58
- // The only part specific to the agent: who it is and what it has.
59
- const spec: AgentSpec<BaseSessionConfig> = {
60
- buildSystemPrompt: () => "You are a pirate cat who tells jokes. Always answer in character.",
61
- buildMcpServers: () => ({}), // its own MCP servers, if any
62
- pluginRoots: () => [], // folders with skills and commands
63
- buildSubagents: () => undefined, // subagents, if it delegates to any
64
- };
65
-
66
- await ensureClaudeAuth(); // offers to create a Claude token if it finds none
67
-
68
- const config: BaseSessionConfig = { mode: "guided", projectDir: process.cwd() };
69
-
70
- // Each run gets a folder of its own under .run/ (keep it out of git): its log, its
71
- // transcript and the conversation, to pick it up again with --continue or /resume.
72
- await runChatInk((run) => buildSessionOptions(config, run.dir, spec, { run }), {
73
- runsDir: path.resolve(".run"),
74
- header: { title: "My agent" },
75
- mode: config.mode, // Shift+Tab switches between guided and step by step
76
- fullscreen: true,
77
- theme: { toolResult: "gray", selection: "#ffb86c" }, // only the colors you want to change
78
- });
79
- ```
80
-
81
- Save it as `agent.ts` in a project with the kit and `tsx` installed and `"type": "module"` in its `package.json`, and run it with `npx tsx agent.ts`. Captain Whiskers is this same skeleton with more pieces: skills, subagents and its logo.
82
-
83
- ## Documentation
84
-
85
- The full documentation is at **[falkenslab.github.io/agent-kit](https://falkenslab.github.io/agent-kit/)**: a tutorial, guides for every part of the kit (modes, human in the loop, security, tools, subagents, the knowledge base, the terminal UI, runs, languages, themes, hosts without a terminal), recipes, and an API reference generated from the source, for each released version.
86
-
87
- For whoever works on the kit itself, the specification in [`.minispec/`](./.minispec/README.md) explains how each part is built and why, including the SDK behaviors checked by hand that motivate several of its safeguards.
88
-
89
- ## Development
90
-
91
- | Command | What it does |
92
- | --- | --- |
93
- | `npm run build` | Builds the kit into `dist/` |
94
- | `npm run typecheck` | Checks the types without building |
95
- | `npm run lint` | Checks the code style |
96
- | `npm test` | Runs all the tests |
97
- | `npm run docs:install` | Installs the documentation site's dependencies (once) |
98
- | `npm run docs:start` | Serves the documentation site locally, reloading on changes |
99
- | `npm run docs:build` | Builds the documentation site (fails on broken links) |
100
-
101
- To run a single test file:
102
-
103
- ```
104
- npx tsx --test test/tui/promptErrors.test.ts
105
- ```
1
+ <h1>
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-readme-dark.svg">
4
+ <img src="docs/assets/logo-readme.svg" alt="agent-kit" height="64">
5
+ </picture>
6
+ </h1>
7
+
8
+ [![npm](https://img.shields.io/npm/v/@falkenslab/agent-kit?logo=npm)](https://www.npmjs.com/package/@falkenslab/agent-kit)
9
+ [![npm downloads](https://img.shields.io/npm/dm/@falkenslab/agent-kit)](https://www.npmjs.com/package/@falkenslab/agent-kit)
10
+ [![types](https://img.shields.io/npm/types/@falkenslab/agent-kit)](https://www.npmjs.com/package/@falkenslab/agent-kit)
11
+ [![node](https://img.shields.io/node/v/@falkenslab/agent-kit)](https://nodejs.org/)
12
+ [![license](https://img.shields.io/npm/l/@falkenslab/agent-kit)](LICENSE)
13
+ [![docs](https://img.shields.io/badge/docs-falkenslab.github.io%2Fagent--kit-4453b8)](https://falkenslab.github.io/agent-kit/)
14
+
15
+ A foundation for building AI agents on top of the [Claude Agent SDK](https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk). It isn't an agent itself: it solves once what every agent needs (human oversight, safety, memory and a good terminal interface), so each concrete agent only has to write what belongs to its own domain: what it knows how to do, with which tools, and how it talks.
16
+
17
+ ## What an agent built with it can do
18
+
19
+ - **Work at different levels of oversight.** Autonomous, guided (it asks for permission before anything that can't be undone or that other people will see) or step by step (it asks before every action), and a plan mode where it only reads and plans until you let it act. Within the same conversation you can switch among guided, step by step and plan.
20
+ - **Ask a person for help.** It asks for approvals, or stops so someone can do something by hand, such as signing in to a website. It can be answered from the keyboard or from another program driving it, for example a desktop app.
21
+ - **Remember between sessions.** It keeps its own knowledge base, a small wiki of notes that grows with every session, and keeps the original documents you give it or that it downloads untouched. Each conversation stays in the project's folder, so you can pick it up again with `--continue` (the latest one) or `/resume` (any of them).
22
+ - **Speak your language.** Its interface comes in English, Spanish, French or German, the system's by default or the one you ask for with `--language=fr`, and it answers in that language unless you write to it in another one.
23
+ - **Delegate to subagents safely.** Only to the ones it declares, always waiting for their result, and without the main agent being able to slip past its own limits through them.
24
+ - **Stay within limits.** It only reads and writes in the folders that belong to it, and never in protected files, such as one holding passwords.
25
+ - **Use external tools.** MCP servers of its own or of the project, and skills and commands organized in plugins.
26
+ - **Leave a trail.** It records every action and the whole conversation, with secrets hidden.
27
+ - **Look the way you want.** The terminal's colors come from a theme by roles (the agent's replies, tool results, the focused option, borders…): pass only the ones you want to change, as a color name, a hex or a function.
28
+ - **Chat in a terminal the way Claude Code does.** Full screen, with the reply written live and its markdown already formatted, the tools it uses summed up in one line (Ctrl+O unfolds it), panels for approvals, history and search, a suggestion for the next message, pasted blocks, file mentions with `@`, mouse selection (right-click to copy), and the agent's status in the tab and in the Windows taskbar.
29
+ - **Also work without a terminal.** The same foundation runs inside a desktop app or a server, which bring their own interface.
30
+
31
+ ## Examples
32
+
33
+ ### Captain Whiskers
34
+
35
+ [Captain Whiskers](./examples/captain-whiskers) is a toy agent to see the kit in action: a retired pirate cat who tells jokes in the terminal, in your language. It starts full screen with its logo and has a small crew of subagents: one looks for new jokes on the web, another rates them before they're told, and a third tells the time with a tool of the captain's own. It lets you try the different levels of oversight and is the best starting point for an agent of your own. Its README explains how to run it.
36
+
37
+ ![Captain Whiskers in Windows Terminal: its logo at the top, the conversation in the middle and the framed prompt at the bottom, with a suggestion for the next message](docs/assets/captain-whiskers.png)
38
+
39
+ ### teacher-agent
40
+
41
+ [teacher-agent](https://github.com/falkenslab/teacher-agent) is a real assistant for Moodle teachers. It signs in with your account in a Chrome window and works as you would: it grades submissions, answers in the forum, creates or reviews content and sums up how the class is going. It asks for your permission before publishing anything students will see, and takes notes about the course to remember everything in the next session.
42
+
43
+ Oversight, memory, safety and the chat come from the kit; teacher-agent brings what it knows about Moodle and driving the browser.
44
+
45
+ ## Installation
46
+
47
+ ```
48
+ npm install @falkenslab/agent-kit
49
+ ```
50
+
51
+ To try changes to the kit without publishing them, point to a local clone with `"file:../agent-kit"` in your `package.json` and build it with `npm run build` after each change.
52
+
53
+ Requires Node.js 20 or later.
54
+
55
+ ## A minimal agent
56
+
57
+ An agent only describes what belongs to it (who it is, which MCP servers, skills and subagents it has) and picks a level of oversight; the kit sets up the session and the chat:
58
+
59
+ ```ts
60
+ import path from "node:path";
61
+ import { buildSessionOptions, ensureClaudeAuth, runChatInk, type AgentSpec, type BaseSessionConfig } from "@falkenslab/agent-kit";
62
+
63
+ // The only part specific to the agent: who it is and what it has.
64
+ const spec: AgentSpec<BaseSessionConfig> = {
65
+ buildSystemPrompt: () => "You are a pirate cat who tells jokes. Always answer in character.",
66
+ buildMcpServers: () => ({}), // its own MCP servers, if any
67
+ pluginRoots: () => [], // folders with skills and commands
68
+ buildSubagents: () => undefined, // subagents, if it delegates to any
69
+ };
70
+
71
+ await ensureClaudeAuth(); // offers to create a Claude token if it finds none
72
+
73
+ const config: BaseSessionConfig = { mode: "guided", projectDir: process.cwd() };
74
+
75
+ // Each run gets a folder of its own under .run/ (keep it out of git): its log, its
76
+ // transcript and the conversation, to pick it up again with --continue or /resume.
77
+ await runChatInk((run) => buildSessionOptions(config, run.dir, spec, { run }), {
78
+ runsDir: path.resolve(".run"),
79
+ header: { title: "My agent" },
80
+ mode: config.mode, // Shift+Tab cycles through guided, step by step and plan
81
+ fullscreen: true,
82
+ theme: { toolResult: "gray", selection: "#ffb86c" }, // only the colors you want to change
83
+ });
84
+ ```
85
+
86
+ Save it as `agent.ts` in a project with the kit and `tsx` installed and `"type": "module"` in its `package.json`, and run it with `npx tsx agent.ts`. Captain Whiskers is this same skeleton with more pieces: skills, subagents and its logo.
87
+
88
+ ## Documentation
89
+
90
+ The full documentation is at **[falkenslab.github.io/agent-kit](https://falkenslab.github.io/agent-kit/)**: a tutorial, guides for every part of the kit (modes, human in the loop, security, tools, subagents, the knowledge base, the terminal UI, runs, languages, themes, hosts without a terminal), recipes, and an API reference generated from the source, for each released version.
91
+
92
+ For whoever works on the kit itself, the specification in [`.minispec/`](./.minispec/README.md) explains how each part is built and why, including the SDK behaviors checked by hand that motivate several of its safeguards.
93
+
94
+ ## Development
95
+
96
+ | Command | What it does |
97
+ | --- | --- |
98
+ | `npm run build` | Builds the kit into `dist/` |
99
+ | `npm run typecheck` | Checks the types without building |
100
+ | `npm run lint` | Checks the code style |
101
+ | `npm test` | Runs all the tests |
102
+ | `npm run docs:install` | Installs the documentation site's dependencies (once) |
103
+ | `npm run docs:start` | Serves the documentation site locally, reloading on changes |
104
+ | `npm run docs:build` | Builds the documentation site (fails on broken links) |
105
+
106
+ To run a single test file:
107
+
108
+ ```
109
+ npx tsx --test test/tui/promptErrors.test.ts
110
+ ```
@@ -3,7 +3,8 @@ import type { AgentDefinition as SdkSubagentDefinition, McpServerConfig, Setting
3
3
  * The human-supervision spectrum every agent built on this kit shares, independent of
4
4
  * domain: "interactive" pauses before every single action, "guided" only pauses before a
5
5
  * hard-to-undo/visible-to-others action, "autonomous" has no human-in-the-loop channel at
6
- * all. See session.ts's buildSessionOptions() for exactly what each mode changes.
6
+ * all, and "plan" only reads and plans: nothing is changed until the human leaves it (see
7
+ * hooks/planGate.ts). See session.ts's buildSessionOptions() for exactly what each mode changes.
7
8
  *
8
9
  * Deliberately orthogonal to whether the session is a one-shot run or a multi-turn chat
9
10
  * (that's a matter of which entry point the caller uses — a single `query()` call vs.
@@ -12,7 +13,7 @@ import type { AgentDefinition as SdkSubagentDefinition, McpServerConfig, Setting
12
13
  * different system-prompt template) should track that as its own domain field on its
13
14
  * config type, not conflate it with `Mode`.
14
15
  */
15
- export type Mode = "interactive" | "guided" | "autonomous";
16
+ export type Mode = "interactive" | "guided" | "autonomous" | "plan";
16
17
  /**
17
18
  * The minimum a config object needs to drive `buildSessionOptions()` — a concrete agent's
18
19
  * own config type (e.g. a `Config`) extends this with whatever domain fields
@@ -159,4 +160,25 @@ export interface AgentSpec<TConfig extends BaseSessionConfig> {
159
160
  checkpointLines: string[];
160
161
  checkpointQuestion?: string;
161
162
  };
163
+ /**
164
+ * What the agent may still do in "plan" mode, where it only reads and plans (see
165
+ * hooks/planGate.ts). Without it, the agent can read, search, ask a human and delegate,
166
+ * writes nothing and presents its plan in its reply.
167
+ */
168
+ planMode?: PlanModeSpec<TConfig>;
169
+ }
170
+ /** The domain's part of "plan" mode: which files hold the plan and which of its own tools only read. */
171
+ export interface PlanModeSpec<TConfig extends BaseSessionConfig = BaseSessionConfig> {
172
+ /**
173
+ * Whether `filePath` (absolute) is a plan file Write/Edit may touch in plan mode, e.g.
174
+ * `drafts/<slug>/plan.md`. It must also be writable under the file scope (`knowledgeDir`
175
+ * or `extraWritableDirs`), which still applies.
176
+ */
177
+ isPlanFile?(filePath: string, config: TConfig): boolean;
178
+ /**
179
+ * Whether one of the agent's own MCP tools (`mcp__<server>__<tool>`) only reads, so plan
180
+ * mode lets it run. Every MCP tool it doesn't vouch for is denied there: a forgotten tool
181
+ * can't change anything.
182
+ */
183
+ isReadOnlyTool?(toolName: string, input: Record<string, unknown>): boolean;
162
184
  }
@@ -0,0 +1,23 @@
1
+ import type { HookCallback } from "@anthropic-ai/claude-agent-sdk";
2
+ /** What plan mode lets through besides reading: see createPlanGate(). */
3
+ export interface PlanScope {
4
+ /** Base for relative paths: the session's cwd. */
5
+ projectDir: string;
6
+ /** Whether Write/Edit may touch this file (absolute) in plan mode. */
7
+ isPlanFile?(filePath: string): boolean;
8
+ /** Whether one of the agent's own MCP tools only reads. */
9
+ isReadOnlyTool?(toolName: string, input: Record<string, unknown>): boolean;
10
+ }
11
+ /**
12
+ * The reason to deny `toolName` with `input` in plan mode, or `undefined` to let it through.
13
+ * Anything not known to only read is denied, so a tool nobody thought of can't change
14
+ * anything while the human reviews the plan.
15
+ */
16
+ export declare function checkPlanScope(scope: PlanScope, toolName: string, input: Record<string, unknown>): string | undefined;
17
+ /**
18
+ * PreToolUse hook for "plan" mode: the agent only reads and plans (see checkPlanScope()).
19
+ * Registered for every session that can be in plan mode and deciding only while `isActive()`
20
+ * says it is; otherwise it gives no decision, so the call goes on as if it weren't there.
21
+ * It's the kit's own gate, not the SDK's `permissionMode: "plan"` (ADR-023).
22
+ */
23
+ export declare function createPlanGate(scope: PlanScope, isActive: () => boolean): HookCallback;
@@ -0,0 +1,52 @@
1
+ import path from "node:path";
2
+ /** Built-in tools that only read, search, load a skill or delegate (a subagent's own calls come through this gate too). */
3
+ const READING_TOOLS = new Set(["Read", "Glob", "Grep", "WebFetch", "WebSearch", "Skill", "Agent"]);
4
+ /** The kit's own MCP tools that only ask a human: approvals and manual intervention. */
5
+ const ASKING_SERVERS = ["mcp__approvals__", "mcp__manualLogin__"];
6
+ /** Why a call is denied in plan mode, and what the model should do instead. */
7
+ const denial = "Plan mode: nothing can be changed until the user leaves plan mode. Keep reading and researching, then present the plan; the user switches out of plan mode when they want it carried out.";
8
+ /**
9
+ * The reason to deny `toolName` with `input` in plan mode, or `undefined` to let it through.
10
+ * Anything not known to only read is denied, so a tool nobody thought of can't change
11
+ * anything while the human reviews the plan.
12
+ */
13
+ export function checkPlanScope(scope, toolName, input) {
14
+ if (READING_TOOLS.has(toolName))
15
+ return undefined;
16
+ if (ASKING_SERVERS.some((prefix) => toolName.startsWith(prefix)))
17
+ return undefined;
18
+ if (toolName === "Write" || toolName === "Edit") {
19
+ const target = typeof input.file_path === "string" && input.file_path !== "" ? path.resolve(scope.projectDir, input.file_path) : undefined;
20
+ if (target && scope.isPlanFile?.(target))
21
+ return undefined;
22
+ return scope.isPlanFile
23
+ ? `Plan mode: "${String(input.file_path)}" isn't a plan file, and nothing else can be written until the user leaves plan mode. Write the plan to its plan file.`
24
+ : denial;
25
+ }
26
+ if (toolName.startsWith("mcp__") && scope.isReadOnlyTool?.(toolName, input))
27
+ return undefined;
28
+ return denial;
29
+ }
30
+ /**
31
+ * PreToolUse hook for "plan" mode: the agent only reads and plans (see checkPlanScope()).
32
+ * Registered for every session that can be in plan mode and deciding only while `isActive()`
33
+ * says it is; otherwise it gives no decision, so the call goes on as if it weren't there.
34
+ * It's the kit's own gate, not the SDK's `permissionMode: "plan"` (ADR-023).
35
+ */
36
+ export function createPlanGate(scope, isActive) {
37
+ return async (input) => {
38
+ if (!isActive())
39
+ return {};
40
+ const pre = input;
41
+ const reason = checkPlanScope(scope, pre.tool_name, (pre.tool_input ?? {}));
42
+ if (!reason)
43
+ return {};
44
+ return {
45
+ hookSpecificOutput: {
46
+ hookEventName: pre.hook_event_name,
47
+ permissionDecision: "deny",
48
+ permissionDecisionReason: reason,
49
+ },
50
+ };
51
+ };
52
+ }
@@ -1,5 +1,5 @@
1
1
  const plural = (count, one, many) => (count === 1 ? one : many);
2
- const MODES = { autonomous: "autonom", guided: "geführt", interactive: "interaktiv" };
2
+ const MODES = { autonomous: "autonom", guided: "geführt", interactive: "interaktiv", plan: "Plan" };
3
3
  export const de = {
4
4
  thinking: "Denkt nach…",
5
5
  escToInterrupt: "Esc zum Unterbrechen",
@@ -35,6 +35,7 @@ export const de = {
35
35
  "Esc unterbrechen · Strg+C unterbrechen oder beenden · Bild↑/Bild↓ oder Mausrad scrollen · Strg+Ende ganz nach unten",
36
36
  "Ziehen zum Markieren, Rechtsklick zum Kopieren (Vollbild)",
37
37
  "/resume ein früheres Gespräch fortsetzen · --continue beim Start setzt das letzte fort",
38
+ "/plan Planmodus ein- oder ausschalten: der Agent liest und plant nur, bis du ihn verlässt",
38
39
  ],
39
40
  moreLines: (count) => `… (${count} weitere Zeilen)`,
40
41
  proceed: "Möchtest du fortfahren?",
@@ -34,6 +34,7 @@ export const en = {
34
34
  "Esc interrupt · Ctrl+C interrupt or exit · PgUp/PgDn or wheel scroll · Ctrl+End bottom",
35
35
  "Drag to select, right-click to copy (full screen)",
36
36
  "/resume resume an earlier conversation · --continue on the command line resumes the latest one",
37
+ "/plan plan mode on or off: the agent only reads and plans until you leave it",
37
38
  ],
38
39
  moreLines: (count) => `… (${count} more lines)`,
39
40
  proceed: "Do you want to proceed?",
@@ -1,5 +1,5 @@
1
1
  const plural = (count, one, many) => (count === 1 ? one : many);
2
- const MODES = { autonomous: "autónomo", guided: "guiado", interactive: "interactivo" };
2
+ const MODES = { autonomous: "autónomo", guided: "guiado", interactive: "interactivo", plan: "plan" };
3
3
  export const es = {
4
4
  thinking: "Pensando…",
5
5
  escToInterrupt: "esc para interrumpir",
@@ -35,6 +35,7 @@ export const es = {
35
35
  "Esc interrumpir · Ctrl+C interrumpir o salir · RePág/AvPág o rueda desplazarse · Ctrl+Fin abajo del todo",
36
36
  "Arrastrar para seleccionar, clic derecho para copiar (pantalla completa)",
37
37
  "/resume retomar una conversación anterior · --continue al arrancar retoma la última",
38
+ "/plan activar o desactivar el modo plan: el agente solo lee y planifica hasta que salgas",
38
39
  ],
39
40
  moreLines: (count) => `… (${count} líneas más)`,
40
41
  proceed: "¿Quieres continuar?",
@@ -1,5 +1,5 @@
1
1
  const plural = (count, one, many) => (count === 1 ? one : many);
2
- const MODES = { autonomous: "autonome", guided: "guidé", interactive: "interactif" };
2
+ const MODES = { autonomous: "autonome", guided: "guidé", interactive: "interactif", plan: "plan" };
3
3
  export const fr = {
4
4
  thinking: "Réflexion…",
5
5
  escToInterrupt: "échap pour interrompre",
@@ -35,6 +35,7 @@ export const fr = {
35
35
  "Échap interrompre · Ctrl+C interrompre ou quitter · PgPréc/PgSuiv ou molette défiler · Ctrl+Fin tout en bas",
36
36
  "Glisser pour sélectionner, clic droit pour copier (plein écran)",
37
37
  "/resume reprendre une conversation précédente · --continue au démarrage reprend la dernière",
38
+ "/plan activer ou quitter le mode plan : l'agent lit et planifie seulement jusqu'à ce que vous en sortiez",
38
39
  ],
39
40
  moreLines: (count) => `… (${count} lignes de plus)`,
40
41
  proceed: "Voulez-vous continuer ?",
package/dist/core/runs.js CHANGED
@@ -151,6 +151,8 @@ export function entryText(entry) {
151
151
  .map((part) => part.text ?? "")
152
152
  .join("");
153
153
  }
154
+ // The kit's own notes to the model (a plan-mode switch) go before the human's words.
155
+ text = text.replace(/<system-reminder>[\s\S]*?<\/system-reminder>\s*/g, "");
154
156
  // Slash commands and the CLI's own notes arrive as tagged text, not as the human's words.
155
157
  if (!text.trim() || /^\s*<[a-z-]+>/.test(text))
156
158
  return null;
@@ -15,8 +15,8 @@ import { type RunFolder } from "./runs.js";
15
15
  * fields on `BaseSessionConfig`.
16
16
  *
17
17
  * The per-mode behavioral differences (whether the approval/manual-intervention tools
18
- * exist, whether the interactive step gate hook runs) all fall out of `config.mode`
19
- * alone.
18
+ * exist, whether the interactive step gate or the plan gate decides) all fall out of
19
+ * `config.mode` and the session's `ModeControl` alone.
20
20
  *
21
21
  * `options.run` keeps the SDK's transcript of the conversation in that run folder (see
22
22
  * runs.ts's createRunStore()) and, when it has a session already, resumes it: the chat
@@ -33,22 +33,35 @@ export declare function buildSessionOptions<TConfig extends BaseSessionConfig>(c
33
33
  language: Language;
34
34
  }>;
35
35
  /**
36
- * The supervision mode of a running session. Only "guided" and "interactive" can switch into
37
- * each other: they share the same tools (the approval tool) and the step gate is registered
38
- * in both, asking only in "interactive". "autonomous" has no approval tool at all, and a tool
39
- * can't appear or vanish mid-session, so a session that starts autonomous stays autonomous,
40
- * and one that doesn't can't become autonomous. The system prompt keeps the mode it was
41
- * built with.
36
+ * The supervision mode of a running session. "guided", "interactive" and "plan" switch into
37
+ * one another: they share the same tools (the approval tool), and the step gate and the plan
38
+ * gate are registered in all three, deciding only in their own mode. "autonomous" has no
39
+ * approval tool at all, and a tool can't appear or vanish mid-session, so a session that
40
+ * starts autonomous stays autonomous, and one that doesn't can't become autonomous. The
41
+ * system prompt keeps the mode it was built with, so entering or leaving plan mode is told
42
+ * to the model with the next message instead (`takeNotice()`).
42
43
  */
43
44
  export interface ModeControl {
44
45
  readonly mode: Mode;
45
- /** The modes this session can be in; fewer than two means it can't switch. */
46
+ /** The modes this session can be in, in Shift+Tab's order; fewer than two means it can't switch. */
46
47
  readonly switchable: readonly Mode[];
47
48
  /** Switches to `next` if this session allows it; returns whether it did. */
48
49
  set(next: Mode): boolean;
50
+ /**
51
+ * The note telling the model it entered or left plan mode, once per change it hasn't been
52
+ * told about yet; `undefined` otherwise. `createInputQueue({ modeControl })` puts it before
53
+ * the next message; a caller with its own queue prepends it itself.
54
+ */
55
+ takeNotice?(): string | undefined;
49
56
  }
50
57
  /** A `ModeControl` starting at `initial` (`buildSessionOptions()` returns one for its session). */
51
58
  export declare function createModeControl(initial: Mode): ModeControl;
59
+ /**
60
+ * What the chats' `/plan` does: switches `control` into plan mode, or, when it's already
61
+ * there, back to the mode it was entered from ("guided" if it started in plan mode). Returns
62
+ * the new mode, or `null` when this session can't be in plan mode (an autonomous one).
63
+ */
64
+ export declare function togglePlanMode(control: ModeControl): Mode | null;
52
65
  /**
53
66
  * User message queue backed by a single long-lived generator, for any multi-turn
54
67
  * (chat-shaped) caller of `query()`.
@@ -59,8 +72,13 @@ export declare function createModeControl(initial: Mode): ModeControl;
59
72
  * "ProcessTransport is not ready for writing". A real multi-turn conversation needs a
60
73
  * single generator that never finishes on its own: messages get pushed into it with
61
74
  * `push()` and it's only explicitly closed with `end()` when leaving the chat.
75
+ *
76
+ * With `modeControl`, each message goes after the note on a plan-mode switch the model
77
+ * hasn't been told about yet (`ModeControl.takeNotice()`).
62
78
  */
63
- export declare function createInputQueue(): {
79
+ export declare function createInputQueue(options?: {
80
+ modeControl?: ModeControl;
81
+ }): {
64
82
  push: (text: string) => void;
65
83
  end: () => void;
66
84
  iterable: AsyncIterable<SDKUserMessage>;
@@ -5,6 +5,7 @@ import { createSubagentBashGate } from "./hooks/subagentBashGate.js";
5
5
  import { createSubagentTypeGate } from "./hooks/subagentTypeGate.js";
6
6
  import { createSubagentForegroundGate } from "./hooks/subagentForegroundGate.js";
7
7
  import { createFileScopeGate } from "./hooks/fileScopeGate.js";
8
+ import { createPlanGate } from "./hooks/planGate.js";
8
9
  import { createHumanApprovalServer } from "./tools/humanApproval.js";
9
10
  import { createManualLoginServer } from "./tools/manualLogin.js";
10
11
  import { createSaveToSourcesServer } from "./tools/saveToSources.js";
@@ -25,8 +26,8 @@ import { createRunStore } from "./runs.js";
25
26
  * fields on `BaseSessionConfig`.
26
27
  *
27
28
  * The per-mode behavioral differences (whether the approval/manual-intervention tools
28
- * exist, whether the interactive step gate hook runs) all fall out of `config.mode`
29
- * alone.
29
+ * exist, whether the interactive step gate or the plan gate decides) all fall out of
30
+ * `config.mode` and the session's `ModeControl` alone.
30
31
  *
31
32
  * `options.run` keeps the SDK's transcript of the conversation in that run folder (see
32
33
  * runs.ts's createRunStore()) and, when it has a session already, resumes it: the chat
@@ -166,6 +167,21 @@ export async function buildSessionOptions(config, runDir, spec, options = {}) {
166
167
  // Registered wherever the approval tool is, and asking only while the current mode is
167
168
  // "interactive": a guided session can switch to interactive and back (ModeControl).
168
169
  ...(includeApprovalTool ? [{ hooks: [createStepGate(runDir, () => modeControl.mode === "interactive")] }] : []),
170
+ // Likewise for "plan", which any non-autonomous session can switch into: the agent
171
+ // only reads and plans while it's on (hooks/planGate.ts).
172
+ ...(includeApprovalTool
173
+ ? [
174
+ {
175
+ hooks: [
176
+ createPlanGate({
177
+ projectDir: config.projectDir,
178
+ ...(spec.planMode?.isPlanFile ? { isPlanFile: (filePath) => spec.planMode.isPlanFile(filePath, config) } : {}),
179
+ ...(spec.planMode?.isReadOnlyTool ? { isReadOnlyTool: spec.planMode.isReadOnlyTool } : {}),
180
+ }, () => modeControl.mode === "plan"),
181
+ ],
182
+ },
183
+ ]
184
+ : []),
169
185
  ...(includeSubagentTools
170
186
  ? [
171
187
  { hooks: [createSubagentTypeGate(allowedSubagentTypes)] },
@@ -189,7 +205,10 @@ function skillList(skills, includeKnowledgeBase) {
189
205
  /** A `ModeControl` starting at `initial` (`buildSessionOptions()` returns one for its session). */
190
206
  export function createModeControl(initial) {
191
207
  let current = initial;
192
- const switchable = initial === "autonomous" ? ["autonomous"] : ["guided", "interactive"];
208
+ // The mode the model was last told about: a session starting in plan mode tells it with
209
+ // the first message, since the system prompt doesn't say.
210
+ let told = initial === "plan" ? undefined : initial;
211
+ const switchable = initial === "autonomous" ? ["autonomous"] : ["guided", "interactive", "plan"];
193
212
  return {
194
213
  get mode() {
195
214
  return current;
@@ -201,8 +220,40 @@ export function createModeControl(initial) {
201
220
  current = next;
202
221
  return true;
203
222
  },
223
+ takeNotice() {
224
+ const before = told;
225
+ told = current;
226
+ if (current === "plan" && before !== "plan")
227
+ return PLAN_MODE_ENTERED;
228
+ if (current !== "plan" && before === "plan")
229
+ return PLAN_MODE_LEFT;
230
+ return undefined;
231
+ },
204
232
  };
205
233
  }
234
+ // The mode each session was in when `/plan` took it into plan mode, to go back to.
235
+ const modeBeforePlan = new WeakMap();
236
+ /**
237
+ * What the chats' `/plan` does: switches `control` into plan mode, or, when it's already
238
+ * there, back to the mode it was entered from ("guided" if it started in plan mode). Returns
239
+ * the new mode, or `null` when this session can't be in plan mode (an autonomous one).
240
+ */
241
+ export function togglePlanMode(control) {
242
+ if (!control.switchable.includes("plan"))
243
+ return null;
244
+ if (control.mode === "plan") {
245
+ const back = modeBeforePlan.get(control) ?? "guided";
246
+ control.set(back);
247
+ return back;
248
+ }
249
+ modeBeforePlan.set(control, control.mode);
250
+ control.set("plan");
251
+ return "plan";
252
+ }
253
+ // What the model reads on a plan-mode switch, in English like the rest of what it reads
254
+ // (ADR-019); tagged so a resumed conversation doesn't show it as the human's words (runs.ts).
255
+ const PLAN_MODE_ENTERED = "<system-reminder>The user switched to plan mode. Only read, research and plan: nothing can be changed (files, tools that modify something) until they switch out of it. When the plan is ready, present it and wait for them.</system-reminder>";
256
+ const PLAN_MODE_LEFT = "<system-reminder>The user left plan mode: you can carry out the plan now.</system-reminder>";
206
257
  /**
207
258
  * User message queue backed by a single long-lived generator, for any multi-turn
208
259
  * (chat-shaped) caller of `query()`.
@@ -213,8 +264,11 @@ export function createModeControl(initial) {
213
264
  * "ProcessTransport is not ready for writing". A real multi-turn conversation needs a
214
265
  * single generator that never finishes on its own: messages get pushed into it with
215
266
  * `push()` and it's only explicitly closed with `end()` when leaving the chat.
267
+ *
268
+ * With `modeControl`, each message goes after the note on a plan-mode switch the model
269
+ * hasn't been told about yet (`ModeControl.takeNotice()`).
216
270
  */
217
- export function createInputQueue() {
271
+ export function createInputQueue(options = {}) {
218
272
  const pending = [];
219
273
  let wake = null;
220
274
  let ended = false;
@@ -236,7 +290,8 @@ export function createInputQueue() {
236
290
  }
237
291
  return {
238
292
  push(text) {
239
- pending.push(text);
293
+ const notice = options.modeControl?.takeNotice?.();
294
+ pending.push(notice ? `${notice}\n\n${text}` : text);
240
295
  wake?.();
241
296
  wake = null;
242
297
  },
package/dist/index.d.ts CHANGED
@@ -6,8 +6,8 @@ export { createPromptLoader } from "./core/promptTemplate.js";
6
6
  export { resolveClaudeAuth, type ClaudeAuthConfig } from "./core/claudeAuth.js";
7
7
  export { ensureClaudeAuth } from "./tui/claudeAuth.js";
8
8
  export { createFriendlyToolLabel, truncate, truncatePath, type ToolDescriber, } from "./core/toolLabels.js";
9
- export type { Mode, BaseSessionConfig, AgentSpec } from "./core/agentSpec.js";
10
- export { buildSessionOptions, createInputQueue, createDeferred, createModeControl, type ModeControl } from "./core/session.js";
9
+ export type { Mode, BaseSessionConfig, AgentSpec, PlanModeSpec } from "./core/agentSpec.js";
10
+ export { buildSessionOptions, createInputQueue, createDeferred, createModeControl, togglePlanMode, type ModeControl } from "./core/session.js";
11
11
  export { runQuery, type AgentEvent, type AgentRun, type SessionUsage, type ContextUsage } from "./core/runner.js";
12
12
  export { knowledgePluginRoot, knowledgePromptSection } from "./core/knowledge.js";
13
13
  export { resolveLanguage, detectLanguage, SUPPORTED_LANGUAGES, type Language, type LanguageSources, type ResolvedLanguage, } from "./core/language.js";
@@ -21,6 +21,7 @@ export { createSubagentBashGate } from "./core/hooks/subagentBashGate.js";
21
21
  export { createSubagentTypeGate } from "./core/hooks/subagentTypeGate.js";
22
22
  export { createSubagentForegroundGate } from "./core/hooks/subagentForegroundGate.js";
23
23
  export { createFileScopeGate, checkFileScope, type FileScope } from "./core/hooks/fileScopeGate.js";
24
+ export { createPlanGate, checkPlanScope, type PlanScope } from "./core/hooks/planGate.js";
24
25
  export { askForDecision, askForManualIntervention } from "./core/hooks/humanInput.js";
25
26
  export { setInteractionPort, getInteractionPort, type InteractionPort, type ApprovalPrompt } from "./core/interaction.js";
26
27
  export { terminalInteractionPort, setSharedReadline, getSharedReadline } from "./tui/terminalInteraction.js";
package/dist/index.js CHANGED
@@ -8,7 +8,7 @@ export { createPromptLoader } from "./core/promptTemplate.js";
8
8
  export { resolveClaudeAuth } from "./core/claudeAuth.js";
9
9
  export { ensureClaudeAuth } from "./tui/claudeAuth.js";
10
10
  export { createFriendlyToolLabel, truncate, truncatePath, } from "./core/toolLabels.js";
11
- export { buildSessionOptions, createInputQueue, createDeferred, createModeControl } from "./core/session.js";
11
+ export { buildSessionOptions, createInputQueue, createDeferred, createModeControl, togglePlanMode } from "./core/session.js";
12
12
  export { runQuery } from "./core/runner.js";
13
13
  export { knowledgePluginRoot, knowledgePromptSection } from "./core/knowledge.js";
14
14
  export { resolveLanguage, detectLanguage, SUPPORTED_LANGUAGES, } from "./core/language.js";
@@ -23,6 +23,7 @@ export { createSubagentBashGate } from "./core/hooks/subagentBashGate.js";
23
23
  export { createSubagentTypeGate } from "./core/hooks/subagentTypeGate.js";
24
24
  export { createSubagentForegroundGate } from "./core/hooks/subagentForegroundGate.js";
25
25
  export { createFileScopeGate, checkFileScope } from "./core/hooks/fileScopeGate.js";
26
+ export { createPlanGate, checkPlanScope } from "./core/hooks/planGate.js";
26
27
  export { askForDecision, askForManualIntervention } from "./core/hooks/humanInput.js";
27
28
  export { setInteractionPort, getInteractionPort } from "./core/interaction.js";
28
29
  export { terminalInteractionPort, setSharedReadline, getSharedReadline } from "./tui/terminalInteraction.js";
@@ -1,4 +1,5 @@
1
1
  import type { Options } from "@anthropic-ai/claude-agent-sdk";
2
+ import { type ModeControl } from "../core/session.js";
2
3
  import { type AgentEvent } from "../core/runner.js";
3
4
  import { type Theme } from "./theme.js";
4
5
  import { type SessionOpener } from "./runs.js";
@@ -72,6 +73,13 @@ export interface ChatTuiOptions {
72
73
  * conversation, tool results included and not redacted: keep it out of version control.
73
74
  */
74
75
  runsDir?: string;
76
+ /**
77
+ * The session's mode control (`buildSessionOptions()` returns it): `/plan` switches into
78
+ * plan mode and back (an autonomous session can't switch), and entering or leaving plan
79
+ * mode is told to the model with the next message. With a session opener, the one it
80
+ * returns is used instead.
81
+ */
82
+ modeControl?: ModeControl;
75
83
  /**
76
84
  * Colors for the kit's roles (see `Theme`), on top of the kit's defaults: only the roles
77
85
  * given change, e.g. `{ toolResult: "yellow", selection: "#00ff00" }`. One theme per
@@ -3,7 +3,7 @@ import { stdin, stdout } from "node:process";
3
3
  import { createWriteStream } from "node:fs";
4
4
  import { mkdir, readFile, writeFile } from "node:fs/promises";
5
5
  import path from "node:path";
6
- import { createInputQueue } from "../core/session.js";
6
+ import { createInputQueue, togglePlanMode } from "../core/session.js";
7
7
  import { runQuery } from "../core/runner.js";
8
8
  import { listRuns, readConversation } from "../core/runs.js";
9
9
  import { isSharedQuestionActive, setSharedReadline } from "./terminalInteraction.js";
@@ -116,7 +116,8 @@ export async function runChatTui(options, tuiOptions = {}) {
116
116
  throw new Error("runChatTui(): a session opener needs `runsDir`.");
117
117
  // The session in use: with runs, the run's folder, rebuilt on /resume.
118
118
  let current = opener && runsDir ? await openSession(opener, await firstRun(runsDir)) : { options: options, run: null };
119
- let queue = createInputQueue();
119
+ const modeControl = () => current.modeControl ?? tuiOptions.modeControl;
120
+ let queue = createInputQueue({ modeControl: modeControl() });
120
121
  let run = runQuery(queue.iterable, current.options);
121
122
  let events = run.events[Symbol.asyncIterator]();
122
123
  const historyLimit = tuiOptions.historyLimit ?? DEFAULT_HISTORY_LIMIT;
@@ -257,7 +258,7 @@ export async function runChatTui(options, tuiOptions = {}) {
257
258
  run.close();
258
259
  current = await openSession(opener, await runFolderOf(summary));
259
260
  openLog();
260
- queue = createInputQueue();
261
+ queue = createInputQueue({ modeControl: modeControl() });
261
262
  run = runQuery(queue.iterable, current.options);
262
263
  events = run.events[Symbol.asyncIterator]();
263
264
  knownCommandTokens = null;
@@ -299,6 +300,13 @@ export async function runChatTui(options, tuiOptions = {}) {
299
300
  await resume();
300
301
  continue;
301
302
  }
303
+ // Plan mode on and off (the Ink chat also has Shift+Tab); the line says where it is now.
304
+ if (line.toLowerCase() === "/plan") {
305
+ const control = modeControl();
306
+ const next = control ? togglePlanMode(control) : null;
307
+ writeLine(ui.dim(next ? `⏵⏵ ${t().mode(next)}` : t().modeLocked(control?.mode)));
308
+ continue;
309
+ }
302
310
  // A line that *looks* like a slash command but matches nothing registered (a typo,
303
311
  // an unnamespaced plugin command, ...) would otherwise reach the model as literal
304
312
  // text with no special handling — confirmed empirically (captain-whiskers'
@@ -9,9 +9,13 @@ export type RenderApproval = (prompt: ApprovalPrompt) => ReactNode;
9
9
  /**
10
10
  * The preview's lines, capped so the whole live area stays shorter than the terminal: Ink
11
11
  * clears the entire screen (scrollback included) to redraw anything taller, and a step-gate
12
- * preview carries the tool's parameters, which can be a whole file.
12
+ * preview carries the tool's parameters, which can be a whole file. `reservedRows` is what
13
+ * the rest of the screen needs besides the preview; full screen adds its pinned header, or
14
+ * the panel's options and the status bar end up below the terminal's last row. With `width`
15
+ * (the panel's inner width) the cap counts screen rows, not lines: a long summary line takes
16
+ * several.
13
17
  */
14
- export declare function previewLines(lines: readonly string[], terminalRows: number | undefined): string[];
18
+ export declare function previewLines(lines: readonly string[], terminalRows: number | undefined, reservedRows?: number, width?: number): string[];
15
19
  export declare function statusText(mode: Mode | undefined, turns: number, usage: SessionUsage | null, extra?: {
16
20
  contextPercent?: number | null;
17
21
  modeSwitchable?: boolean;
@@ -1,4 +1,5 @@
1
1
  import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import wrapAnsi from "wrap-ansi";
2
3
  import { useEffect, useReducer, useRef, useState, useSyncExternalStore } from "react";
3
4
  import { Box, measureElement, Static, Text, useInput, useStdout } from "ink";
4
5
  import { Select } from "@inkjs/ui";
@@ -18,17 +19,30 @@ const decisionOptions = () => [
18
19
  ];
19
20
  const manualOptions = () => [{ label: `1. ${t().doneContinue}`, value: "continue" }];
20
21
  const DECISION_KEYS = { "1": "y", "2": "n", "3": "q", y: "y", n: "n", q: "q" };
22
+ /**
23
+ * The rows a checkpoint panel's preview leaves to everything else: the panel's own frame
24
+ * (borders, title, question, options: 8 rows), the status bar and a little room.
25
+ */
26
+ const PANEL_RESERVED_ROWS = 12;
27
+ /** The panel's border and horizontal padding, on both sides. */
28
+ const PANEL_FRAME_COLUMNS = 4;
21
29
  /**
22
30
  * The preview's lines, capped so the whole live area stays shorter than the terminal: Ink
23
31
  * clears the entire screen (scrollback included) to redraw anything taller, and a step-gate
24
- * preview carries the tool's parameters, which can be a whole file.
32
+ * preview carries the tool's parameters, which can be a whole file. `reservedRows` is what
33
+ * the rest of the screen needs besides the preview; full screen adds its pinned header, or
34
+ * the panel's options and the status bar end up below the terminal's last row. With `width`
35
+ * (the panel's inner width) the cap counts screen rows, not lines: a long summary line takes
36
+ * several.
25
37
  */
26
- export function previewLines(lines, terminalRows) {
27
- const all = lines.flatMap((line) => line.split("\n"));
28
- const max = Math.max(3, (terminalRows || 24) - 12);
38
+ export function previewLines(lines, terminalRows, reservedRows = PANEL_RESERVED_ROWS, width) {
39
+ const all = lines
40
+ .flatMap((line) => line.split("\n"))
41
+ .flatMap((line) => (width ? wrapAnsi(line, Math.max(1, width), { hard: true, trim: false }).split("\n") : [line]));
42
+ const max = Math.max(3, (terminalRows || 24) - reservedRows);
29
43
  return all.length <= max ? all : [...all.slice(0, max - 1), ui.dim(t().moreLines(all.length - max + 1))];
30
44
  }
31
- function CheckpointPanel({ checkpoint, renderApproval }) {
45
+ function CheckpointPanel({ checkpoint, renderApproval, reservedRows, width, }) {
32
46
  const decision = checkpoint.kind === "decision";
33
47
  useInput((input) => {
34
48
  const key = input.toLowerCase();
@@ -39,7 +53,7 @@ function CheckpointPanel({ checkpoint, renderApproval }) {
39
53
  });
40
54
  const { prompt } = checkpoint;
41
55
  const { stdout } = useStdout();
42
- return (_jsxs(Box, { flexDirection: "column", borderStyle: "round", borderColor: inkColor("accent"), paddingX: 1, children: [renderApproval ? (renderApproval(prompt)) : (_jsxs(_Fragment, { children: [_jsx(Text, { bold: true, children: prompt.title }), previewLines(prompt.lines, stdout.rows).map((line, index) => (_jsx(Text, { children: line }, index))), !decision && prompt.question ? _jsx(Text, { dimColor: true, children: prompt.question }) : null] })), decision ? (_jsx(Box, { marginTop: 1, children: _jsx(Text, { children: t().proceed }) })) : null, _jsx(Box, { marginTop: decision ? 0 : 1, children: _jsx(Select, { options: decision ? decisionOptions() : manualOptions(), onChange: (value) => checkpoint.answer(decision ? value : "") }, checkpoint.id) })] }));
56
+ return (_jsxs(Box, { flexDirection: "column", borderStyle: "round", borderColor: inkColor("accent"), paddingX: 1, children: [renderApproval ? (renderApproval(prompt)) : (_jsxs(_Fragment, { children: [_jsx(Text, { bold: true, children: prompt.title }), previewLines(prompt.lines, stdout.rows, reservedRows, width - PANEL_FRAME_COLUMNS).map((line, index) => (_jsx(Text, { children: line }, index))), !decision && prompt.question ? _jsx(Text, { dimColor: true, children: prompt.question }) : null] })), decision ? (_jsx(Box, { marginTop: 1, children: _jsx(Text, { children: t().proceed }) })) : null, _jsx(Box, { marginTop: decision ? 0 : 1, children: _jsx(Select, { options: decision ? decisionOptions() : manualOptions(), onChange: (value) => checkpoint.answer(decision ? value : "") }, checkpoint.id) })] }));
43
57
  }
44
58
  function formatTokens(count) {
45
59
  return count >= 1000 ? `${(count / 1000).toFixed(1)}k` : String(count);
@@ -67,12 +81,12 @@ function Working({ label, startedAt, width }) {
67
81
  return _jsx(Text, { children: fitWidth(`${ui.working(`${glyph} ${label}`)} ${ui.dim(`(${seconds}s · ${t().escToInterrupt})`)}`, width) });
68
82
  }
69
83
  /** Line in progress, checkpoint panel or spinner, the input, and the status bar. */
70
- function LiveArea({ session, checkpoint, renderApproval, mode, width, statusExtra, modeSwitchable, children }) {
84
+ function LiveArea({ session, checkpoint, renderApproval, mode, width, statusExtra, modeSwitchable, reservedRows, children }) {
71
85
  // The mode in the spinner's color; the rest dim.
72
86
  const plain = statusText(mode, session.turns, session.usage, { contextPercent: session.contextPercent, modeSwitchable }) + (statusExtra ? ` · ${statusExtra}` : "");
73
87
  const cut = mode ? plain.indexOf(" · ") : -1;
74
88
  const status = cut > 0 ? ui.working(plain.slice(0, cut)) + ui.dim(plain.slice(cut)) : ui.dim(plain);
75
- return (_jsxs(Box, { flexDirection: "column", flexShrink: 0, width: width, marginTop: session.liveGap ? 1 : 0, children: [stripAnsi(session.live) ? _jsx(Text, { children: session.live }) : null, checkpoint ? (_jsx(CheckpointPanel, { checkpoint: checkpoint, renderApproval: renderApproval })) : session.busy ? (
89
+ return (_jsxs(Box, { flexDirection: "column", flexShrink: 0, width: width, marginTop: session.liveGap ? 1 : 0, children: [stripAnsi(session.live) ? _jsx(Text, { children: session.live }) : null, checkpoint ? (_jsx(CheckpointPanel, { checkpoint: checkpoint, renderApproval: renderApproval, reservedRows: reservedRows, width: width })) : session.busy ? (
76
90
  // Always one blank line above the spinner: from this margin, or from the live area's
77
91
  // own when a separator is pending and nothing is written above the spinner yet.
78
92
  _jsxs(Box, { flexDirection: "column", marginTop: stripAnsi(session.live) || !session.liveGap ? 1 : 0, children: [_jsx(Working, { label: session.activity ?? t().thinking, startedAt: session.turnStartedAt, width: width }), session.subagentActivity ? _jsx(Text, { dimColor: true, children: fitWidth(` ↳ ${session.subagentActivity}`, width) }) : null] })) : null, checkpoint ? null : children, _jsx(Text, { children: fitWidth(status, width) })] }));
@@ -209,7 +223,9 @@ function FullscreenSession({ session, checkpoint, renderApproval, mode, header,
209
223
  const statusExtra = [anchor === null ? null : t().linesBelow(below), copied]
210
224
  .filter(Boolean)
211
225
  .join(" · ");
212
- return (_jsxs(Box, { flexDirection: "column", width: columns - 1, height: rows, children: [header && header.length > 0 ? (_jsx(Box, { flexDirection: "column", flexShrink: 0, marginBottom: 1, children: header.map((line, i) => (_jsx(Text, { wrap: "truncate-end", children: line || " " }, i))) })) : null, _jsx(Box, { ref: historyRef, flexDirection: "column", flexGrow: 1, flexShrink: 1, overflow: "hidden", justifyContent: "flex-end", children: wrapped.rows.slice(start, end).map((row, i) => (_jsx(Text, { wrap: "truncate-end", children: highlightRow(row, selection, start + i) || " " }, start + i))) }), _jsx(LiveArea, { session: session, checkpoint: checkpoint, renderApproval: renderApproval, mode: mode, width: width, statusExtra: statusExtra || undefined, modeSwitchable: modeSwitchable, children: children })] }));
226
+ return (_jsxs(Box, { flexDirection: "column", width: columns - 1, height: rows, children: [header && header.length > 0 ? (_jsx(Box, { flexDirection: "column", flexShrink: 0, marginBottom: 1, children: header.map((line, i) => (_jsx(Text, { wrap: "truncate-end", children: line || " " }, i))) })) : null, _jsx(Box, { ref: historyRef, flexDirection: "column", flexGrow: 1, flexShrink: 1, overflow: "hidden", justifyContent: "flex-end", children: wrapped.rows.slice(start, end).map((row, i) => (_jsx(Text, { wrap: "truncate-end", children: highlightRow(row, selection, start + i) || " " }, start + i))) }), _jsx(LiveArea, { session: session, checkpoint: checkpoint, renderApproval: renderApproval, mode: mode, width: width, statusExtra: statusExtra || undefined, modeSwitchable: modeSwitchable,
227
+ // The pinned header (and the blank row under it) is taken from the preview too.
228
+ reservedRows: PANEL_RESERVED_ROWS + (header && header.length > 0 ? header.length + 1 : 0), children: children })] }));
213
229
  }
214
230
  /** History, line in progress, current action, checkpoint panel and status bar. */
215
231
  export function SessionView({ model, interaction, renderApproval, mode, closed, fullscreen, header, onCopy, modeSwitchable, children }) {
@@ -9,4 +9,9 @@ export declare function renderMarkdown(source: string, width: number): string[];
9
9
  * Where the finished blocks end in a reply still streaming: after its last blank line
10
10
  * outside a code fence. Everything before it renders for good; the rest is still growing.
11
11
  */
12
+ /**
13
+ * Whether `source` holds a table: its columns are sized from all its rows, so none of its
14
+ * rows is final until the table is (see the session model's streaming).
15
+ */
16
+ export declare function hasTable(source: string): boolean;
12
17
  export declare function finishedLength(source: string): number;
@@ -173,6 +173,13 @@ function decodeEntities(text) {
173
173
  * Where the finished blocks end in a reply still streaming: after its last blank line
174
174
  * outside a code fence. Everything before it renders for good; the rest is still growing.
175
175
  */
176
+ /**
177
+ * Whether `source` holds a table: its columns are sized from all its rows, so none of its
178
+ * rows is final until the table is (see the session model's streaming).
179
+ */
180
+ export function hasTable(source) {
181
+ return marked.lexer(source, { gfm: true }).some((token) => token.type === "table");
182
+ }
176
183
  export function finishedLength(source) {
177
184
  let fenceOpen = false;
178
185
  let cut = 0;
@@ -1,5 +1,6 @@
1
1
  import type { Mode } from "../../core/agentSpec.js";
2
2
  import { type ConsoleRenderer, type ConsoleRendererOptions } from "../consoleRenderer.js";
3
+ import { type SessionModel } from "./sessionModel.js";
3
4
  import { type RenderApproval } from "./SessionView.js";
4
5
  import type { ToolPhrase } from "./toolGroup.js";
5
6
  import { type Theme } from "../theme.js";
@@ -31,6 +32,13 @@ export interface ProgressView extends ConsoleRenderer {
31
32
  /** Removes the live area and restores the previous interaction port; await it before printing anything else. */
32
33
  close(): Promise<void>;
33
34
  }
35
+ /**
36
+ * The console renderer's methods on top of a session model, so what a caller writes lands in
37
+ * the view (and in `onWrite`, through the model), not only in the model's inner console
38
+ * renderer, whose own output goes nowhere. The view draws whole lines: `write()` text waits
39
+ * until its line ends (a "\n" in it, `writeLine()` or `endLine()`).
40
+ */
41
+ export declare function progressRenderer(model: SessionModel): ConsoleRenderer;
34
42
  /**
35
43
  * The Ink counterpart of `createConsoleRenderer()` for one-shot ("run"-style) sessions: the
36
44
  * same methods and the same text (so `onWrite` logs exactly what the console version
@@ -23,6 +23,43 @@ function ProgressApp({ model, interaction, renderApproval, mode, closed }) {
23
23
  }, { isActive: checkpoint !== null });
24
24
  return _jsx(SessionView, { model: model, interaction: interaction, renderApproval: renderApproval, mode: mode, closed: closed });
25
25
  }
26
+ /**
27
+ * The console renderer's methods on top of a session model, so what a caller writes lands in
28
+ * the view (and in `onWrite`, through the model), not only in the model's inner console
29
+ * renderer, whose own output goes nowhere. The view draws whole lines: `write()` text waits
30
+ * until its line ends (a "\n" in it, `writeLine()` or `endLine()`).
31
+ */
32
+ export function progressRenderer(model) {
33
+ let partial = "";
34
+ const flush = () => {
35
+ if (!partial)
36
+ return;
37
+ const line = partial;
38
+ partial = "";
39
+ model.writeLine(line);
40
+ };
41
+ return {
42
+ render: (event) => {
43
+ flush();
44
+ model.render(event);
45
+ },
46
+ write(text) {
47
+ const lines = (partial + text).split("\n");
48
+ partial = lines.pop() ?? "";
49
+ for (const line of lines)
50
+ model.writeLine(line);
51
+ },
52
+ writeLine(text) {
53
+ flush();
54
+ model.writeLine(text);
55
+ },
56
+ endLine: flush,
57
+ startTurn: () => model.startTurn(),
58
+ get atLineStart() {
59
+ return partial === "" && model.renderer.atLineStart;
60
+ },
61
+ };
62
+ }
26
63
  /**
27
64
  * The Ink counterpart of `createConsoleRenderer()` for one-shot ("run"-style) sessions: the
28
65
  * same methods and the same text (so `onWrite` logs exactly what the console version
@@ -47,14 +84,7 @@ export function createProgressView(options = {}) {
47
84
  model.startTurn();
48
85
  let closing = null;
49
86
  return {
50
- render: model.render,
51
- write: (text) => model.renderer.write(text),
52
- writeLine: (text) => model.renderer.writeLine(text),
53
- endLine: () => model.renderer.endLine(),
54
- startTurn: () => model.startTurn(),
55
- get atLineStart() {
56
- return model.renderer.atLineStart;
57
- },
87
+ ...progressRenderer(model),
58
88
  close() {
59
89
  closing ??= (async () => {
60
90
  setInteractionPort(previousPort);
@@ -47,9 +47,10 @@ export interface InkChatOptions extends ChatTuiOptions {
47
47
  toolPhrase?: (toolName: string) => ToolPhrase | undefined;
48
48
  /**
49
49
  * The session's mode control (`buildSessionOptions()` returns it): the status bar shows the
50
- * current mode, and Shift+Tab switches between the modes it allows ("guided" and
51
- * "interactive"; an autonomous session can't switch). With a session opener, the one it
52
- * returns is used instead.
50
+ * current mode, Shift+Tab switches between the modes it allows ("guided", "interactive"
51
+ * and "plan"; an autonomous session can't switch), and entering or leaving plan mode is
52
+ * told to the model with the next message. With a session opener, the one it returns is
53
+ * used instead.
53
54
  */
54
55
  modeControl?: ModeControl;
55
56
  /**
@@ -6,7 +6,7 @@ import { useSyncExternalStore } from "react";
6
6
  import { Box, render, Text, useInput } from "ink";
7
7
  import { Select } from "@inkjs/ui";
8
8
  import { getInteractionPort, setInteractionPort } from "../../core/interaction.js";
9
- import { createInputQueue } from "../../core/session.js";
9
+ import { createInputQueue, togglePlanMode } from "../../core/session.js";
10
10
  import { runQuery } from "../../core/runner.js";
11
11
  import { listRuns, readConversation } from "../../core/runs.js";
12
12
  import { capHistory, loadHistory, runChatTui, saveHistory, slashCommandToken } from "../chatTui.js";
@@ -244,7 +244,7 @@ export async function runChatInk(options, tuiOptions = {}) {
244
244
  let generation = 0;
245
245
  function connect() {
246
246
  const own = ++generation;
247
- queue = createInputQueue();
247
+ queue = createInputQueue({ modeControl: modeControl() });
248
248
  run = runQuery(queue.iterable, { ...current.options, promptSuggestions: tuiOptions.promptSuggestions ?? true });
249
249
  const events = run.events[Symbol.asyncIterator]();
250
250
  input.setMode(modeControl()?.mode ?? null);
@@ -253,7 +253,11 @@ export async function runChatInk(options, tuiOptions = {}) {
253
253
  knownCommands = run.supportedCommands().then((commands) => new Set(commands.flatMap((c) => [c.name, ...(c.aliases ?? [])])), () => null);
254
254
  void knownCommands.then((names) => {
255
255
  const exits = [...exitCommands].filter((c) => c.startsWith("/")).map((c) => c.slice(1));
256
- const local = [...(tuiOptions.terminalIntegration === false ? [] : ["copy"]), ...(runsDir ? ["resume"] : [])];
256
+ const local = [
257
+ ...(tuiOptions.terminalIntegration === false ? [] : ["copy"]),
258
+ ...(runsDir ? ["resume"] : []),
259
+ ...(modeControl()?.switchable.includes("plan") ? ["plan"] : []),
260
+ ];
257
261
  input.setCommands([...new Set([...(names ?? []), ...exits, ...local])].sort());
258
262
  });
259
263
  void (async () => {
@@ -382,6 +386,16 @@ export async function runChatInk(options, tuiOptions = {}) {
382
386
  await resume();
383
387
  continue;
384
388
  }
389
+ // A local command too: into plan mode, or back to the mode it was entered from.
390
+ if (line.toLowerCase() === "/plan") {
391
+ const control = modeControl();
392
+ const next = control ? togglePlanMode(control) : null;
393
+ if (next)
394
+ input.setMode(next);
395
+ else
396
+ model.writeLine(ui.dim(t().modeLocked(control?.mode ?? tuiOptions.mode)));
397
+ continue;
398
+ }
385
399
  const commandToken = slashCommandToken(line);
386
400
  if (commandToken) {
387
401
  const names = await knownCommands;
@@ -1,7 +1,7 @@
1
1
  import { createFriendlyToolLabel } from "../../core/toolLabels.js";
2
2
  import { createConsoleRenderer } from "../consoleRenderer.js";
3
3
  import { fitWidth, stripAnsi } from "./lineBuffer.js";
4
- import { finishedLength, renderMarkdown } from "./markdown.js";
4
+ import { finishedLength, hasTable, renderMarkdown } from "./markdown.js";
5
5
  import { toolGroupExpanded, toolGroupSummary } from "./toolGroup.js";
6
6
  import * as ui from "../ui.js";
7
7
  import { t } from "../../core/messages/index.js";
@@ -120,6 +120,15 @@ export function createSessionModel(options = {}) {
120
120
  if (!rest.trim())
121
121
  return [];
122
122
  const rows = renderMarkdown(rest, mdWidth());
123
+ // A table's columns are sized from all its rows, so a later row can widen rows already
124
+ // drawn: an unfinished table is never moved to the history, and only its latest rows
125
+ // show live until its block ends and it goes to the history whole.
126
+ if (hasTable(rest)) {
127
+ const shown = segmentShown;
128
+ const live = decorate(rows.slice(Math.max(rowsCommitted, rows.length - LIVE_ROWS)));
129
+ segmentShown = shown;
130
+ return live;
131
+ }
123
132
  const overflow = rows.length - rowsCommitted - LIVE_ROWS;
124
133
  if (overflow > 0) {
125
134
  const lead = segmentShown && rowsCommitted === 0 ? [""] : [];
@@ -1,6 +1,6 @@
1
1
  import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
2
2
  import { stdin, stdout } from "node:process";
3
- import { useState } from "react";
3
+ import { useEffect, useState } from "react";
4
4
  import { Box, render, Static, Text, useApp, useInput, useStdout } from "ink";
5
5
  import wrapAnsi from "wrap-ansi";
6
6
  import { liveWidth } from "./sessionModel.js";
@@ -77,6 +77,16 @@ export function Wizard({ steps, title, onDone }) {
77
77
  const [answers, setAnswers] = useState({});
78
78
  const [done, setDone] = useState([]);
79
79
  const [index, setIndex] = useState(() => nextIndex(steps, -1, {}));
80
+ const [finished, setFinished] = useState(null);
81
+ // Exits after the render that writes the last answer's ✔ line: exiting in the same handler
82
+ // unmounted Ink before it wrote that <Static> item, leaving the last question unanswered on
83
+ // screen.
84
+ useEffect(() => {
85
+ if (!finished)
86
+ return;
87
+ onDone(finished);
88
+ exit();
89
+ }, [finished]);
80
90
  useInput((input, key) => {
81
91
  if (key.ctrl && input === "c") {
82
92
  onDone(null);
@@ -90,10 +100,8 @@ export function Wizard({ steps, title, onDone }) {
90
100
  setDone([...done, { message: resolve(step.message, answers), text: summary(step, value, answers) }]);
91
101
  const following = nextIndex(steps, index, next);
92
102
  setIndex(following);
93
- if (following >= steps.length) {
94
- onDone(next);
95
- exit();
96
- }
103
+ if (following >= steps.length)
104
+ setFinished(next);
97
105
  }
98
106
  // The title and the answered steps go to <Static>: written once, never redrawn, so a long
99
107
  // menu can't grow the live area past the terminal's height.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@falkenslab/agent-kit",
3
- "version": "0.13.0",
3
+ "version": "0.14.0",
4
4
  "description": "Library for building an agent on top of the Claude Agent SDK",
5
5
  "author": "Francisco Vargas Ruiz",
6
6
  "license": "MIT",