Pular para o conteúdo principal

Opções do Fava

Referência completa das opções de configuração do Fava. Aprenda a personalizar o comportamento do Fava usando diretivas customizadas fava-option em seus arquivos de razão Beancount.

Configure o Fava padrão com diretivas datadas custom "fava-option". Essas configurações são separadas das opções principais do Beancount.

Esta referência foi executada com Beancount 3.2.3, beanquery 0.2.0 e Fava 1.30.16. A matriz descreve essa versão padrão. O Beancount.io tem um painel e backend separados; suas configurações expostas não comprovam que todos os recursos do Fava padrão estão disponíveis lá.

Sintaxe

Valores são strings entre aspas, incluindo inteiros e booleanos. Este exemplo completo é analisado tanto no Beancount quanto no 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"

A data é obrigatória. O Fava processa as diretivas customizadas carregadas em ordem de data; uma configuração escalar posterior substitui uma anterior. Configurações repetidas de collapse-pattern, import-dirs e insert-entry se acumulam. As regras de inserção usam suas datas para escolher um destino, portanto essas datas são significativas.

Para reproduzir os exemplos localmente, instale uv e crie um ambiente descartável:

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
bean-check main.beancount
fava main.beancount

Crie main.beancount a partir do bloco de configuração primeiro, ou use um razão existente. Os comandos de shell acima usam caminhos POSIX. bean-check verifica a sintaxe e a contabilidade do Beancount; o Fava adicionalmente verifica seus próprios nomes de opções e valores. Inspecione também o relatório de Erros do Fava.

Os padrões abaixo foram lidos da dataclass FavaOptions instalada e verificados em relação ao analisador de opções versionado. "Não definido" significa None; uma coleção vazia significa nenhuma entrada configurada. A coluna tipo-de-valor descreve o conteúdo da string entre aspas.

Opção padrãoTipo de valorPadrão
languageCódigo de tradução suportadoNão definido
localeCódigo de localidade BabelNão definido; torna-se en quando a opção principal render_commas é verdadeira
default-pageCaminho de relatório relativo, opcionalmente com filtrosincome_statement/
fiscal-year-endData fiscal MM-DD12-31
indentInteiro2
currency-columnInteiro61
show-closed-accountsBooleanofalse
show-accounts-with-zero-transactionsBooleanotrue
show-accounts-with-zero-balanceBooleanotrue
show-metadata-indicatorsBooleanotrue
collapse-patternRegex de conta; repetívelLista vazia
sidebar-show-queriesInteiro5
default-fileCaminho de arquivo, ou valor omitido para este arquivoNão definido
insert-entryRegex de conta; repetível, locais datadosLista vazia
auto-reloadBooleanofalse
use-external-editorBooleanofalse
import-configCaminho de configuração de importaçãoNão definido
import-dirsCaminho de diretório; repetívelLista vazia
invert-gains-losses-colorsBooleanofalse
invert-income-liabilities-equityBooleanofalse
conversion-currenciesCódigos de moeda separados por espaço em uma stringTupla vazia
account-journal-include-childrenBooleanotrue
uptodate-indicator-grey-lookback-daysInteiro60
upcoming-eventsInteiro7

Use "true" ou "false" para booleanos. A comparação não diferencia maiúsculas de minúsculas: "TRUE" também ativa uma opção. Qualquer string diferente de uma variação de maiúsculas/minúsculas de "true" é tratada como falsa. Seu analisador de inteiros verifica a sintaxe de inteiro, não um intervalo positivo; use tamanhos de layout positivos e contagens não negativas.

Exibição e Localização

language

Define a tradução da interface, por exemplo "en", "de" ou "zh_CN". Quando não definido, o Fava negocia com o navegador. A localidade deve ter uma tradução fornecida pelo Fava; um código de idioma sintaticamente válido por si só é insuficiente.

locale

Define a formatação de números independentemente do idioma da interface, por exemplo "en_US" ou "de_DE". Sem esta opção, o Fava usa seu padrão de número não localizado. A opção principal option "render_commas" "TRUE" fornece o fallback en. Não herda o idioma do navegador.

default-page

Define o destino dentro do razão, como "balance_sheet/" ou "journal/?time=year". Copie a parte após o slug do razão de uma URL do Fava padrão em funcionamento. Não prefixe com /: os caminhos de relatório são relativos a esse razão.

fiscal-year-end

Define os limites do filtro de tempo fiscal. Por exemplo, "03-31" encerra um ano fiscal em 31 de março. Suporta filtros de ano fiscal e trimestre; não altera datas de transações. O Fava também aceita valores de mês acima de 12 para rotular um ano fiscal que termina no próximo ano civil.

indent

Define o recuo de lançamentos para entradas geradas e formatação do editor. Use uma string de inteiro positivo, como "4".

currency-column

Define a coluna de alinhamento de moeda ao salvar ou alinhar lançamentos. Também posiciona a guia vertical do editor. O padrão é "61".

Visibilidade de Conteúdo

show-closed-accounts

Inclui contas encerradas nas árvores de contas dos relatórios. Contas com saldos diferentes de zero permanecem visíveis independentemente desta configuração.

show-accounts-with-zero-transactions

Inclui contas sem transações nas árvores de contas. Não suprime uma conta que tenha saldo diferente de zero.

show-accounts-with-zero-balance

Inclui contas cujo saldo no relatório é zero. Desative com "false" para uma árvore mais curta.

collapse-pattern

Corresponde a nomes de contas para recolher nas árvores de contas. Repita a diretiva para múltiplos padrões. Por exemplo, "^Assets:Investments" recolhe essa conta e seus descendentes.

Limita o número de consultas salvas vinculadas na barra lateral. "0" oculta esses links. Veja links personalizados e consultas.

show-metadata-indicators

Mostra os pequenos distintivos de metadados nos diários. Defina como "false" para ocultar os distintivos sem remover metadados do razão.

Gerenciamento de Arquivos

default-file

Escolhe o arquivo inicialmente aberto pelo editor e o destino de fallback para novas entradas. Um caminho relativo é resolvido a partir do arquivo que contém a diretiva. Sem valor, o arquivo que contém a diretiva é selecionado. Sem esta opção, o arquivo principal do razão é o fallback. Um arquivo existente também deve ser incluído no razão para ser uma fonte editável.

insert-entry

Coloca uma nova entrada antes de uma diretiva customizada correspondente, no arquivo que contém essa diretiva. Seu regex corresponde a um nome de conta desde o início; nunca pesquisa linhas brutas de arquivo. O Fava considera lançamentos de transação do último para o primeiro. Para a primeira conta com uma correspondência elegível, escolhe a regra mais recente datada estritamente antes da nova entrada. Se nenhuma corresponder, anexa ao arquivo padrão. A implementação de inserção é a autoridade para essas regras.

Crie estes três arquivos no mesmo diretório. main.beancount fornece as contas e inclui:

; 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 contém:

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

february.beancount contém:

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

Inicie o Fava com main.beancount. Adicione estas transações através do formulário de transações; elas são entrada para a operação de inserção, não um arquivo extra para incluir antecipadamente:

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

As duas primeiras entradas vão antes da regra de janeiro. A terceira vai antes da regra de fevereiro. A quarta tenta Assets:Cash, não encontra correspondência, então usa a regra Expenses:Food no arquivo principal. A quinta não tem conta correspondente e anexa a main.beancount. Salvar um lote atualiza os números de linha das regras conforme as entradas são inseridas.

auto-reload

Recarrega a página automaticamente quando o Fava detecta uma mudança de fonte externa. Quando falso, o Fava oferece uma notificação de recarga. Mudanças feitas através do próprio Fava já acionam uma recarga.

use-external-editor

Abre links de fonte através do esquema de URL beancount://. Instale um manipulador no computador que executa o navegador e garanta que ele possa acessar os arquivos do razão. Isso não é uma conexão automática com arquivos em um servidor hospedado.

import-config

Aponta para uma configuração de importador Python. Esta é uma configuração de integração: crie a configuração e instale suas dependências de importador antes de usar o relatório de Importação. Os três pacotes fixados acima não fornecem uma configuração de importador bancário.

import-dirs

Adiciona um diretório para escanear em busca de candidatos de importação. Repita a diretiva para adicionar diretórios. Use diretórios reais e acessíveis; definir a opção não os cria.

Exibição Financeira

unrealized

Não é uma opção do Fava padrão 1.30.16. O Fava relata Unknown option seguido do nome entre crases se você adicioná-la. Não use para configurar contas de ganhos não realizados padrão.

O snapshot do código-fonte do Beancount.io revisado em 2026-09-07 expõe um campo de string separado chamado unrealized, com padrão "Unrealized", em seu analisador de opções de backend e tabela de Configurações do painel. Isso verifica que o campo existe lá. Não estabelece que alterá-lo cria Income:Unrealized ou Expenses:Unrealized, ou que uma implantação específica executa este snapshot.

invert-income-liabilities-equity

Inverte os sinais exibidos de Receitas, Passivos e Patrimônio Líquido na demonstração de resultados e no balanço patrimonial. Despesas mantêm seus sinais. Entradas de diário, diários de conta e lançamentos armazenados permanecem inalterados.

conversion-currencies

Substitui as escolhas do menu suspenso de conversão por uma lista separada por espaços em uma string:

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

Repetir esta opção substitui a lista anterior. Quando não definido, o Fava oferece moedas operacionais mais commodities que reconhece como moedas ISO 4217.

account-journal-include-children

Inclui entradas de contas filhas no diário de uma conta por padrão. Defina como "false" para começar apenas com essa conta.

invert-gains-losses-colors

Inverte as cores usadas para ganhos e perdas não realizados nas visualizações de balanço patrimonial a valor de mercado e balancete. Muda cores, não valores ou nomes de contas.

Monitoramento

uptodate-indicator-grey-lookback-days

Controla o período de retrospectiva do indicador cinza de atualização. Ative indicadores de conta com fava-uptodate-indication: TRUE na diretiva open da conta; veja o exemplo de metadados de UI.

upcoming-events

Controla a contagem de notificações na barra lateral para eventos futuros dentro do número especificado de dias. "0" desativa a contagem.

Configuração Recomendada

Esta configuração completa é um ponto de partida para o ambiente padrão acima. Muda configurações de exibição sem carregar plugins ou exigir arquivos extras:

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"

Visualizando Suas Opções Atuais

No Fava padrão, abra sua página Ajuda → Opções para a referência da versão instalada e verifique Erros após alterar uma diretiva. A ajuda oficial de opções 1.30.16 explica as configurações.

No painel do Beancount.io, abra a página de Configurações de um razão. Sua tabela de Opções do Fava mostra o subconjunto retornado pelo backend. Esta UI foi verificada no snapshot do código-fonte do produto, não através de uma sessão de produção autenticada. Um campo exibido não implica que o painel hospedado implementa o editor, importações ou rotas de URL do Fava padrão.

Veja Também

Fonte: https://beancount.io/pt/docs/Basics/fava-options