Referência rápida

Guia de consulta rápida do Ledger CLI

Guia de referência completo para o Ledger CLI: contabilidade por partidas dobradas em texto simples, flags, datas auxiliares, asserções de saldo e filtros de consulta.

· Publicado

Ledger é uma poderosa ferramenta de linha de comando para contabilidade por partidas dobradas em texto simples. Ao gerenciar suas finanças em arquivos de texto legíveis, o Ledger permite calcular saldos, gerar extratos e produzir relatórios financeiros detalhados.


Conceitos fundamentais e primeiros passos

A equação contábil de partidas dobradas

No Ledger, cada transação é composta por dois ou mais lançamentos cuja soma deve ser estritamente zero:

$$\text{Assets} + \text{Expenses} = \text{Liabilities} + \text{Equity} + \text{Income}$$

Assets:Checking          -$600.00   ; Asset decreases (credit)
Expenses:Rent             $600.00   ; Expense increases (debit)
---------------------------------
Saldo líquido = $0.00

Visão geral dos comandos principais

Comando Forma completa Descrição
ledger bal ledger balance Calcula e exibe os saldos atuais de todas as contas
ledger reg ledger register Lista cronologicamente os lançamentos com saldo acumulado
ledger print ledger print Formata e imprime os registros do diário
ledger csv ledger csv Exporta transações filtradas em formato CSV padrão
ledger payees ledger payees Lista todos os favorecidos registrados no diário
ledger accounts ledger accounts Lista todas as contas e sua hierarquia

Especificação de sintaxe do Journal

Estrutura básica da transação

2024/01/03 * (CODE#001) Landlord John ; tag:rent
    Expenses:Rent:Apartment       $600.00
    Assets:Checking:MainBank
  • Detalhamento da linha de cabeçalho::
2024/01/03   *       (CODE#001)   Landlord John     ; tag:rent
^            ^       ^            ^                 ^
Date         State   Code/Check#  Payee/Description Comment & Tags
  • Inferência automática: o Ledger pode calcular automaticamente o valor de um lançamento para equilibrar a transação.

Flags de status da transação

Flag Estado Descrição e uso típico
(None) Não reconciliada Transações novas ainda não conferidas com o extrato bancário
! Pendente Transações iniciadas aguardando compensação
* Reconciliada Transações conciliadas e compensadas no banco

Datas auxiliares

O sinal de igual permite separar a data da transação da data efetiva de liquidação:

; Format: EventDate=SettlementDate
2024/01/01=2024/01/15 Consulting Client A
    Assets:AccountsReceivable    $1,000.00
    Income:Consulting

Asserções e atribuições de saldo

  • Asserção de saldo (= $VALUE): valida se o saldo acumulado da conta corresponde exatamente ao valor.
  • Atribuição de saldo (= $VALUE): calcula a diferença necessária para ajustar a conta ao saldo.
; 1. Balance Assertion
2024/01/01 * Restaurant
    Expenses:Food:Dinner          $20.00
    Assets:Cash                  -$20.00 = $500.00

; 2. Balance Assignment
2024/01/01 * Opening Balance
    Assets:Cash                 = $500.00
    Equity:OpeningBalances

Account Declarations & Validation

account Expenses:Food
    note Dining and grocery expenses
    alias food
    payee ^(KFC|McDonalds|Starbucks)$
    check commodity == "$"
    assert commodity == "$"
    default

account Assets:Cash
    alias cash

Commodities & Currencies

; 1. Per-unit cost (@ symbol)
2024/05/31 * Farmers Market
    Expenses:Food:Apples         10 APPLE @ $1.50
    Assets:Checking             -$15.00

; 2. Total cost (@@ symbol)
2024/06/01 * Brokerage
    Assets:Investments:AAPL      5 AAPL @@ $950.00
    Assets:Checking             -$950.00

; 3. Explicit currency price history
P 2024/06/01 00:00:00 EUR $1.0850

Directives

; Global default currency
D $1,000.00

; Set default year
Y2024

Including Sub-Journals

include accounts.journal
include 2023.journal
include 2024.journal

account Business
include company_expenses.journal
end

Budgeting

~ Monthly
    Expenses:Rent               $600.00
    Expenses:Food               $400.00
    Expenses:Utilities          $100.00
    Expenses                    $100.00
    Assets

~ Yearly
    Expenses:Insurance        $1,200.00
    Assets
  • ledger bal --budget Expenses
  • ledger bal --unbudgeted Expenses

Expressões de período

O Ledger oferece filtragem temporal em linguagem natural por meio da opção -p ou --period.

Syntax Structure

[INTERVAL] [BEGIN] [END]

Intervalos

Intervalo Significado
every day / daily Daily
every week / weekly Weekly
biweekly Every two weeks
every month / monthly Monthly
every quarter / quarterly Quarterly
every year / yearly Yearly
every N days/weeks/months Custom interval

Period Filtering Examples

ledger reg -p "since last month"
ledger reg Expenses -p "every month from 2024 to 2024/12/31" -M
ledger bal -p "from 2024/01/01 until this month"
ledger bal Expenses:Food -p "last quarter"

Expressões de consulta e filtros

Syntax Alvo Exemplo Descrição
Account Account name ledger bal Assets Substring/regex match
^Account Root account ledger bal ^Expenses Accounts starting with Expenses
@Payee Payee name ledger reg @Starbucks Match payee field
%Tag Tag presence ledger reg %reimburse Match tagged transactions
%Tag=Value Tag value ledger reg %project=alpha Match tag key-value pairs
=Note Memo note ledger reg =taxi Match memo text
#Code Transaction code ledger reg #1042 Match check or order number

Lógica booleana

ledger reg Expenses:Food and @Starbucks and not dining
ledger bal Rent or Transportation
ledger bal Expenses and not \( Drinks or Food \)

Opções de filtro comuns

Flag Opção Descrição
-b DATE --begin DATE Filter transactions on or after date
-e DATE --end DATE Filter transactions before date
-C --cleared Only cleared transactions (*)
-U --uncleared Only uncleared transactions
--pending --pending Only pending transactions (!)
-R --real Exclude virtual postings
-r --related Show the offsetting balancing postings

Relatórios e exportação de dados

-s, --subtotal         # Calculate subtotals for grouped postings
-n, --collapse         # Collapse multi-line postings into one line
--flat                 # Render account tree as a flat list
--tail N               # Limit output to last N lines
--invert               # Invert numerical signs (display expenses as positive)
-X CUR, --exchange CUR # Convert foreign holdings to specified currency at latest rate
# Export all entries to CSV
ledger csv > report.csv

# Export this month's dining expenses
ledger csv Expenses:Food -p "this month"

Exemplos práticos

# Current assets vs liabilities
ledger bal ^Assets ^Liabilities

# Net revenue this month with positive expenses
ledger bal ^Expenses ^Income -p "this month" --invert

# Top 10 largest expenses
ledger reg Expenses -S amount --tail 10

# Monthly average daily expenses
ledger reg Expenses -M -n --average

Referências

Temas relacionados