Skip to content

satish860/agentxl

Repository files navigation

AgentXL

AgentXL

Turn source documents into traceable Excel workpapers.
A local-first agent for document-heavy work that ends in spreadsheets.
Point AgentXL at a folder, let it search the evidence, then map grounded answers into Excel.

npm version MIT License Platform Node 20+

Quick Start β€’ The Method β€’ How It Works β€’ Providers β€’ Troubleshooting


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:

  • point to a local folder of source documents
  • ask a question or give an instruction
  • let the agent search the evidence and read the right files
  • map the grounded result into Excel with traceability

Built for audit and diligence workflows first β€” useful anywhere document-heavy work ends in spreadsheets.

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

Testing AgentXL on Windows (no coding required)

If you are testing AgentXL and do not want to use npm or the command line, use this path:

  1. Open the GitHub Releases page:
  2. Download the latest Windows asset:
    • AgentXL-Setup-<version>.msi when available
    • AgentXL-Setup-<version>.exe when available
    • or AgentXL-Windows-Payload-<version>.zip
  3. If you downloaded the .msi or .exe, install AgentXL and launch:
    • Launch AgentXL onboarding from the Start Menu
  4. If you downloaded the .zip, extract it to a normal folder like:
    • Desktop\\AgentXL then double-click:
    • Launch AgentXL Onboarding.cmd
  5. If sign-in is needed, run:
    • AgentXL Login
    • or AgentXL Login.cmd
  6. Wait for Excel to open, then click AgentXL on the Home tab if the task pane is not already visible

The Windows flow now tries to automate:

  • trusting the localhost Office certificate
  • registering the add-in with Office
  • enabling localhost loopback when needed
  • opening Excel with AgentXL sideloaded

After that, your tester can pick a document folder and try the workflow.

1. Install

Option A β€” npm

npm install -g agentxl

This is the simplest cross-platform install path.

Option B β€” GitHub Releases (Windows)

Download the latest Windows asset from:

Windows asset options:

  • AgentXL-Setup-<version>.msi β†’ best for guided Windows onboarding
  • AgentXL-Setup-<version>.exe β†’ installer alternative
  • AgentXL-Windows-Payload-<version>.zip β†’ portable fallback; extract and run Launch AgentXL Onboarding.cmd

The Windows package is self-contained. It:

  • bundles its own Node.js runtime
  • bundles the built AgentXL app and production dependencies
  • includes a manifest folder for Excel setup fallback
  • includes onboarding launchers such as Launch AgentXL Onboarding.cmd
  • does not require a separate Node.js installation on the target machine

2. Start

agentxl start

The CLI walks you through setup:

  βœ… Auth ready
  βœ… HTTPS certificate ready
  βœ… Server running at https://localhost:3001

3. Choose your AI provider

On first run, the CLI asks how to connect:

If you have... Pick Why
Claude Pro/Max subscription Option 1 β€” sign in with browser Best quality, no extra cost
ChatGPT Plus/Pro subscription Option 2 β€” sign in with browser If you already pay for ChatGPT
GitHub Copilot subscription Option 3 β€” sign in with browser If you already have Copilot
An API key Option 5 β€” paste your key Direct access, pay-per-use
Nothing yet Get a free OpenRouter key Free models, no credit card

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.

You should see the AgentXL UI. This confirms the server, HTTPS, and UI all work before you touch Excel.

5. Add to Excel (one-time setup)

Windows installer / Windows release path:

  • AgentXL now tries to automate this step for you.
  • Fastest path:
    • installer: run Launch AgentXL onboarding from the Start Menu
    • zip: run Launch AgentXL Onboarding.cmd
  • If Excel was already open, close it and open it again.
  • If the task pane is not already visible, click AgentXL on Excel's Home tab.

Fallback if Office blocks automatic registration:

  1. Excel β†’ File β†’ Options β†’ Trust Center β†’ Trust Center Settings
  2. Click Trusted Add-in Catalogs
  3. Add the catalog path
    • Windows install default: C:\Program Files\AgentXL\manifest
    • Windows zip default: the extracted manifest folder
    • 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

6. Start from a document folder

Open Excel, launch AgentXL, and the first-run taskpane now guides the user through:

  1. Connect β€” sign in with your model provider if needed
  2. Folder β€” choose the local folder with supporting documents
  3. Ask β€” send a grounded question about that folder

From there, the working flow is:

  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

Example prompts:

  • "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."

What AgentXL Is

AgentXL is not an Excel chatbot.

It is a document-to-Excel agent for evidence-heavy work.

The source of truth lives in documents. The final output lives in Excel. AgentXL sits in between:

  • searching through local files
  • reading the relevant documents
  • extracting grounded facts
  • reconciling across sources
  • mapping outputs into workpapers
  • preserving source traceability

This makes it a fit for:

  • audit
  • due diligence
  • transaction support
  • compliance reviews
  • finance ops
  • any workflow where messy documents become structured spreadsheets

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 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.

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

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

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

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                        YOUR MACHINE                         β”‚
β”‚                                                             β”‚
β”‚  Local document folder                                      β”‚
β”‚  PDFs / statements / CSVs / agreements / support files      β”‚
β”‚              β”‚                                              β”‚
β”‚              β–Ό                                              β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”        β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”‚
β”‚  β”‚      Excel      β”‚ HTTPS  β”‚     AgentXL Server        β”‚   β”‚
β”‚  β”‚                 │◄──────►│     localhost:3001        β”‚   β”‚
β”‚  β”‚  Taskpane UI    β”‚        β”‚                           β”‚   β”‚
β”‚  β”‚  Office.js      β”‚        β”‚  agentic file search      β”‚   β”‚
β”‚  β”‚                 β”‚        β”‚  selective file reading    β”‚   β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜        β”‚  model prompt + response   β”‚   β”‚
β”‚                              β”‚  SSE event streaming       β”‚   β”‚
β”‚                              β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β”‚
β”‚                                             β”‚                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                              β”‚ model API
                                              β–Ό
                                 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                                 β”‚ 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)

Provider What You Need Best for
Anthropic Claude Pro or Max ($20/mo) Best quality
OpenAI Codex ChatGPT Plus or Pro ($20/mo) Already paying for ChatGPT
GitHub Copilot Copilot Individual or Business Already have Copilot
Google Cloud Code Assist (Gemini CLI) Google Cloud users

API Keys (paste your key)

Provider Models Best for
Anthropic Claude Sonnet, Opus Direct API access
OpenAI GPT-4o, GPT-4 Turbo Direct API access
OpenRouter 100+ models Cheapest β€” free models available

Cheapest: OpenRouter has free-tier models. No credit card needed.

Switch anytime: agentxl login


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.


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?
    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 try the automated Windows onboarding path first?
    • Start Menu: Launch AgentXL onboarding
    • zip build: Launch AgentXL Onboarding.cmd
  3. If automatic setup failed, did you add the catalog path in Trust Center β†’ Trusted Add-in Catalogs?
  4. Did you check Show in Menu?
  5. Did you restart Excel?
  6. Look in Insert β†’ My Add-ins β†’ SHARED FOLDER

Port 3001 is already in use

agentxl start --port 3002

If you change the port, update manifest/manifest.xml to match.

Building the Windows installer

From the repo root:

npm run prepare:installer:win

This creates a self-contained Windows payload in:

release/windows/payload

It includes:

  • the built app
  • production node_modules
  • a bundled Node.js runtime

Published GitHub releases can attach:

  • an MSI installer: AgentXL-Setup-<version>.msi
  • an EXE installer: AgentXL-Setup-<version>.exe
  • or a self-contained payload zip: AgentXL-Windows-Payload-<version>.zip

To compile the MSI installer, install WiX Toolset 3.14 and run:

npm run build:msi:win

To compile the EXE installer, install Inno Setup 6 and run:

npm run build:installer:win

Compiled installers are written to:

release/windows/dist

For release/publish steps, see:

docs/RELEASING.md

"No model available"

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:

agentxl start

CLI Reference

agentxl start [--port 3001] [--verbose]    Start the server
agentxl login                               Set up or change authentication
agentxl --version                           Print version
agentxl --help                              Show help

Requirements

  • Node.js 20+
  • 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

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)
node bin/agentxl.js start

Project Structure

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

Module What Status
Module 1 Local taskpane shell, auth, and streaming chat βœ… Done
Module 2 Folder-first workflow: link folders, scan files, agent reads documents βœ… Done
Module 3 Source extraction, traceable citations, and Excel mapping πŸ”œ Next
Module 4 Eval loop, failure analysis, and workflow hardening Planned

Contributing

Contributions welcome. MIT license.

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

Built with Pi Coding Agent SDK.

About

Open-source AI agent that lives inside Microsoft Excel

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors