メインコンテンツへスキップ
Beancount.io Logo

Favaオプション

Favaの設定オプションに関する完全なリファレンスです。Beancount台帳ファイル内のカスタムfava-optionディレクティブを使用してFavaの動作をカスタマイズする方法を学びます。

日付付きの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-patternimport-dirsinsert-entry設定は蓄積されます。挿入ルールは、その日付を使用して宛先を選択するため、これらの日付は意味を持ちます。

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

uv venv .venv-fava-docs
uv pip install --python .venv-fava-docs/bin/python 'beancount==3.2.3' 'beanquery==0.2.0' 'fava==1.30.16'
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スペース区切りの通貨コード(単一文字列内)空のタプル
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はアカウントを提供し、includeします。

; 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はリロード通知を提供します。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:UnrealizedExpenses:Unrealized を作成する変更を確立する訳ではありません。また、特定のデプロイメントがこのスナップショットを実行していることも意味しません。

invert-income-liabilities-equity

損益計算書と貸借対照表における収益、負債、純資産の表示符号を反転します。費用は符号を保持します。ジャーナルエントリ、アカウントジャーナル、格納された投稿は変更されません。

conversion-currencies

換算ドロップダウンの選択肢を単一の文字列内のスペース区切りのリストに置き換えます:

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

このオプションを繰り返すとに、前のリストが置き換えられます。未設定の場合、F合は運営通貨と、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