@moguw/pi-interactive-shell

Run interactive CLIs inside observable Pi TUI overlays. Pi can drive the subprocess while you watch, and you can take control whenever needed.

Requirements

• Node.js 22.19 or newer
• Pi interactive TUI mode for overlays
• zigpty support for the current platform

Install

pi install npm:@moguw/pi-interactive-shell

Install this workspace package directly during local development:

pi install /path/to/pi-ext/extensions/pi-interactive-shell

Run /reload after changing the installed package.

Usage

Ask Pi to open or supervise a CLI, or use the slash commands directly:

/spawn [agent]                              open an agent in an interactive overlay
/spawn codex "review the diffs" --dispatch  run a delegated task and report completion
/spawn cursor                               open Cursor in an interactive overlay
/spawn claude "review the diffs" --dispatch run a delegated Claude task
/attach [session-id]                        reattach a background session
/dismiss [session-id]                       dismiss one session, or choose from a list

/spawn supports pi, codex, cursor, claude, configured custom agents, Pi session forks, and isolated Git worktrees. Add --worktree to run the spawned agent in a separate worktree.

Modes

Mode	Use it for	Completion behavior
interactive	Editors, REPLs, SSH, and manual CLI flows	Opens an overlay and returns a controllable sessionId
hands-free	Builds and long-running tasks that need progress updates	Opens an overlay and emits quiet or interval updates
dispatch	Fire-and-forget delegated work	Reports completion without polling
monitor	Logs, tests, polling, and file watchers	Wakes Pi only when a trigger matches

Dispatch defaults autoExitOnQuiet: true — the session gets a 15s startup grace period before closing after output becomes quiet. The completion notification identifies this as a quiet auto-close, not a user kill.

Start A Session

Use exactly one lifecycle selector: command, a non-empty spawn, sessionId, or attach.

interactive_shell({ command: "vim package.json" })

interactive_shell({
  spawn: { agent: "pi", prompt: "Review the current changes" },
  mode: "dispatch",
})

interactive_shell({
  spawn: { agent: "cursor", prompt: "Review the diffs" },
  mode: "dispatch",
})

interactive_shell({
  spawn: { agent: "claude", prompt: "Review the diffs" },
  mode: "hands-free",
})

Raw command is suitable for arbitrary CLIs. Structured spawn applies the configured agent command, default arguments, prompt format, and worktree behavior.

Control A Session

Use the returned sessionId for every follow-up operation:

interactive_shell({ sessionId: "calm-reef" })
interactive_shell({ sessionId: "calm-reef", input: "/compact", submit: true })
interactive_shell({ sessionId: "calm-reef", inputKeys: ["ctrl+c"] })
interactive_shell({ sessionId: "calm-reef", background: true })
interactive_shell({ sessionId: "calm-reef", kill: true })

For editor-based TUIs, raw input only types text. It does not submit the prompt. Add submit: true or inputKeys: ["enter"] to submit it.

Background sessions can be listed, reattached, or dismissed:

interactive_shell({ listBackground: true })
interactive_shell({ attach: "calm-reef", mode: "hands-free" })
interactive_shell({ dismissBackground: "calm-reef" })

Monitor A Process

Match output from a long-running command:

interactive_shell({
  command: "npm test -- --watch",
  mode: "monitor",
  monitor: {
    strategy: "stream",
    triggers: [{ id: "failed", literal: "FAIL" }],
  },
})

Watch files without starting a command:

interactive_shell({
  mode: "monitor",
  monitor: {
    strategy: "file-watch",
    fileWatch: {
      path: "./uploads",
      recursive: true,
      events: ["rename", "change"],
    },
    triggers: [{ id: "pdf", regex: "/\\.pdf$/i" }],
  },
})

Query monitor state and events with the monitor session id:

interactive_shell({ monitorStatus: true, monitorSessionId: "calm-reef" })
interactive_shell({ monitorEvents: true, monitorSessionId: "calm-reef" })

Keyboard Shortcuts

Shortcut	Action
Alt+Shift+F	Toggle focus between overlay and main chat
Alt+Shift+P	Launch the configured default spawn agent
Ctrl+G	Return control to Pi only after taking over a monitored hands-free or dispatch session
Ctrl+B	Move the current shell session to the background
Ctrl+T	Transfer terminal output back to Pi
Ctrl+Q	Open the transfer/background/kill menu

Configuration

Global and project configuration files are merged, with project values taking precedence:

• Global: ~/.pi/agent/interactive-shell.json
• Project: .pi/interactive-shell.json

{
  "defer": false,
  "overlayAnchor": "center",
  "focusShortcut": "alt+shift+f",
  "spawn": {
    "defaultAgent": "pi",
    "shortcut": "alt+shift+p",
    "commands": { "cursor": "agent" },
    "defaultArgs": { "cursor": ["--model", "composer-2-fast"] },
    "worktree": false
  },
  "minQueryIntervalSeconds": 60,
  "handsFreeQuietThreshold": 8000,
  "autoExitGracePeriod": 15000
}

Set defer to true to register only enable_interactive_shell at startup. Calling that loader activates interactive_shell for the current Pi process. See skills/pi-interactive-shell/SKILL.md for the complete tool reference.

Limitations

• macOS is tested; Linux support is experimental.
• Existing-session queries are rate-limited by default.
• Terminal applications may have rendering quirks in an overlay.

Acknowledgments

Thanks to Nico Bailon for creating the original pi-interactive-shell project that this package is based on.