auto-bean-query

Translate natural-language ledger questions into BQL and execute read-only bean-query queries.

1|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/SamArgt/auto-bean --skill auto-bean-query
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: auto-bean-query
Source: https://github.com/SamArgt/auto-bean/tree/main/skill_sources/auto-bean-query
Command: npx skills add https://github.com/SamArgt/auto-bean --skill auto-bean-query

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Query and explain Beancount ledgers safely using bean-query and the Beancount Query Language (BQL). This tool enables Codex to answer ledger-analysis questions such as balances, account activity, date-bounded totals, registers, account discovery, or transaction inspection from ledger.beancount and included beancount/** files without mutating the ledger.

Core Features & Use Cases

  • Read-only Beancount analysis to fetch balances, activity, and transaction history.
  • Safe, guidance-driven translation of natural-language ledger questions into BQL queries.
  • Reusable patterns and references for common query shapes (balances by account, registers, period summaries).

Quick Start

Run bean-query against ledger.beancount to retrieve the desired ledger information.

Frequently Asked Questions about auto-bean-query

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I query Beancount ledger balances using natural language?

To query Beancount ledger balances, this tool translates natural-language questions into Beancount Query Language (BQL) and executes them with bean-query. It retrieves balances, account activity, and date-bounded summaries from your ledger files without mutating the ledger.

What is the safest way to run bean-query against a ledger file?

The safest way to run bean-query is using a read-only tool that enforces guardrails for explicit account patterns and access restrictions. This prevents accidental mutations to your ledger.beancount files while fetching balances, registers, and transaction inspections.

Can I inspect specific Beancount transactions without modifying the ledger?

Yes, you can inspect specific Beancount transactions without modifying the ledger. The tool executes BQL queries in a strictly read-only scope, fetching transaction history and account activity while ensuring underlying files remain completely unmutated.

Does bean-query support date-bounded summaries for account activity?

Bean-query supports date-bounded summaries for account activity by translating your date range constraints into BQL. The tool fetches period summaries, registers, and balances within specified dates, applying caveats when inventories or costs affect the results.

What are the limitations of querying Beancount ledgers with BQL?

Limitations of querying Beancount ledgers with BQL include a strictly read-only scope that prevents mutating ledger files or underlying data. Additionally, the tool applies clear caveats when inventories or costs affect query results to ensure accurate ledger analysis.

How do I discover accounts in a Beancount ledger?

To discover accounts in a Beancount ledger, the tool translates your natural-language request into BQL and executes bean-query. It retrieves account discovery data, balances, and transaction history from ledger.beancount and included beancount files in a safe, read-only manner.