Opções do Fava para a interface web do Beancount

Configure o Fava de ações 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 do estoque. Beancount.io possui um painel e backend separados; suas configurações expostas não provam que todos os recursos do Fava para estoque estejam disponíveis lá.

Sintaxe​

Os valores são strings entre aspas, incluindo inteiros e booleanos. Este exemplo completo analisa 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 personalizadas carregadas em ordem cronológica; uma configuração escalar posterior substitui uma anterior. Configurações repetidas collapse-pattern, import-dirs e insert-entry acumulam-se. As regras de inserção usam suas datas para escolher um destino, por isso essas datas são significativas.

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

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

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

Os padrões abaixo foram lidos da dataclass FavaOptions instalada e verificados contra o analisador de opções versionado. “Desconfigurado” significa None; uma coleção vazia significa nenhuma entrada configurada. A coluna do tipo de valor descreve o conteúdo da string entre aspas.

Use "true" ou "false" para valores booleanos. A comparação não diferencia maiúsculas de minúsculas: "TRUE" também ativa uma opção. Qualquer string que não seja uma variante de maiúsculas/minúsculas de "true" é tratada como falso. Seu analisador inteiro verifica a sintaxe do 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 sozinho é insuficiente.

locale​

Define a formatação numérica independentemente do idioma da interface, por exemplo "en_US" ou "de_DE". Sem esta opção, o Fava usa seu padrão numérico não localizado. O núcleo option "render_commas" "TRUE" fornece a alternativa en. Ele não herda o idioma do navegador.

Navegação e Layout​

default-page​

Define o destino dentro do livro-razão, como "balance_sheet/" ou "journal/?time=year". Copie a parte após o slug do livro-razão de uma URL funcional do Fava padrão. Não adicione / no início: caminhos de relatórios são relativos a esse livro-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 as datas das 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 a indentação dos lançamentos para entradas geradas e formatação do editor. Use uma string de número inteiro positivo, como "4".

currency-column​

Define a coluna de alinhamento da 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 do relatório. 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 aos nomes das contas a serem recolhidas nas árvores de contas. Repita a diretiva para múltiplos padrões. Por exemplo, "^Assets:Investments" recolhe essa conta e seus descendentes.

sidebar-show-queries​

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

show-metadata-indicators​

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

Gerenciamento de Arquivos​

default-file​

Escolhe o arquivo aberto inicialmente pelo editor e o destino de reserva para novas entradas. Um caminho relativo é resolvido a partir do arquivo que contém a diretiva. Sem valor, o arquivo contido é selecionado. Sem esta opção, o arquivo principal do livro-razão é o destino de reserva. Um arquivo existente também deve estar incluído no livro-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. Sua regex corresponde a um nome de conta desde o início; nunca procura em linhas brutas do arquivo. O Fava considera lançamentos de transações da última para a primeira. Para a primeira conta com um resultado elegível, ele escolhe a regra mais recente datada estritamente antes da nova entrada. Se nenhuma corresponder, ele anexa ao arquivo padrão. A implementação da inserção é a autoridade para essas regras.

Crie esses 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 essas transações através do formulário de transação dele; elas são entrada para a operação de inserção, não um arquivo extra para incluir antes:

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 é anexada a main.beancount. Salvar um lote atualiza os números das linhas das regras à medida que as entradas são inseridas.

auto-reload​

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

use-external-editor​

Abre links de origem através do esquema de URL beancount://. Instale um manipulador no computador que executa o navegador e assegure que ele possa acessar os arquivos do razão. Esta não é uma conexão automática a 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 candidatos a importação. Repita a diretiva para adicionar diretórios. Use diretórios reais acessíveis; configurar a opção não os cria.

Exibição Financeira​

unrealized​

Não é uma opção padrão do Fava 1.30.16. O Fava reporta Unknown option seguido do nome em crase se você adicioná-lo. Não o utilize para configurar contas padrão de ganho não realizado.

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 do backend e na tabela Configurações do painel. Isso verifica que o campo existe lá. Isso não estabelece que alterá-lo cria Income:Unrealized ou Expenses:Unrealized, nem que uma implantação específica execute este snapshot.

invert-income-liabilities-equity​

Inverte os sinais exibidos de Receita, Passivos e Patrimônio no demonstrativo de resultados e no balanço patrimonial. Despesas mantêm seus sinais. Lançamentos contábeis, diários de conta e lançamentos armazenados permanecem inalterados.

conversion-currencies​

Substitui as opções do menu suspenso de conversão por uma lista separada por espaços em uma só string:

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

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

account-journal-include-children​

Inclui lançamentos 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 visões do balanço patrimonial de valor de mercado e balancete. Isso altera cores, não valores nem nomes de contas.

Monitoramento​

uptodate-indicator-grey-lookback-days​

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

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. Altera as configurações de exibição sem carregar plugins ou exigir arquivos adicionais:

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 a página Ajuda → Opções para referência da versão instalada e verifique Erros após alterar uma diretiva. A ajuda oficial da opção 1.30.16 explica as configurações.

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

Veja Também​

• Configuração de Opções — Diretivas option principais do Beancount.
• Funcionalidades de UI — Fluxos de trabalho padrão do Fava e compatibilidade hospedada.