Aller au contenu principal

Référence des options Fava pour l'interface web Beancount

Options de configuration Fava pour les journaux Beancount : personnalisez l'interface web avec des directives fava-option dans vos fichiers de journal.

Configurez Fava standard avec des directives datées custom "fava-option". Ces paramètres sont distincts des options de base de Beancount.

Cette référence a été exécutée avec Beancount 3.2.3, beanquery 0.2.0 et Fava 1.30.16. La matrice décrit cette version de Fava. Beancount.io dispose d'un tableau de bord et d'un backend distincts ; ses paramètres exposés ne prouvent pas que toutes les fonctionnalités de Fava standard y sont disponibles.

Syntaxe​

Les valeurs sont des chaînes entre guillemets, y compris les entiers et les booléens. Cet exemple complet est parsé à la fois par Beancount et 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"

La date est obligatoire. Fava traite les directives personnalisées chargées dans l'ordre des dates ; un paramètre scalaire ultérieur remplace un précédent. Les paramètres répétés collapse-pattern, import-dirs et insert-entry s'accumulent. Les règles d'insertion utilisent leurs dates pour choisir une destination, donc ces dates sont significatives.

Pour reproduire les exemples localement, installez uv, puis créez un environnement jetable :

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

Créez d'abord main.beancount à partir du bloc de configuration, ou utilisez un grand livre existant. Les commandes shell ci-dessus utilisent des chemins POSIX. bea check vérifie la syntaxe et la comptabilité Beancount ; Fava vérifie en plus ses propres noms et valeurs d'options. Consultez également le rapport des erreurs de Fava.

Les valeurs par défaut ci-dessous ont été lues depuis la classe de données FavaOptions installée et vérifiées par rapport au analyseur d'options versionné. « Non défini » signifie None ; une collection vide signifie qu'aucune entrée n'est configurée. La colonne type de valeur décrit le contenu de la chaîne entre guillemets.

Option Fava standardType de valeurDéfaut
languageCode de traduction pris en chargeNon défini
localeCode de locale BabelNon défini ; devient en quand l'option de base render_commas est vraie
default-pageChemin relatif de rapport, éventuellement avec filtresincome_statement/
fiscal-year-endDate fiscale MM-DD12-31
indentEntier2
currency-columnEntier61
show-closed-accountsBooléenfalse
show-accounts-with-zero-transactionsBooléentrue
show-accounts-with-zero-balanceBooléentrue
show-metadata-indicatorsBooléentrue
collapse-patternExpression régulière de compte ; répétableListe vide
sidebar-show-queriesEntier5
default-fileChemin de fichier, ou valeur omise pour ce fichierNon défini
insert-entryExpression régulière de compte ; répétable, emplacements datésListe vide
auto-reloadBooléenfalse
use-external-editorBooléenfalse
import-configChemin de configuration d'importationNon défini
import-dirsChemin de répertoire ; répétableListe vide
invert-gains-losses-colorsBooléenfalse
invert-income-liabilities-equityBooléenfalse
conversion-currenciesCodes de devises séparés par des espaces dans une chaîneTuple vide
account-journal-include-childrenBooléentrue
uptodate-indicator-grey-lookback-daysEntier60
upcoming-eventsEntier7

Utilisez "true" ou "false" pour les booléens. La comparaison est insensible à la casse : "TRUE" active également une option. Toute chaîne autre qu'une variante de casse de "true" est considérée comme fausse. Son analyseur d'entiers vérifie la syntaxe des entiers, pas une plage positive ; utilisez des tailles de mise en page positives et des comptages non négatifs.

Affichage et localisation​

language​

Définit la traduction de l'interface, par exemple "en", "de" ou "zh_CN". Lorsqu'elle n'est pas définie, Fava négocie avec le navigateur. La locale doit avoir une traduction fournie par Fava ; un code de langue syntaxiquement valide ne suffit pas.

locale​

Définit le formatage des nombres indépendamment de la langue de l'interface, par exemple "en_US" ou "de_DE". Sans cette option, Fava utilise son modèle de nombres non localisé. L'option de base option "render_commas" "TRUE" fournit le repli en. Il n'hérite pas de la langue du navigateur.

default-page​

Définit la destination dans le grand livre, comme "balance_sheet/" ou "journal/?time=year". Copiez la partie après l'identifiant du grand livre depuis une URL Fava standard fonctionnelle. Ne préfixez pas avec / : les chemins de rapport sont relatifs à ce grand livre.

fiscal-year-end​

Définit les limites du filtre temporel fiscal. Par exemple, "03-31" termine une année fiscale le 31 mars. Il prend en charge les filtres d'année fiscale et de trimestre ; il ne modifie pas les dates de transaction. Fava accepte également des valeurs de mois supérieures à 12 pour étiqueter une année fiscale se terminant dans l'année civile suivante.

indent​

Définit l'indentation des écritures pour les entrées générées et le formatage de l'éditeur. Utilisez une chaîne d'entiers positive, comme "4".

currency-column​

Définit la colonne d'alignement des devises lors de l'enregistrement ou de l'alignement des écritures. Positionne également le guide vertical de l'éditeur. La valeur par défaut est "61".

Visibilité du contenu​

show-closed-accounts​

Inclut les comptes clôturés dans les arborescences de comptes des rapports. Les comptes avec un solde non nul restent visibles quel que soit ce paramètre.

show-accounts-with-zero-transactions​

Inclut les comptes sans transaction dans les arborescences de comptes. Cela ne masque pas un compte ayant un solde non nul.

show-accounts-with-zero-balance​

Inclut les comptes dont le solde du rapport est nul. Désactivez-le avec "false" pour une arborescence plus courte.

collapse-pattern​

Correspond aux noms de comptes à réduire dans les arborescences de comptes. Répétez la directive pour plusieurs motifs. Par exemple, "^Assets:Investments" réduit ce compte et ses descendants.

Limite le nombre de requêtes enregistrées liées dans la barre latérale. "0" masque ces liens. Voir liens et requêtes personnalisés.

show-metadata-indicators​

Affiche les petits badges de métadonnées dans les journaux. Réglez-le sur "false" pour masquer les badges sans supprimer les métadonnées du grand livre.

Gestion des fichiers​

default-file​

Choisit le fichier initialement ouvert par l'éditeur et la destination de secours pour les nouvelles entrées. Un chemin relatif est résolu à partir du fichier contenant la directive. Sans valeur, le fichier contenant est sélectionné. Sans cette option, le fichier principal du grand livre est le fichier de secours. Un fichier existant doit également être inclus dans le grand livre pour être une source modifiable.

insert-entry​

Place une nouvelle entrée avant une directive personnalisée correspondante, dans le fichier contenant cette directive. Son expression régulière correspond à un nom de compte depuis le début ; elle ne recherche jamais les lignes brutes du fichier. Fava considère les écritures de transaction de la dernière à la première. Pour le premier compte avec une correspondance éligible, il choisit la règle la plus récente datée strictement avant la nouvelle entrée. Si aucune ne correspond, il ajoute au fichier par défaut. L'implémentation de l'insertion fait autorité pour ces règles.

Créez ces trois fichiers dans le même répertoire. main.beancount fournit les comptes et inclut :

; 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 contient :

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

february.beancount contient :

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

Démarrez Fava avec main.beancount. Ajoutez ces transactions via son formulaire de transaction ; elles sont entrées pour l'opération d'insertion, pas un fichier supplémentaire à inclure au préalable :

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

Les deux premières entrées vont avant la règle de janvier. La troisième va avant la règle de février. La quatrième essaie Assets:Cash, ne trouve aucune correspondance, puis utilise la règle Expenses:Food dans le fichier principal. La cinquième n'a aucun compte correspondant et s'ajoute à main.beancount. L'enregistrement d'un lot met à jour les numéros de ligne des règles au fur et à mesure que les entrées sont insérées.

auto-reload​

Recharge automatiquement la page lorsque Fava détecte un changement de source externe. Lorsqu'il est à false, Fava propose une notification de rechargement. Les modifications effectuées via Fava lui-même déclenchent déjà un rechargement.

use-external-editor​

Ouvre les liens de source via le schéma d'URL beancount://. Installez un gestionnaire sur l'ordinateur exécutant le navigateur et assurez-vous qu'il peut accéder aux fichiers du grand livre. Ce n'est pas une connexion automatique aux fichiers sur un serveur hébergé.

import-config​

Pointe vers une configuration d'importation Python. C'est un paramètre d'intégration : créez la configuration et installez ses dépendances d'importation avant d'utiliser le rapport d'importation. Les trois paquets épinglés ci-dessus ne fournissent pas de configuration d'importation bancaire.

import-dirs​

Ajoute un répertoire à scanner pour les candidats à l'importation. Répétez la directive pour ajouter des répertoires. Utilisez des répertoires réels et accessibles ; définir l'option ne les crée pas.

Affichage financier​

unrealized​

Pas une option standard de Fava 1.30.16. Fava signale Unknown option suivi du nom entre backticks si vous l'ajoutez. Ne l'utilisez pas pour configurer les comptes de gains non réalisés standard.

Le snapshot source de Beancount.io examiné le 2026-09-07 expose bien un champ de chaîne séparé nommé unrealized, avec la valeur par défaut "Unrealized", dans son analyseur d'options backend et la table des paramètres du tableau de bord. Cela vérifie que le champ existe là. Cela n'établit pas que le modifier crée Income:Unrealized ou Expenses:Unrealized, ni qu'un déploiement particulier exécute ce snapshot.

invert-income-liabilities-equity​

Inverse les signes affichés des revenus, des passifs et des capitaux propres dans le compte de résultat et le bilan. Les dépenses conservent leurs signes. Les écritures de journal, les journaux de comptes et les opérations enregistrées restent inchangés.

conversion-currencies​

Remplace les choix du menu déroulant de conversion par une liste séparée par des espaces en une seule chaîne :

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

Répéter cette option remplace la liste précédente. Lorsqu'elle n'est pas définie, Fava propose les devises de fonctionnement ainsi que les marchandises qu'il reconnaît comme des devises ISO 4217.

account-journal-include-children​

Inclut les écritures des comptes enfants dans le journal d'un compte par défaut. Définissez-le sur "false" pour ne commencer qu'avec ce compte.

invert-gains-losses-colors​

Inverse les couleurs utilisées pour les gains et pertes non réalisés dans les vues du bilan à la valeur de marché et de la balance de vérification. Cela modifie les couleurs, pas les montants ni les noms de comptes.

Surveillance​

uptodate-indicator-grey-lookback-days​

Contrôle la période de rappel de l'indicateur gris de fraîcheur. Activez les indicateurs de compte avec fava-uptodate-indication: TRUE sur la directive open du compte ; consultez l'exemple de métadonnées d'interface.

upcoming-events​

Contrôle le nombre de notifications dans la barre latérale pour les événements à venir dans le nombre de jours spécifié. "0" désactive le compteur.

Configuration recommandée​

Cette configuration complète est un point de départ pour l'environnement standard ci-dessus. Elle modifie les paramètres d'affichage sans charger de plugins ni nécessiter de fichiers supplémentaires :

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"

Afficher vos options actuelles​

Dans Fava standard, ouvrez sa page Aide → Options pour la référence de la version installée et vérifiez les erreurs après avoir modifié une directive. L'aide officielle des options de la version 1.30.16 explique les paramètres.

Dans le tableau de bord Beancount.io, ouvrez la page Paramètres d'un grand livre. Son tableau Options Fava montre le sous-ensemble renvoyé par le backend. Cette interface a été vérifiée dans l'instantané du code source du produit, et non via une session de production authentifiée. Un champ affiché n'implique pas que le tableau de bord hébergé implémente l'éditeur, les importations ou les routes URL de Fava standard.

Voir aussi​

Source : https://beancount.io/fr/docs/Basics/fava-options