メインコンテンツへスキップ

BeancountウェブUI向けFavaオプションリファレンス

Beancount台帳用のFava設定オプション:台帳ファイル内のfava-optionディレクティブでウェブUIをカスタマイズできます。詳細は本文を参照。

日付付きのcustom "fava-option"ディレクティブでFavaの株式を設定します。これらの設定はBeancountコアオプションとは別です。

このリファレンスはBeancount 3.2.3、beanquery 0.2.0、Fava 1.30.16で実行されました。このマトリックスはその株式リリースを示しています。Beancount.ioは別のダッシュボードとバックエンドを持ち、その公開された設定はすべての株式Fava機能が利用可能であることを保証するものではありません。

構文​

値は整数や真偽値を含む引用文字列です。この完全な例はBeancountとFavaの両方で解析されます:

; Minimal Fava configuration
option "operating_currency" "USD"
2000-01-01 custom "fava-option" "language" "en"
2000-01-01 custom "fava-option" "default-page" "income_statement/"
2000-01-01 custom "fava-option" "indent" "2"
2000-01-01 custom "fava-option" "show-closed-accounts" "false"

日付は必須です。Favaは読み込まれたカスタムディレクティブを日付順に処理し、後のスカラー設定が前の設定を置き換えます。繰り返されるcollapse-pattern、import-dirs、およびinsert-entryの設定は累積します。挿入ルールは目的地を選ぶためにその日付を使用するので、日付は重要です。

ローカルで例を再現するには、uvをインストールしてから、使い捨て環境を作成します:

uv venv .venv-fava-docs
uv pip install --python .venv-fava-docs/bin/python 'fava==1.30.16'
uv tool install beancount-io
source .venv-fava-docs/bin/activate
bea --file main.beancount check
fava main.beancount

最初に設定ブロックからmain.beancountを作成するか、既存の台帳を使用してください。上記のシェルコマンドはPOSIXパスを使用しています。bea checkはBeancountの構文と会計をチェックし、Favaは追加で自身のオプション名と値をチェックします。Favaのエラー報告も確認してください。

以下のデフォルトはインストールされたFavaOptionsデータクラスから読み取られ、バージョン管理されたオプションパーサーと照合されました。「未設定」はNoneを意味し、空のコレクションは設定された項目がないことを意味します。値の型の列は引用文字列の内容を示します。

ストックオプション値の種類デフォルト
languageサポートされている翻訳コード未設定
localeBabel ロケールコード未設定; コアrender_commasがtrueの場合enになる
default-page相対レポートパス、フィルター付きも可能income_statement/
fiscal-year-end会計年度MM-DD12-31
indent整数2
currency-column整数61
show-closed-accountsブール値false
show-accounts-with-zero-transactionsブール値true
show-accounts-with-zero-balanceブール値true
show-metadata-indicatorsブール値true
collapse-patternアカウント正規表現; 繰り返し可能空リスト
sidebar-show-queries整数5
default-fileファイルパス、またはこのファイルの省略値未設定
insert-entryアカウント正規表現; 繰り返し可能、日付付きの場所
空リスト
auto-reloadブール値false
use-external-editorブール値false
import-configインポート設定パス未設定
import-dirsディレクトリパス; 繰り返し可能空リスト
invert-gains-losses-colorsブール値false
invert-income-liabilities-equityブール値false
conversion-currenciesスペース区切りの通貨コードを1つの文字列で空タプル
account-journal-include-childrenブール値true
uptodate-indicator-grey-lookback-days整数60
upcoming-events整数7

ブール値には"true"または"false"を使用します。比較は大文字・小文字を区別しません:"TRUE"もオプションを有効にします。"true"の大文字小文字のバリアント以外の文字列はすべてfalseとして扱われます。整数パーサは正の範囲ではなく整数構文をチェックします;正のレイアウトサイズおよび非負のカウントを使用してください。

表示とローカリゼーション​

language​

インターフェースの翻訳を設定します。例えば"en"、"de"、または"zh_CN"です。未設定の場合、Favaはブラウザと交渉します。ロケールはFavaによって翻訳が提供されている必要があり、構文的に有効な言語コードだけでは不十分です。

locale​

インターフェース言語とは独立して数字のフォーマットを設定します。例えば"en_US"または"de_DE"です。このオプションがない場合、Favaは非ローカライズされた数字パターンを使用します。コアoption "render_commas" "TRUE"はenフォールバックを提供します。ブラウザ言語は継承しません。

ナビゲーションとレイアウト​

default-page​

元帳内の宛先を設定します。例えば "balance_sheet/" や "journal/?time=year" です。動作中の Fava URL から元帳スラグの後ろの部分をコピーしてください。/ を前置しないでください:レポートのパスはその元帳に対して相対的です。

fiscal-year-end​

会計期間の時間フィルターの境界を設定します。例えば、"03-31" は会計年度を3月31日で終了します。会計年度および四半期のフィルターに対応していますが、取引日の変更はしません。Fava は、翌会計年度の終わりを示すために12を超える月の値も受け入れます。

indent​

生成された仕訳やエディターのフォーマット向けの仕訳字下げを設定します。正の整数の文字列を使用してください。例:"4"。

currency-column​

仕訳の通貨揃え列を設定します。これは保存・揃え時に使われ、エディターの垂直ガイドの位置も決定します。デフォルトは "61" です。

コンテンツ表示​

show-closed-accounts​

クローズされた口座をレポートの口座ツリーに含めます。非ゼロ残高の口座はこの設定に関係なく表示され続けます。

show-accounts-with-zero-transactions​

取引のない口座も口座ツリーに含めます。非ゼロ残高の口座は抑制されません。

show-accounts-with-zero-balance​

レポートの残高がゼロの口座を含めます。ツリーを短くするには "false" でオフにしてください。

collapse-pattern​

口座ツリーで折りたたむ口座名にマッチさせます。複数のパターンには指示を繰り返してください。例:"^Assets:Investments" はその口座と子孫を折りたたみます。

サイドバーにリンクされる保存済みクエリの数を制限します。"0" はそれらのリンクを非表示にします。カスタムリンクとクエリを参照してください。

show-metadata-indicators​

ジャーナル内の小さなメタデータバッジを表示します。"false" に設定すると、元帳からメタデータを削除せずにバッジを隠せます。

ファイル管理​

default-file​

エディターが最初に開くファイルと、新規仕訳のフォールバック先を選択します。相対パスは、この指示を含むファイルから解決されます。値がない場合、指示を含むファイルが選択されます。このオプションがない場合は、メイン元帳ファイルがフォールバックとなります。既存のファイルは編集可能なソースとなるには元帳に含まれている必要があります。

insert-entry​

該当するカスタムディレクティブの前に新しいエントリーを配置します。そのディレクティブを含むファイル内で行われます。正規表現はアカウント名の先頭にマッチし、生のファイル行を直接検索することはありません。Fava は取引の振替を最後から最初へと処理します。適格なマッチがある最初のアカウントに対して、その新しいエントリーの日付より厳密に前の日付の最新ルールを選択します。合致しなければ、デフォルトファイルに追加します。挿入の実装はこれらのルールの権威です。

これら3つのファイルを同一ディレクトリに作成します。main.beancount がアカウントを提供し、以下を含みます:

; main.beancount
option "title" "Insertion Demo"
option "operating_currency" "USD"
include "january.beancount"
include "february.beancount"
2000-01-01 open Assets:Checking USD
2000-01-01 open Assets:Cash USD
2000-01-01 open Assets:Wallet USD
2000-01-01 open Expenses:Food USD
2000-01-01 custom "fava-option" "default-file"
2024-01-01 custom "fava-option" "insert-entry" "^Expenses:Food$"

january.beancount は以下を含みます:

; january.beancount
2024-01-01 custom "fava-option" "insert-entry" "^Assets:Checking$"

february.beancount は以下を含みます:

; february.beancount
2024-02-01 custom "fava-option" "insert-entry" "^Assets:Checking$"

main.beancount で Fava を起動します。これらの取引はその取引フォームから追加してください。これは挿入操作への入力であり、事前に追加する別ファイルではありません:

2024-01-15 * "January groceries"
  Expenses:Food       10.00 USD
  Assets:Checking    -10.00 USD
 
2024-02-01 * "Same-day boundary"
  Expenses:Food       20.00 USD
  Assets:Checking    -20.00 USD
 
2024-02-15 * "February groceries"
  Expenses:Food       30.00 USD
  Assets:Checking    -30.00 USD
 
2024-02-16 * "Cash groceries"
  Expenses:Food       40.00 USD
  Assets:Cash        -40.00 USD
 
2024-02-17 * "Unmatched cash transfer"
  Assets:Cash         50.00 USD
  Assets:Wallet      -50.00 USD

最初の2つのエントリーは1月のルールの前に入ります。3つ目は2月のルールの前に入ります。4つ目は Assets:Cash を試すもマッチせず、メインファイルの Expenses:Food ルールを使用します。5つ目はマッチするアカウントがなく main.beancount に追加されます。バッチ保存によりエントリー挿入時にルールの行番号が更新されます。

auto-reload​

Fava が外部ソースの変更を検知したときにページを自動的にリロードします。false の場合はリロード通知が表示されます。Fava 自身からの変更はすでにリロードをトリガーします。

use-external-editor​

beancount:// URLスキームを通じてソースリンクを開きます。ブラウザを実行するコンピュータにハンドラをインストールし、台帳ファイルにアクセスできるようにしてください。これはホスティングサーバのファイルへの自動接続ではありません。

import-config​

Python インポーターの設定を指します。これは統合設定です:構成を作成し、インポーターの依存関係をインストールした上でインポートレポートを使用してください。上記の3つの固定パッケージは銀行インポーター設定を提供しません。

import-dirs​

インポート候補をスキャンするディレクトリを追加します。ディレクティブを繰り返して複数のディレクトリを追加します。実在しアクセス可能なディレクトリを使用してください。オプション設定でディレクトリは作成されません。

金融表示​

unrealized​

Fava 1.30.16の標準オプションではありません。 追加すると Fava は Unknown option と名前をバッククオート付きで報告します。標準の未実現利益勘定設定に使用しないでください。

2026-09-07 にレビューされた Beancount.io のソーススナップショットは、バックエンドのオプションパーサーとダッシュボードの設定テーブルに、デフォルトが "Unrealized" の unrealized という別の文字列フィールドを公開しています。これにより、そのフィールドが存在することが確認されます。ただし、それを変更すると Income:Unrealized や Expenses:Unrealized が作成されることや、特定のデプロイがこのスナップショットを実行していることは証明されません。

invert-income-liabilities-equity​

損益計算書と貸借対照表において、収入、負債および資本の表示符号を反転します。費用は符号を保持します。仕訳帳、勘定帳および保存された仕訳は変更されません。

conversion-currencies​

変換のドロップダウン選択肢をスペース区切りのリスト ひとつの文字列で に置き換えます:

; Conversion dropdown
2000-01-01 custom "fava-option" "conversion-currencies" "USD EUR"

このオプションを繰り返し指定すると、前のリストが置き換えられます。未設定の場合、Fava は稼働通貨と ISO 4217 通貨として認識される商品を提供します。

account-journal-include-children​

デフォルトで、勘定の仕訳帳に子勘定の仕訳を含めます。これを "false" に設定すると、その勘定のみを開始します。

invert-gains-losses-colors​

評価損益が未実現の市場価値貸借対照表および試算表ビューにおいて、色を反転させます。金額や勘定名は変更されず、色のみが変わります。

監視​

uptodate-indicator-grey-lookback-days​

灰色の新鮮さインジケーターの遡及期間を制御します。アカウントの open 指令に fava-uptodate-indication: TRUE を設定してアカウントインジケーターを有効にします。詳細は UI メタデータ例 を参照してください。

upcoming-events​

指定された日数以内の今後のイベントのサイドバーナビゲーション通知数を制御します。"0" はカウントを無効にします。

推奨設定​

この完全な設定は上記の標準環境の出発点です。プラグインを読み込んだり追加ファイルを必要とせずに表示設定を変更します:

option "operating_currency" "USD"
2000-01-01 custom "fava-option" "language" "en"
2000-01-01 custom "fava-option" "locale" "en_US"
2000-01-01 custom "fava-option" "default-page" "income_statement/"
2000-01-01 custom "fava-option" "fiscal-year-end" "12-31"
2000-01-01 custom "fava-option" "indent" "2"
2000-01-01 custom "fava-option" "currency-column" "61"
2000-01-01 custom "fava-option" "show-closed-accounts" "false"
2000-01-01 custom "fava-option" "show-accounts-with-zero-transactions" "true"
2000-01-01 custom "fava-option" "show-accounts-with-zero-balance" "false"
2000-01-01 custom "fava-option" "show-metadata-indicators" "true"
2000-01-01 custom "fava-option" "collapse-pattern" "^Assets:Investments"
2000-01-01 custom "fava-option" "sidebar-show-queries" "5"
2000-01-01 custom "fava-option" "auto-reload" "false"
2000-01-01 custom "fava-option" "use-external-editor" "false"
2000-01-01 custom "fava-option" "invert-income-liabilities-equity" "false"
2000-01-01 custom "fava-option" "invert-gains-losses-colors" "false"
2000-01-01 custom "fava-option" "conversion-currencies" "USD EUR"
2000-01-01 custom "fava-option" "account-journal-include-children" "true"
2000-01-01 custom "fava-option" "upcoming-events" "7"
2000-01-01 custom "fava-option" "uptodate-indicator-grey-lookback-days" "60"

現在のオプションを見る​

標準の Fava では、インストールされているリリースの参照用にヘルプ→オプションページを開き、指令変更後にエラーを確認してください。公式の 1.30.16 オプションヘルプ が設定を説明しています。

Beancount.io ダッシュボードの元帳の設定ページを開きます。Fava オプションテーブルはバックエンドが返すサブセットを示します。この UI は製品ソーススナップショットで検証されており、認証された本番セッションでの確認ではありません。表示されているフィールドは、ホストされているダッシュボードが標準 Fava のエディター、インポートまたは URL ルートを実装していることを意味しません。

関連項目​

  • オプション設定 — Beancountのコアoptionディレクティブ。
  • UI機能 — 標準Favaワークフローとホスティング対応。

出典: https://beancount.io/ja/docs/Basics/fava-options