favai 0.1.0

AI Agent Extension for Fava

favai

AI Agent Extension for Fava. favai lets you interact with your Beancount ledger through natural language — import transactions, analyze income and expenses, and explore more agent-driven workflows.

Features

• Import bills — paste bank statement text, upload screenshots or PDFs, and let an LLM agent extract transactions and map them to your ledger accounts
• Chat with your ledger — ask questions in natural language using BQL queries ("What was my food spend this month?")
• Multi-turn editing — give feedback to refine the proposed transactions before writing
• Any LLM provider — OpenAI-compatible or Anthropic-compatible APIs (supports custom endpoints and $ENV_VAR API keys)
• OCR fallback — PaddleOCR extracts text from bill images for non-vision models (optional)

How it works

favai runs the agent loop directly in your browser using pi-agent-core + pi-ai. The LLM agent is embedded in the extension's JavaScript bundle — no external subprocess, no Node.js dependency at runtime.

Browser (FavaAI.js)
  ├── pi-agent-core Agent (unified: import + chat)
  ├── pi-ai provider → favai llm_proxy → your LLM API
  ├── propose_transactions tool (import) — updates proposal table
  ├── bql_query tool (chat) — queries fava's built-in BQL API
  └── import_confirm → writes entries via fava's existing write path

favai backend (Flask, stateless)
  ├── config (GET/POST) — provider settings
  ├── ingest (POST) — file/text processing (text/image/PDF)
  ├── llm_proxy (POST) — forwards LLM requests with injected API key
  └── import_confirm (POST) — validates and writes entries to ledger

Installation

Prerequisites

• Python >= 3.12
• Fava >= 1.30.14
• An LLM API key (OpenAI, Anthropic, or any compatible endpoint)

Install from PyPI

pip install favai

With OCR fallback for image-based bills:

pip install "favai[ocr]"

Install from source (development)

# Clone the repo
git clone https://github.com/theodoretsui/favai.git
cd favai

# Install Python dependencies
uv sync

# Build the frontend
cd frontend && npm install && npm run build && cd ..

Configure Fava

Add the extension to your Beancount file:

2026-01-01 custom "fava-extension" "favai"

The extension page will appear at /<your-ledger>/extension/FavaAI/.

Optional: OCR support

pip install "favai[ocr]"
# or: uv sync --extra ocr

Usage

1. Configure an LLM provider

Click the gear icon (top-right) and enter:

• Provider preset: OpenAI, Anthropic, OpenCode Zen, LiteLLM, DeepSeek, or Kimi Coding Plan
• API type: OpenAI Compatible or Anthropic Compatible
• Base URL: your endpoint (e.g. https://api.openai.com/v1 or a custom proxy)
• Model: the model identifier (e.g. gpt-4o, claude-sonnet-4-6)
• API Key: a literal key or an $ENV_VAR reference (recommended)

Use Fetch models to load the provider's model list. A model can also be selected above the chat before the first message. The selected model is stored with the session and cannot be changed after that session starts, which keeps multimodal message history compatible with the model that created it.

Provider settings are stored as a list in .favai/config.json. The Test connection & save action writes or replaces one provider only after its Models API succeeds. Every saved provider and its discovered models then appears in the new-session model selector.

2. Import bills

In the chat interface, paste text or upload files (.txt, .csv, .png, .jpg, .pdf, etc.) and press Enter. The LLM agent extracts transactions and presents them in an editable table. You can:

• Edit cells directly in the table
• Send natural-language feedback ("change this one to Dining")
• Confirm to write, or discard

3. Chat with your ledger

Type questions like:

• "What was my food spend last month?"
• "Show me all transactions to Alipay in July"
• "How much did I spend on utilities this year?"

The agent translates your questions into BQL queries and summarises the results.

Security

• API keys are stored next to your Beancount file in .favai/config.json (git-ignored by default)
• Environment variable references are recommended: $MY_API_KEY
• The browser never has access to the real API key — LLM requests pass through the backend proxy
• No file-system or shell access is granted to the LLM agent (only the registered tools)

Development

# Install dependencies
make deps

# Run tests
make test

# Lint
make lint

# Build frontend
make build

# Serve the example ledger
make run

See also AGENTS.md for architecture details and code conventions.

License

favai is licensed under the MIT License.