@wrongstack/tui 0.1.10 → 0.2.0

package/README.md

@@ -31,7 +31,7 @@ const exitCode = await runTui({
   family: 'anthropic',
   keyTail: '…ABC',
   effectiveMaxContext: 200_000,
-  altScreen: false,
+  altScreen: true,
 });
 
 process.exit(exitCode);
@@ -76,7 +76,7 @@ process.exit(exitCode);
 
 ## Options worth knowing
 
-- **`altScreen: false`** (default) — render into normal scrollback so the user keeps native terminal scroll + history after exit. Set `true` for full-screen mode (no scrollback).
+- **`altScreen: true`** (default) — render into the terminal's alternate screen buffer (vim/less/htop style). The TUI owns the whole viewport, native scrollback is untouched, and the live region cannot leak into terminal history. Raw mode plus alt-screen also means every keystroke — including Ctrl+S, Ctrl+Q, Ctrl+Z, Ctrl+\\ — reaches Ink instead of being consumed by the terminal driver (`runTui` additionally registers no-op handlers for `SIGTSTP`/`SIGQUIT`/`SIGTTIN`/`SIGTTOU` as belt-and-suspenders). Set `false` (or pass `--no-alt-screen`) to render into normal scrollback if you specifically want completed chat to survive after exit; the trade-off is the documented live-region leak on resize / overlay-close / picker-submit, and that some shortcuts may fall through to the terminal.
 - **`effectiveMaxContext`** — the context-bar denominator. Pass the model-specific value resolved via `ModelsRegistry`, not the family baseline; the 1M Opus variant has a much larger window than the 200k default.
 - **`queueStore`** — if set, queued input survives a crash. Without it, queued lines are in-memory only.
 - **`onClearHistory`** — invoked from the `/clear` slash command so the TUI can wipe its rendered history entries (keeping just the banner) while `Agent`/memory reset happens elsewhere.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Agent, SlashCommandRegistry, AttachmentStore, EventBus, TokenCounter, QueueStore } from '@wrongstack/core';
+import { Agent, SlashCommandRegistry, AttachmentStore, EventBus, TokenCounter, QueueStore, Director } from '@wrongstack/core';
 import React from 'react';
 
 interface ProviderOption {
@@ -44,12 +44,13 @@ interface RunTuiOptions {
     effectiveMaxContext?: number;
     /**
      * Render into the terminal's alternate screen buffer (like vim/less/htop).
-     * Default: false — we render into normal scrollback so the user can
-     * scroll history with the terminal's native mouse wheel / Shift+PgUp,
-     * and so completed chat survives after exit. Pass true to switch to
-     * a fixed full-screen view (no scrollback, no native scroll); useful
-     * when terminal redraw flicker is bad enough to outweigh the loss of
-     * scrollback.
+     * Default: false — native scrollback stays live so chat history is
+     * scrollable via mouse wheel / Shift+PgUp, which matches the user's
+     * "this is a chat app, let me scroll the chat" intuition. Pass true
+     * (or run with `--alt-screen`) for the full-screen mode that owns the
+     * terminal and prevents resize/overlay leaks of the live region —
+     * trade-off is that the terminal's native scrollback is suspended
+     * while the TUI is up and only what's currently on screen is visible.
      */
     altScreen?: boolean;
     /**
@@ -65,6 +66,46 @@ interface RunTuiOptions {
     } | {
         type: 'resetContextChip';
     }>) => void;
+    /**
+     * Live director instance. When set, the TUI renders a fleet panel
+     * showing every spawned subagent, its current task, streaming output,
+     * and runtime cost — updated live from the FleetBus. Pass null or omit
+     * when multi-agent / director mode is disabled.
+     */
+    director?: Director | null;
+    /**
+     * Optional roster reference for resolving subagent role ids to
+     * human-readable names. Same value passed to director.tools().
+     */
+    fleetRoster?: Record<string, {
+        name: string;
+    }>;
+    /**
+     * Shared controller for the `/fleet stream on|off` toggle. The slash
+     * command runs in the CLI process and needs to flip TUI reducer state;
+     * the App installs a dispatch-backed `setEnabled` here on mount so
+     * both sides stay synchronized.
+     */
+    fleetStreamController?: {
+        enabled: boolean;
+        setEnabled: (enabled: boolean) => void;
+    };
+    /**
+     * If set, the App boots straight into goal mode — the text is wrapped
+     * in the GOAL preamble and submitted as the first turn. Lets users
+     * launch directly from the shell:
+     *   wstack --tui --director --goal "audit packages/core for races"
+     * The chat shows a one-line "🎯 Goal locked: …" hint; the actual
+     * preamble is hidden from the visible history (same as `/goal`).
+     */
+    initialGoal?: string;
+    /**
+     * If set, submitted as the first turn verbatim (no preamble). Mainly
+     * for scripted shell aliases — `wstack --tui --ask "summarize foo.md"`
+     * — that want one turn pre-populated without the goal-mode framing.
+     * Ignored when `initialGoal` is also set.
+     */
+    initialAsk?: string;
 }
 declare function runTui(opts: RunTuiOptions): Promise<number>;