pi-jarvis 1.1.4 → 1.2.3

package/AGENTS.md

@@ -0,0 +1,24 @@
+# pi-jarvis Agent Notes
+
+## Project Scope
+- `pi-jarvis` is a Pi extension that opens a `/jarvis` side-conversation overlay.
+- Core runtime files: `index.ts`, `side-session.ts`, `overlay.ts`, `jarvis-config.ts`, `session-ref.ts`.
+
+## Current `/jarvis-model` Behavior
+- `/jarvis-model` with no request opens a model picker when Pi has a UI.
+- `/jarvis-model <provider/model>` writes a project-scoped override to `.pi/jarvis.json`.
+- `/jarvis-model --global <provider/model>` writes the default global override to the active Pi agent directory's `extensions/pi-jarvis.json` (by default `~/.pi/agent/extensions/pi-jarvis.json`).
+- `/jarvis-model [--project|--global] follow-main` stores a scoped `follow-main` override.
+- `/jarvis-model [--project|--global] clear` removes that scope's override so fallback applies.
+- Resolution order is: project config, then global config, then built-in `follow-main`.
+- `Note main` and `Redirect` stay disabled when the active `/jarvis` model is incompatible with bridge tools.
+
+## Validation
+- Run `npm test` for full validation.
+- Run `npm run build` before release packaging.
+
+## Docs To Keep In Sync
+- `README.md`
+- `CHANGELOG.md`
+- `package.json` version
+- this `AGENTS.md` when command/config behavior changes

package/README.md

@@ -1,109 +1,298 @@
 # pi-jarvis
 
-`pi-jarvis` adds a polished `/jarvis` side-conversation overlay to Pi so you can ask for help without derailing the main session.
+<div align="center">
 
-## Why use it
+## A cinematic side-conversation overlay for Pi
 
-`/jarvis` gives you a second lane for quick questions, triage, and local investigation while the main session keeps moving. Instead of interrupting the primary flow, it opens a separate persistent side thread with explicit controls for tool access and main-session handoff.
+**Open a second lane of thought without derailing the main session.**
 
-## What you get
+`pi-jarvis` adds `/jarvis`: a polished overlay where you can ask for status, inspect the repo when you explicitly allow it, and send a quiet note or a confirmed redirect back to the main lane.
 
-- A floating `/jarvis` overlay inside the current Pi session
-- A separate side-session history that survives reopening the overlay
-- Automatic follow-main model behavior, with optional `/jarvis-model` pinning
-- Permission-gated local `read`, `bash`, `edit`, and `write` access, plus `mcp` when available
-- Optional non-interrupting notes or confirmed redirects back to the main session
-- A focused regression suite covering the risky runtime and overlay paths
+[![npm version](https://img.shields.io/npm/v/pi-jarvis?style=for-the-badge&color=7c3aed)](https://www.npmjs.com/package/pi-jarvis)
+[![license](https://img.shields.io/badge/license-MIT-111827?style=for-the-badge)](./LICENSE)
+[![Pi extension](https://img.shields.io/badge/Pi-extension-06b6d4?style=for-the-badge)](https://github.com/fluxgear/pi-jarvis)
+[![TypeScript](https://img.shields.io/badge/TypeScript-powered-2563eb?style=for-the-badge)](./package.json)
+
+<p>
+  <strong>Persistent side session</strong> ·
+  <strong>Live main-session awareness</strong> ·
+  <strong>Permission-gated tools</strong> ·
+  <strong>Safe redirect flow</strong>
+</p>
+
+</div>
+
+---
+
+## The pitch
+
+The main Pi session should stay on the critical path.
+
+`/jarvis` gives you a **second cockpit** for the work that should not interrupt that primary flow:
+
+- checking what the main agent is doing right now
+- seeing what changed since the last `/jarvis` turn
+- asking for triage, summaries, or a second opinion
+- inspecting the repo with local tools when you turn them on
+- sending a non-interrupting note back to the main session
+- redirecting the main session only after explicit confirmation
+
+> Think of it as a side conversation with real context, not a detached scratchpad.
+
+### Typical prompts
+
+- *"What is the main agent doing right now?"*
+- *"Summarize the last validation failure and tell me what matters."*
+- *"Check this file while the main session keeps moving."*
+- *"Compare what changed since my last `/jarvis` turn."*
+- *"Redirect the main session, but make me confirm it first."*
+
+---
+
+## At a glance
+
+| Capability | What you get |
+|---|---|
+| **Persistent side lane** | `/jarvis` keeps its own isolated conversation state and restores prior side-session history |
+| **Live awareness** | Jarvis sees the current main-session summary plus a delta since the last `/jarvis` turn |
+| **Permission-gated tools** | Local `read`, `bash`, `edit`, `write`, and optional `mcp` stay off until you enable them |
+| **Safe main-session handoff** | `Note main` is quiet; `Redirect` is confirmation-gated |
+| **Independent model control** | Follow the main model or pin `/jarvis` to a separate model |
+| **Cleaner UX** | Thinking-step streaming is collapsed into a cleaner animated fallback |
+
+---
+
+## How it fits into Pi
+
+```mermaid
+flowchart LR
+    U[You] -->|primary work| M[Main Pi session]
+    U -->|open /jarvis| J[Jarvis overlay]
+    M -->|summary + recent delta| J
+    J -->|Repo tools enabled| R[Local tools\nread • bash • edit • write]
+    J -->|optional| X[MCP]
+    J -. Note main .-> M
+    J -. Redirect after confirmation .-> M
+```
+
+### Operating model
+
+```mermaid
+flowchart TD
+    A[Main session keeps moving] --> B[/jarvis opens in overlay]
+    B --> C[Jarvis sees current main-session context]
+    C --> D{What do you need?}
+    D -->|Status / summary / analysis| E[Jarvis handles the side task]
+    D -->|Repo inspection| F[Enable Repo tools]
+    D -->|Influence the main lane| G[Enable Note main or Redirect]
+    G --> H{Redirect?}
+    H -->|Yes| I[Per-send confirmation]
+    H -->|No| J[Quiet follow-up note]
+```
+
+---
+
+## Why use `/jarvis` instead of the main lane?
+
+Use `/jarvis` when you want:
+
+- a second opinion without changing the primary plan yet
+- a quick repo inspection while the main agent keeps moving
+- a compact explanation of current progress or validation state
+- a controlled way to send guidance back to the main session
+
+Stay in the main lane when you want:
+
+- the main plan to change immediately
+- the main session itself to execute the next step directly
+- no side conversation overhead at all
+
+---
 
 ## Quick start
 
-### 1. Install the package
+### 1) Install
 
 ```bash
 npm install pi-jarvis
 ```
 
-### 2. Register the extension entrypoint in Pi
+### 2) Register the extension in Pi
 
-Use the published entrypoint:
+Use the package's published extension entrypoint:
 
 ```text
 ./dist/index.js
 ```
 
-This package is intended to run inside a Pi installation that provides the required peer dependencies.
+This package is meant to run **inside a Pi installation** that provides the required peer dependencies.
 
-### 3. Open `/jarvis`
+### 3) Open Jarvis
 
 ```bash
 /jarvis
 ```
 
-You can also send the first message immediately:
+Or open it and send the first message immediately:
 
 ```bash
-/jarvis check this file for obvious regressions
+/jarvis summarize the last validation failure and suggest the fastest next move
 ```
 
-Or use it as a background helper while continuing the main flow:
+### 4) Turn on more power only when you want it
 
-```bash
-/jarvis summarize last 20 lines of build output and suggest next action
-```
+- leave `Repo tools` off for pure context / analysis
+- turn `Repo tools` on when you want local `read`, `bash`, `edit`, `write`, and optional `mcp`
+- turn `Note main` on when you want Jarvis to quietly message the main session
+- turn `Redirect` on when you want Jarvis to propose a redirect that you still explicitly confirm
 
-## Commands
+---
+
+## Command surface
 
 ### `/jarvis`
-Opens the side overlay. If you pass text after the command, that text becomes the first side-session prompt.
+Opens the side overlay. If text follows the command, that text becomes the first side-session prompt.
+
+### `/jarvis-model`
+When Pi has a UI, running `/jarvis-model` with no argument opens a model picker instead of requiring an exact provider/model string.
 
-### `/jarvis-model <provider/model>`
-Pins `/jarvis` to a specific model without changing the main session model.
+### `/jarvis-model [--project|--global] <provider/model>`
+Pins `/jarvis` to a specific model without changing the main session model. A plain `/jarvis-model <provider/model>` writes a **project-local** override to `.pi/jarvis.json`.
 
-### `/jarvis-model follow-main`
-Returns `/jarvis` to the default mode where it follows the current main model.
+### `/jarvis-model [--project|--global] follow-main`
+Restores the chosen scope to `follow-main`. A project-scoped `follow-main` override still wins over a global pinned setting.
 
-## Overlay behavior
+### `/jarvis-model [--project|--global] clear`
+Removes the selected scope so `/jarvis` falls back through the remaining config layers to the built-in default.
 
-The overlay is designed to stay explicit about what `/jarvis` can do right now. It surfaces:
+---
 
-- the current main-session state
-- the active `/jarvis` model and mode
-- what changed since the last `/jarvis` turn
-- whether local tools are off, enabled, or enabled without MCP
+## Model resolution
 
-The main header controls are:
+```mermaid
+flowchart TD
+    A[Project config\n.pi/jarvis.json] -->|if present| B{valid?}
+    B -->|yes| P[Use project selection]
+    B -->|no or missing| C[Global config\n&lt;agentDir&gt;/extensions/pi-jarvis.json]
+    C -->|if present| D{valid?}
+    D -->|yes| G[Use global selection]
+    D -->|no or missing| E[Built-in default]
+    E --> F[follow-main]
+```
+
+### Resolution order
 
-- `Repo tools`
-- `Note main`
-- `Redirect`
+1. project config: `.pi/jarvis.json`
+2. global config: `~/.pi/agent/extensions/pi-jarvis.json` or the equivalent path under a custom Pi agent dir
+3. built-in default: `follow-main`
 
-All three are off by default.
+---
 
-## Permission model
+## Overlay controls
 
-### Repo tools
-When enabled, `/jarvis` may use local:
+The overlay header exposes three controls, all **off by default**:
 
-- `read`
-- `bash`
-- `edit`
-- `write`
-- `mcp` when the MCP adapter is available in the current Pi environment
+| Control | What it does | Safety model |
+|---|---|---|
+| `Repo tools` | Enables local `read`, `bash`, `edit`, `write`, and optional `mcp` | Explicit opt-in |
+| `Note main` | Sends a concise, non-interrupting note to the main session | Explicit opt-in |
+| `Redirect` | Sends a redirecting instruction to the main session | Explicit opt-in + per-send confirmation |
 
-When disabled, `/jarvis` works from injected session context and the bridge controls only.
+`Note main` and `Redirect` can be forcibly disabled when the active `/jarvis` model is incompatible with bridge tools.
 
-### Note main
-Allows `/jarvis` to send a concise, non-interrupting note back to the main session.
+### Permission flow
 
-### Redirect
-Allows `/jarvis` to send a redirecting instruction to the main session, but every actual redirect still requires explicit confirmation.
+```mermaid
+flowchart TD
+    A[Overlay opens] --> B[Repo tools off]
+    A --> C[Note main off]
+    A --> D[Redirect off]
 
-## Session model
+    B -->|enable| E[Jarvis may use local tools]
+    E --> F{MCP adapter available?}
+    F -->|yes| G[Local tools + MCP]
+    F -->|no| H[Local tools only]
+
+    C -->|enable| I[Jarvis may send a quiet note to main]
+    D -->|enable| J[Jarvis may request redirect sends]
+    J --> K[Every redirect still requires confirmation]
+
+    L[Incompatible /jarvis model] --> M[Note main disabled]
+    L --> N[Redirect disabled]
+```
+
+---
+
+## Redirect flow
+
+```mermaid
+sequenceDiagram
+    participant You
+    participant Jarvis
+    participant Main as Main session
+
+    You->>Jarvis: Enable Redirect
+    You->>Jarvis: "Tell the main session to stop and inspect overlay teardown"
+    Jarvis->>You: Confirmation request
+    You-->>Jarvis: Approve
+    Jarvis-->>Main: Redirect instruction
+    Main-->>You: Continues on new priority
+```
+
+---
+
+## Session behavior
 
 - `/jarvis` keeps its own isolated conversation state
 - prior side-session history is restored from a session file under `jarvis-sessions/`
-- `/jarvis` follows the main model by default
-- thinking-step streaming is collapsed to a cleaner animated fallback for readability
+- Jarvis sees current main-session state plus a compact delta since the last `/jarvis` turn
+- plain `/jarvis-model <provider/model>` writes the project override; use `--global` to change the global default
+- thinking-step streaming is intentionally collapsed to a cleaner animated fallback for readability
+
+---
+
+## Example usage
+
+### Ask for live status
+
+```bash
+/jarvis what is the main agent doing right now?
+```
+
+### Ask for triage while the main lane keeps moving
+
+```bash
+/jarvis summarize the last failing test and tell me the fastest likely fix
+```
+
+### Use Jarvis as a repo-side helper
+
+```bash
+/jarvis inspect overlay.ts for teardown or redraw risks
+```
+
+### Send a non-interrupting note back to the main session
+
+1. Open `/jarvis`
+2. Enable `Note main`
+3. Ask Jarvis to send the note
+
+### Send a redirect safely
+
+1. Open `/jarvis`
+2. Enable `Redirect`
+3. Ask Jarvis to redirect the main session
+4. Confirm the send
+
+---
+
+## Compatibility note
+
+This repository's current validation baseline is **Pi 0.69.0**.
+
+The package relies on Pi-provided peer dependencies, so treat other host versions as **not the validated baseline for this repo** unless you have tested them yourself.
+
+---
 
 ## Development
 
@@ -131,15 +320,14 @@ Build the published package contents:
 npm run build
 ```
 
-## Published package contents
+Preview the npm payload:
 
-The npm package publishes:
+```bash
+npm pack --dry-run
+```
 
-- `dist/`
-- `README.md`
-- `LICENSE`
-- `package.json`
+---
 
 ## License
 
-MIT
+`pi-jarvis` is released under the **MIT License**. See [LICENSE](./LICENSE).

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,OAAO,EAGN,KAAK,YAAY,EAGjB,MAAM,+BAA+B,CAAC;AA+BvC,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAyP9D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,OAAO,EAGN,KAAK,YAAY,EAGjB,MAAM,+BAA+B,CAAC;AA8DvC,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAyV9D"}