Beancount.Directives.Plugin (beancount_ex v0.6.0)

Copy Markdown View Source

The plugin directive loads a Beancount plugin module.

See Plugins.

Beancount syntax

plugin "beancount.plugins.auto_accounts"
plugin "beancount.plugins.auto_accounts" "Assets:Cash"

General form: plugin "Module" ["Config"]

Elixir struct

%Beancount.Directives.Plugin{
  module: "beancount.plugins.auto_accounts",
  config: nil
}

%Beancount.Directives.Plugin{
  module: "beancount.plugins.auto_accounts",
  config: "Assets:Cash"
}

Or use Beancount.plugin/2:

Beancount.plugin("beancount.plugins.auto_accounts")
Beancount.plugin("beancount.plugins.auto_accounts", "Assets:Cash")

Fields

  • module - Python plugin module path as a string (Beancount plugin name).
  • config - optional configuration string passed to the plugin. nil omits the second argument in rendered .bean text.

Summary

Types

t()

@type t() :: %Beancount.Directives.Plugin{
  config: String.t() | nil,
  module: String.t()
}