Parse Beancount .bean text into typed directive structs.
The parser covers the full Beancount grammar: transactions with cost and
price annotations, balance assertions with tolerance, metadata, comments,
tags, links, and all standard directives including pad, include,
option, query, plugin, pushtag, and poptag.
Parse failures return {:error, %Beancount.Parser.Error{}} with line and
column information.
Summary
Functions
Parse a directive list or .bean text.
Parse .bean text, raising Beancount.Parser.Error on failure.
Read and parse a .bean file from disk.
Parse .bean text into a directive list.
Functions
@spec parse([Beancount.directive()] | binary()) :: {:ok, [Beancount.directive()]} | {:error, Beancount.Parser.Error.t()}
Parse a directive list or .bean text.
Lists pass through unchanged; binaries are parsed.
Examples
iex> {:ok, [open]} = Beancount.Parser.parse([Beancount.open(~D[2026-01-01], "Assets:Bank", ["USD"])])
iex> open.account
"Assets:Bank"
iex> {:ok, [open]} = Beancount.Parser.parse("2026-01-01 open Assets:Bank USD\n")
iex> open.account
"Assets:Bank"@spec parse!(binary()) :: [Beancount.directive()]
Parse .bean text, raising Beancount.Parser.Error on failure.
Examples
iex> Beancount.Parser.parse!("2026-01-01 open Assets:Bank USD\n")
...> |> hd()
...> |> Map.get(:account)
"Assets:Bank"@spec parse_file(Path.t()) :: {:ok, [Beancount.directive()]} | {:error, term()}
Read and parse a .bean file from disk.
Examples
path = Path.join(System.tmp_dir!(), "parser_example.bean")
File.write!(path, "2026-01-01 commodity USD\n")
{:ok, [%Beancount.Directives.Commodity{currency: "USD"}]} =
Beancount.Parser.parse_file(path)@spec parse_text(binary()) :: {:ok, [Beancount.directive()]} | {:error, Beancount.Parser.Error.t()}
Parse .bean text into a directive list.
Examples
iex> {:ok, [open | _]} = Beancount.Parser.parse_text("2026-01-01 open Assets:Bank USD\n")
iex> open.account
"Assets:Bank"