agentxl 1.1.0 → 1.1.3

package/README.md

@@ -17,9 +17,6 @@
   <img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="Node 20+" />
 </p>
 
-<!-- TODO: Replace with actual demo GIF showing: select local folder → ask question → trace answer to source → map into Excel -->
-<!-- <p align="center"><img src="https://raw.githubusercontent.com/satish860/agentxl/master/docs/demo.gif" alt="AgentXL demo" width="600" /></p> -->
-
 <p align="center">
   <a href="#quick-start">Quick Start</a> •
   <a href="#the-method">The Method</a> •
@@ -32,7 +29,7 @@
 
 Most spreadsheet work does not start in Excel. It starts in messy PDFs, statements, exports, agreements, and support folders.
 
-AgentXL is being built for that workflow:
+AgentXL is built for that workflow:
 
 - **point to a local folder of source documents**
 - **ask a question or give an instruction**
@@ -41,51 +38,43 @@ AgentXL is being built for that workflow:
 
 Built for audit and diligence workflows first — useful anywhere document-heavy work ends in spreadsheets.
 
-```bash
-npm install -g agentxl
-agentxl start
-```
-
-No server. No cloud account with us. No classic RAG stack. You bring your own AI model.
-
 ---
 
 ## Quick Start
 
-### 1. Install
-
-**Option A — npm**
+### 3 commands. That's it.
 
 ```bash
 npm install -g agentxl
+agentxl install
+agentxl start
 ```
 
-**Option B — Windows installer**
+| Command | What it does | When |
+|---------|-------------|------|
+| `npm install -g agentxl` | Installs AgentXL | Once |
+| `agentxl install` | Registers the add-in with Excel (certs + manifest + loopback) | Once |
+| `agentxl start` | Starts the local server | Every time |
 
-Use the packaged `AgentXL-Setup-<version>.exe`.
+After `agentxl install`, open Excel → **AgentXL** appears on the **Home** ribbon. No Trust Center. No manual sideloading.
 
-The installer is self-contained. It:
-- bundles its own Node.js runtime
-- bundles the built AgentXL app and production dependencies
-- copies `manifest.xml` into a stable local folder for Excel catalog setup
-- creates Start Menu shortcuts for Start/Login/Open Taskpane
-- does not require a separate Node.js installation on the target machine
+> On first run, `agentxl start` will ask you to sign in with your AI provider.
 
-### 2. Start
+---
 
-```bash
-agentxl start
-```
+### Windows — no coding required
 
-The CLI walks you through setup:
+1. Download the latest `.zip` from [GitHub Releases](https://github.com/satish860/agentxl/releases)
+2. Extract to a folder (e.g. `Desktop\AgentXL`)
+3. Double-click **AgentXL.vbs**
+4. If sign-in is needed, run **AgentXL Login.vbs** first
+5. Excel opens with AgentXL in the **Home** ribbon
 
-```
-  ✅ Auth ready
-  ✅ HTTPS certificate ready
-  ✅ Server running at https://localhost:3001
-```
+The release ZIP is self-contained — bundled Node.js, no system install required.
+
+---
 
-### 3. Choose your AI provider
+### Choose your AI provider
 
 On first run, the CLI asks how to connect:
 
@@ -99,39 +88,45 @@ On first run, the CLI asks how to connect:
 
 > **Already use Pi?** AgentXL shares credentials from `~/.pi/agent/auth.json`. No extra login needed.
 
-### 4. Verify in browser
+---
 
-Open **https://localhost:3001/taskpane/** in your browser.
+### Start from a document folder
 
-You should see the AgentXL UI. This confirms the server, HTTPS, and UI all work before you touch Excel.
+1. Open Excel → click **AgentXL** on the Home ribbon
+2. Link a **local folder** containing your source documents
+3. Ask a question — the agent searches the folder, reads the files, returns grounded answers
 
-### 5. Add to Excel (one-time setup)
+Example prompts:
 
-1. **Excel** → **File** → **Options** → **Trust Center** → **Trust Center Settings**
-2. Click **Trusted Add-in Catalogs**
-3. Add the catalog path printed in your terminal
-   - Windows installer default: `C:\Program Files\AgentXL\manifest`
-   - npm install flow: use the path printed by `agentxl start`
-4. Check **Show in Menu** → **OK** → **OK**
-5. **Restart Excel**
-6. **Insert** → **My Add-ins** → **SHARED FOLDER** tab → **AgentXL** → **Add**
+- **"Extract the relevant values from the source documents and map them into Excel."**
+- **"Compare this trial balance folder to the lead sheet and flag mismatches."**
+- **"Pull lease terms from these agreements into the lease schedule."**
+- **"Show me which workbook cells came from which source files."**
 
-### 6. Start from a document folder
+---
 
-Open Excel, launch **AgentXL**, then use a workflow like:
+## Alternative install methods
 
-1. select the workbook you want to populate
-2. point AgentXL at a local folder of supporting files
-3. ask a grounded question
-4. review the answer and source traceability
-5. map the output into Excel
+### Install the Excel add-in only (if you already have the server)
 
-Example prompts:
+**Option A — Office Store (coming soon)**
+1. Open Excel → **Insert** → **Get Add-ins**
+2. Search **"AgentXL"** → click **Add**
 
-- **"Compare this trial balance folder to the lead sheet and flag mismatches."**
-- **"Extract the cash balance from the bank statement folder and map it to the cash workpaper."**
-- **"Pull lease terms from these agreements into the lease schedule."**
-- **"Show me which workbook cells came from which source files."**
+> The Office Store listing is pending review. Use the `agentxl install` command or Option B/C below.
+
+**Option B — Upload hosted manifest**
+1. Download [`manifest.xml`](https://satish860.github.io/agentxl/manifest/manifest.xml)
+2. Open Excel → **Insert** → **Get Add-ins** → **My Add-ins** → **Upload My Add-in**
+3. Browse to the downloaded `manifest.xml` → **Upload**
+
+**Option C — Shared folder catalog (persistent, Windows)**
+1. **Excel** → **File** → **Options** → **Trust Center** → **Trust Center Settings**
+2. Click **Trusted Add-in Catalogs**
+3. Add the `manifest` folder path from your release ZIP or the path printed by `agentxl start`
+4. Check **Show in Menu** → **OK** → **OK**
+5. **Restart Excel**
+6. **Insert** → **My Add-ins** → **SHARED FOLDER** → **AgentXL** → **Add**
 
 ---
 
@@ -164,7 +159,7 @@ This makes it a fit for:
 ## What AgentXL Is Not
 
 - **Not classic RAG.** No need to start with embeddings, vector DBs, and a retrieval stack.
-- **Not generic spreadsheet chat.** The primary action is not “ask Excel a question.”
+- **Not generic spreadsheet chat.** The primary action is not "ask Excel a question."
 - **Not automation theater.** The goal is reviewable outputs with sources, not flashy demos.
 - **Not a 36-tool architecture diagram.** One parser, one model, direct file search, and an eval loop beat unnecessary layers.
 
@@ -172,117 +167,23 @@ This makes it a fit for:
 
 ## The Method
 
-AgentXL follows a simple method inspired by real document-processing systems:
-
-1. **Parse the files**
-   - PDFs, Excel files, CSVs, statements, agreements, support docs
-2. **Search the folder agentically**
-   - inspect filenames, structure, metadata, and contents
-   - read the right files instead of pre-building a giant stack
-3. **Ask the model to extract or answer**
-   - one grounded task at a time
-4. **Map the result into Excel**
-   - workpapers, schedules, exception lists, summaries
-5. **Measure whether it was right**
-   - evals, failure analysis, correction loops
-6. **Improve the system**
-   - fix repeated failure patterns, then measure again
+AgentXL follows a simple method:
+
+1. **Parse the files** — PDFs, Excel files, CSVs, statements, agreements
+2. **Search the folder agentically** — inspect filenames, structure, metadata, and contents
+3. **Ask the model to extract or answer** — one grounded task at a time
+4. **Map the result into Excel** — workpapers, schedules, exception lists
+5. **Measure whether it was right** — evals, failure analysis, correction loops
+6. **Improve the system** — fix repeated failure patterns, then measure again
 
 ### The core loop
 
 **Parse → Search → Ask → Evaluate → Fix → Repeat**
 
-That is the product.
-
----
-
-## Core Workflow
-
-AgentXL is designed around a folder-first workflow:
-
-1. **Link a local folder** — point AgentXL at a folder of source documents (PDFs, CSVs, Excel files, text)
-2. **AgentXL scans the folder** — builds an inventory of supported files, shows counts in the UI
-3. **Ask a question or give an instruction** — the agent knows what files are available
-4. **The agent searches and reads the relevant files** — using `read`, `grep`, `find`, `ls` tools (visible as live badges in the UI)
-5. **Review the grounded result** — answers cite the source file and content
-6. **Write the output into Excel** — as a workpaper, schedule, or exception list *(coming next)*
-
-The agent's working directory is set to your linked folder. When you say "list the files," it lists *your documents*, not the AgentXL project.
-
----
-
-## Current Build Status
-
-| Area | Status |
-|------|--------|
-| Excel taskpane shell | ✅ Done |
-| Local server + auth flow | ✅ Done |
-| Model connection | ✅ Done |
-| Workbook identity resolution | ✅ Done |
-| Folder linking + native picker | ✅ Done |
-| Folder scanning + file inventory | ✅ Done |
-| Folder-aware agent (cwd, context) | ✅ Done |
-| Agentic file search (read, grep, find, ls) | ✅ Done |
-| Tool call visibility in UI | ✅ Done |
-| Source traceability into Excel | 🔜 Next |
-| Excel write tools | Planned |
-| Eval-driven extraction improvement loop | Planned |
-
----
-
-## What It Does
-
-The target behavior looks like this:
-
-| You ask | AgentXL does |
-|---------|---------------|
-| "Extract the ending cash balance from the bank statement folder and map it to the cash workpaper" | Finds the relevant statement, extracts the value, and writes it into Excel |
-| "Compare this trial balance export folder to the lead sheet and flag mismatches" | Reconciles source documents against the workbook and surfaces exceptions |
-| "Pull lease start date, end date, and monthly payment from these agreements into the lease schedule" | Reads the agreements and maps structured fields into the schedule |
-| "Show me which cells in this sheet came from which source files" | Returns traceability for mapped workbook values |
-| "Create a support summary for this balance from the source folder" | Searches the folder, answers from evidence, and structures the output for review |
-| "Format this output as a clean review-ready workpaper" | Applies spreadsheet formatting after the data is mapped |
-
-### Underlying Excel Tools
-
-These are implementation tools, not the product story:
-
-| Tool | What It Does |
-|------|-------------|
-| `excel_read_range` | Read data, values, formulas from any range |
-| `excel_write_range` | Write values or formulas to ranges |
-| `excel_create_table` | Convert ranges to structured Excel tables |
-| `excel_create_chart` | Create charts (column, bar, line, pie, scatter, area, doughnut) |
-| `excel_get_workbook_info` | Get workbook metadata — sheets, tables, named ranges |
-| `excel_format_range` | Apply formatting — fonts, colors, borders, number formats |
-| `excel_insert_rows` | Insert rows into worksheets |
-| `excel_delete_rows` | Delete rows from worksheets |
-| `excel_add_worksheet` | Add new worksheets |
-| `excel_run_formula` | Evaluate formulas without writing to cells |
-
 ---
 
 ## How It Works
 
-```text
-agentxl start
-  → Local HTTPS server on localhost:3001
-  → Serves taskpane UI at /taskpane
-  → Connects to your chosen model
-
-You point AgentXL at a local folder
-  → PDFs, statements, exports, agreements, support files
-  → Agent searches the folder
-  → Agent reads the relevant documents
-  → You ask a question or request a mapping
-
-Excel loads the taskpane
-  → Agent returns a grounded result with source traceability
-  → Taskpane writes the output into Excel via Office.js
-```
-
-### Architecture
-
 ```text
 ┌─────────────────────────────────────────────────────────────┐
 │                        YOUR MACHINE                         │
@@ -293,7 +194,7 @@ Excel loads the taskpane
 │              ▼                                              │
 │  ┌─────────────────┐        ┌───────────────────────────┐   │
 │  │      Excel      │ HTTPS  │     AgentXL Server        │   │
-│  │                 │◄──────►│     localhost:3001        │   │
+│  │                 │◄──────►│     localhost:3001         │   │
 │  │  Taskpane UI    │        │                           │   │
 │  │  Office.js      │        │  agentic file search      │   │
 │  │                 │        │  selective file reading    │   │
@@ -305,32 +206,17 @@ Excel loads the taskpane
                                               │ model API
                                               ▼
                                  ┌──────────────────────────┐
-                                 │ Anthropic / OpenAI /    │
-                                 │ OpenRouter / Azure /    │
-                                 │ Google / Copilot        │
+                                 │ Anthropic / OpenAI /     │
+                                 │ OpenRouter / Azure /     │
+                                 │ Google / Copilot         │
                                  └──────────────────────────┘
 ```
 
-### Why no classic RAG?
-
-Because most teams do not need a 9-layer retrieval stack to answer grounded questions from a folder of documents.
-
-AgentXL starts simpler:
-
-- local files
-- direct parsing
-- agentic search
-- selective reading
-- one model
-- explicit evals
-
-If scale later demands heavier infrastructure, add it later. Measure first.
-
 ---
 
 ## Supported Providers
 
-### Subscriptions (sign in with your browser — no API key)
+### Subscriptions (sign in with your browser)
 
 | Provider | What You Need | Best for |
 |----------|---------------|----------|
@@ -356,84 +242,45 @@ If scale later demands heavier infrastructure, add it later. Measure first.
 ## Privacy & Security
 
 - **Local-only server.** Binds to `127.0.0.1` — not accessible from your network.
-- **Folder-first workflow.** You start from a local document folder on your machine.
 - **No telemetry.** No analytics. No data collection. No phone-home.
 - **No account required.** No sign-up with us. Ever.
 - **Your API key stays local.** Stored in `~/.pi/agent/auth.json` on your machine.
 - **Open source.** Read every line of code. MIT license.
 
-When you ask the agent about your documents or workbook, the relevant content is sent to your chosen model provider as part of the prompt. This is the only external communication.
+When you ask the agent about your documents, the relevant content is sent to your chosen model provider as part of the prompt. This is the only external communication.
 
 ---
 
-## Troubleshooting
-
-### Taskpane is blank or won't load in Excel
-
-**Most common first-run issue.** Usually means Excel doesn't trust the HTTPS certificate.
-
-1. **Is the server running?** Check for `✅ Server running` in your terminal.
-2. **Does it work in the browser?** Open https://localhost:3001/taskpane/
-   - ✅ UI loads → server and cert are fine. Issue is Excel setup.
-   - ❌ Browser warns about certificate → cert isn't trusted yet.
-3. **Certificate not trusted?**
-   ```bash
-   npx office-addin-dev-certs install
-   ```
-   Then restart Excel.
-4. **Browser works but not Excel?** Excel uses the OS trust store. Make sure the certificate authority is installed system-wide.
-
-### Add-in doesn't appear in Excel
-
-1. Is the server running?
-2. Did you add the catalog path in Trust Center → Trusted Add-in Catalogs?
-3. Did you check **Show in Menu**?
-4. Did you restart Excel?
-5. Look in **Insert → My Add-ins → SHARED FOLDER**
-
-### Port 3001 is already in use
+## CLI Reference
 
-```bash
-agentxl start --port 3002
+```text
+agentxl start [--port 3001] [--verbose]    Start the server
+agentxl install [--open]                    Register add-in with Excel (one-time)
+agentxl login                               Set up or change authentication
+agentxl --version                           Print version
+agentxl --help                              Show help
 ```
 
-> If you change the port, update `manifest/manifest.xml` to match.
+---
 
-### Building the Windows installer
+## Troubleshooting
 
-From the repo root:
+### Taskpane is blank or won't load
 
-```bash
-npm run prepare:installer:win
-```
+1. **Is the server running?** Check for `✅ Server running` in your terminal.
+2. **Does it work in the browser?** Open https://localhost:3001/taskpane/
+3. **Certificate not trusted?** Run `agentxl install` again — it handles cert trust.
 
-This creates a **self-contained** installer payload in:
+### Add-in doesn't appear in Excel
 
-```text
-release/windows/payload
-```
+Run `agentxl install` — it registers the manifest automatically. Then restart Excel.
 
-It includes:
-- the built app
-- production `node_modules`
-- a bundled Node.js runtime
+If that doesn't work, use the manual shared folder catalog method (see [Alternative install methods](#alternative-install-methods)).
 
-To compile the `.exe` installer, install **Inno Setup 6** and run:
+### Port 3001 already in use
 
 ```bash
-npm run build:installer:win
-```
-
-The compiled installer is written to:
-
-```text
-release/windows/dist
-```
-
-For a fuller release workflow, see:
-
-```text
-docs/RELEASING.md
+agentxl start --port 3002
 ```
 
 ### "No model available"
@@ -442,28 +289,13 @@ docs/RELEASING.md
 agentxl login
 ```
 
-### Taskpane says "Waiting for credentials…"
-
-Run `agentxl login` in another terminal. The taskpane detects the change automatically.
-
-### "Server disconnected — reconnecting…"
-
-Restart the server:
+### Building the Windows release
 
 ```bash
-agentxl start
+npm run prepare:release:win
 ```
 
----
-
-## CLI Reference
-
-```text
-agentxl start [--port 3001] [--verbose]    Start the server
-agentxl login                               Set up or change authentication
-agentxl --version                           Print version
-agentxl --help                              Show help
-```
+Creates a self-contained ZIP in `release/windows/dist/` — portable Node.js + app + launchers. GitHub Actions builds this automatically on tagged releases.
 
 ---
 
@@ -473,8 +305,6 @@ agentxl --help                              Show help
 - **Microsoft Excel** desktop (Windows or Mac)
 - **An AI provider** — subscription or API key
 
-> Excel for the web is not supported (Office add-in limitation).
-
 ---
 
 ## Development
@@ -484,35 +314,10 @@ git clone https://github.com/satish860/agentxl.git
 cd agentxl
 npm install
 npm run build
-npm test               # 101 unit/integration tests
-npm run test:e2e       # 12 end-to-end tests (Playwright)
+npm test
 node bin/agentxl.js start
 ```
 
-### Project Structure
-
-```text
-bin/agentxl.js                       CLI entry point
-bin/agentxl-folder-picker.exe        Native folder picker (Windows)
-src/server/index.ts                  HTTPS server + API endpoints
-src/server/certs.ts                  Certificate generation
-src/server/workbook-identity.ts      Workbook identity resolution
-src/server/workbook-folder-store.ts  Workbook → folder mapping (JSON)
-src/server/folder-scanner.ts         Recursive file scanner + inventory
-src/server/folder-picker.ts          Native/PowerShell folder picker
-src/agent/session.ts                 Pi SDK agent session (cwd-aware)
-src/agent/models.ts                  Model selection
-taskpane/src/app.tsx                 Taskpane UI orchestrator
-taskpane/src/hooks/                  useAgentStatus, useChatStream,
-                                     useWorkbookIdentity, useFolderLink
-taskpane/src/components/             WelcomeScreen, FolderLinkScreen,
-                                     MessageBubble (tool call badges),
-                                     ChatInput, ThinkingBlock
-taskpane/src/lib/                    API client, stream handler, types
-manifest/manifest.xml                Office add-in manifest
-tests/                               105 tests (unit + integration + e2e)
-```
-
 ---
 
 ## Roadmap
@@ -526,24 +331,6 @@ tests/                               105 tests (unit + integration + e2e)
 
 ---
 
-## Contributing
-
-Contributions welcome. MIT license.
-
-```bash
-npm test          # 101 tests should pass
-npm run test:e2e  # 12 e2e tests should pass
-```
-
-If you contribute, keep the philosophy simple:
-
-- fewer layers
-- grounded outputs
-- explicit traceability
-- evals before infrastructure
-
----
-
 ## License
 
 MIT — [DeltaXY](https://deltaxy.ai)