mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-18 17:57:11 +03:00
;doc: update help
This commit is contained in:
Simon Michael
parent
2139505c02
commit
c4e138dfb1
@ -2,7 +2,20 @@ accounts
|
||||
|
||||
List account names.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
-u --used show only accounts used by transactions
|
||||
-d --declared show only accounts declared by account directive
|
||||
--unused show only accounts declared but not used
|
||||
--undeclared show only accounts used but not declared
|
||||
--types also show account types when known
|
||||
--positions also show where accounts were declared
|
||||
--directives show as account directives, for use in journals
|
||||
--find find the first account matched by the first
|
||||
argument (a case-insensitive infix regexp or
|
||||
account name)
|
||||
-l --flat show accounts as a flat list (default)
|
||||
-t --tree show accounts as a tree
|
||||
--drop=N flat mode: omit N leading account name parts
|
||||
|
||||
This command lists account names. By default it shows all known
|
||||
accounts, either used in transactions or declared with account
|
||||
|
||||
@ -2,7 +2,8 @@ activity
|
||||
|
||||
Show an ascii barchart of posting counts per interval.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
The activity command displays an ascii histogram showing transaction
|
||||
counts by day, week, month or other reporting interval (by day is the
|
||||
|
||||
@ -2,7 +2,8 @@ add
|
||||
|
||||
Record new transactions with interactive prompting in the console.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--no-new-accounts don't allow creating new accounts
|
||||
|
||||
Many hledger users edit their journals directly with a text editor, or
|
||||
generate them from CSV. For more interactive data entry, there is the
|
||||
|
||||
@ -5,7 +5,18 @@ aregister
|
||||
Show the transactions and running balances in one account, with each
|
||||
transaction on one line.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--txn-dates filter strictly by transaction date, not posting
|
||||
date. Warning: this can show a wrong running
|
||||
balance.
|
||||
--no-elide don't show only 2 commodities per amount
|
||||
-w --width=N set output width (default: terminal width or
|
||||
$COLUMNS). -wN,M sets description width as well.
|
||||
--align-all guarantee alignment across all lines (slower)
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
aregister shows the overall transactions affecting a particular account
|
||||
(and any subaccounts). Each report line represents one transaction in
|
||||
|
||||
@ -6,7 +6,62 @@ A flexible, general purpose "summing" report that shows accounts with
|
||||
some kind of numeric data. This can be balance changes per period, end
|
||||
balances, budget performance, unrealised capital gains, etc.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--sum show sum of posting amounts (default)
|
||||
--budget[=DESCPAT] show sum of posting amounts together with budget
|
||||
goals defined by periodic
|
||||
transactions. With a DESCPAT argument (must be
|
||||
separated by = not space),
|
||||
use only periodic transactions with matching
|
||||
description
|
||||
(case insensitive substring match).
|
||||
--valuechange show total change of value of period-end
|
||||
historical balances (caused by deposits,
|
||||
withdrawals, market price fluctuations)
|
||||
--gain show unrealised capital gain/loss (historical
|
||||
balance value minus cost basis)
|
||||
--count show the count of postings
|
||||
--change accumulate amounts from column start to column
|
||||
end (in multicolumn reports, default)
|
||||
--cumulative accumulate amounts from report start (specified
|
||||
by e.g. -b/--begin) to column end
|
||||
-H --historical accumulate amounts from journal start to column
|
||||
end (includes postings before report start date)
|
||||
-l --flat show accounts as a flat list (default). Amounts
|
||||
exclude subaccount amounts, except where the
|
||||
account is depth-clipped.
|
||||
-t --tree show accounts as a tree. Amounts include
|
||||
subaccount amounts.
|
||||
--drop=N omit N leading account name parts (in flat mode)
|
||||
--declared include non-parent declared accounts (best used
|
||||
with -E)
|
||||
-A --average show a row average column (in multicolumn
|
||||
reports)
|
||||
-r --related show postings' siblings instead
|
||||
-T --row-total show a row total column (in multicolumn reports)
|
||||
--summary-only display only row summaries (e.g. row total,
|
||||
average) (in multicolumn reports)
|
||||
-N --no-total omit the final total row
|
||||
--no-elide don't squash boring parent accounts (in tree
|
||||
mode)
|
||||
--format=FORMATSTR use this custom line format (in simple reports)
|
||||
-S --sort-amount sort by amount instead of account code/name (in
|
||||
flat mode). With multiple columns, sorts by the row
|
||||
total, or by row average if that is displayed.
|
||||
-% --percent express values in percentage of each column's
|
||||
total
|
||||
--invert display all amounts with reversed sign
|
||||
--transpose transpose rows and columns
|
||||
--layout=ARG how to lay out multi-commodity amounts and the
|
||||
overall table:
|
||||
'wide[,WIDTH]': commodities on one line
|
||||
'tall' : commodities on separate lines
|
||||
'bare' : commodity symbols in one column
|
||||
'tidy' : every attribute in its own column
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
balance is one of hledger's oldest and most versatile commands, for
|
||||
listing account balances, balance changes, values, value changes and
|
||||
|
||||
@ -5,7 +5,50 @@ balancesheet
|
||||
Show the end balances in asset and liability accounts. Amounts are shown
|
||||
with normal positive sign, as in conventional financial statements.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--sum show sum of posting amounts (default)
|
||||
--valuechange show total change of period-end historical
|
||||
balance value (caused by deposits, withdrawals,
|
||||
market price fluctuations)
|
||||
--gain show unrealised capital gain/loss (historical
|
||||
balance value minus cost basis)
|
||||
--budget show sum of posting amounts compared to budget
|
||||
goals defined by periodic transactions
|
||||
--change accumulate amounts from column start to column
|
||||
end (in multicolumn reports)
|
||||
--cumulative accumulate amounts from report start (specified
|
||||
by e.g. -b/--begin) to column end
|
||||
-H --historical accumulate amounts from journal start to column
|
||||
end (includes postings before report start date)
|
||||
(default)
|
||||
-l --flat show accounts as a flat list (default). Amounts
|
||||
exclude subaccount amounts, except where the
|
||||
account is depth-clipped.
|
||||
-t --tree show accounts as a tree. Amounts include
|
||||
subaccount amounts.
|
||||
--drop=N flat mode: omit N leading account name parts
|
||||
--declared include non-parent declared accounts (best used
|
||||
with -E)
|
||||
-A --average show a row average column (in multicolumn
|
||||
reports)
|
||||
-T --row-total show a row total column (in multicolumn reports)
|
||||
--summary-only display only row summaries (e.g. row total,
|
||||
average) (in multicolumn reports)
|
||||
-N --no-total omit the final total row
|
||||
--no-elide don't squash boring parent accounts (in tree
|
||||
mode)
|
||||
--format=FORMATSTR use this custom line format (in simple reports)
|
||||
-S --sort-amount sort by amount instead of account code/name
|
||||
-% --percent express values in percentage of each column's
|
||||
total
|
||||
--layout=ARG how to show multi-commodity amounts:
|
||||
'wide[,WIDTH]': all commodities on one line
|
||||
'tall' : each commodity on a new line
|
||||
'bare' : bare numbers, symbols in a column
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
This command displays a balance sheet, showing historical ending
|
||||
balances of asset and liability accounts. (To see equity as well, use
|
||||
|
||||
@ -6,7 +6,50 @@ This command displays a balance sheet, showing historical ending
|
||||
balances of asset, liability and equity accounts. Amounts are shown with
|
||||
normal positive sign, as in conventional financial statements.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--sum show sum of posting amounts (default)
|
||||
--valuechange show total change of period-end historical
|
||||
balance value (caused by deposits, withdrawals,
|
||||
market price fluctuations)
|
||||
--gain show unrealised capital gain/loss (historical
|
||||
balance value minus cost basis)
|
||||
--budget show sum of posting amounts compared to budget
|
||||
goals defined by periodic transactions
|
||||
--change accumulate amounts from column start to column
|
||||
end (in multicolumn reports)
|
||||
--cumulative accumulate amounts from report start (specified
|
||||
by e.g. -b/--begin) to column end
|
||||
-H --historical accumulate amounts from journal start to column
|
||||
end (includes postings before report start date)
|
||||
(default)
|
||||
-l --flat show accounts as a flat list (default). Amounts
|
||||
exclude subaccount amounts, except where the
|
||||
account is depth-clipped.
|
||||
-t --tree show accounts as a tree. Amounts include
|
||||
subaccount amounts.
|
||||
--drop=N flat mode: omit N leading account name parts
|
||||
--declared include non-parent declared accounts (best used
|
||||
with -E)
|
||||
-A --average show a row average column (in multicolumn
|
||||
reports)
|
||||
-T --row-total show a row total column (in multicolumn reports)
|
||||
--summary-only display only row summaries (e.g. row total,
|
||||
average) (in multicolumn reports)
|
||||
-N --no-total omit the final total row
|
||||
--no-elide don't squash boring parent accounts (in tree
|
||||
mode)
|
||||
--format=FORMATSTR use this custom line format (in simple reports)
|
||||
-S --sort-amount sort by amount instead of account code/name
|
||||
-% --percent express values in percentage of each column's
|
||||
total
|
||||
--layout=ARG how to show multi-commodity amounts:
|
||||
'wide[,WIDTH]': all commodities on one line
|
||||
'tall' : each commodity on a new line
|
||||
'bare' : bare numbers, symbols in a column
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
This report shows accounts declared with the Asset, Cash, Liability or
|
||||
Equity type (see account types). Or if no such accounts are declared, it
|
||||
|
||||
@ -7,7 +7,49 @@ and outflows affecting "cash" (ie, liquid, easily convertible) assets.
|
||||
Amounts are shown with normal positive sign, as in conventional
|
||||
financial statements.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--sum show sum of posting amounts (default)
|
||||
--valuechange show total change of period-end historical
|
||||
balance value (caused by deposits, withdrawals,
|
||||
market price fluctuations)
|
||||
--gain show unrealised capital gain/loss (historical
|
||||
balance value minus cost basis)
|
||||
--budget show sum of posting amounts compared to budget
|
||||
goals defined by periodic transactions
|
||||
--change accumulate amounts from column start to column
|
||||
end (in multicolumn reports) (default)
|
||||
--cumulative accumulate amounts from report start (specified
|
||||
by e.g. -b/--begin) to column end
|
||||
-H --historical accumulate amounts from journal start to column
|
||||
end (includes postings before report start date)
|
||||
-l --flat show accounts as a flat list (default). Amounts
|
||||
exclude subaccount amounts, except where the
|
||||
account is depth-clipped.
|
||||
-t --tree show accounts as a tree. Amounts include
|
||||
subaccount amounts.
|
||||
--drop=N flat mode: omit N leading account name parts
|
||||
--declared include non-parent declared accounts (best used
|
||||
with -E)
|
||||
-A --average show a row average column (in multicolumn
|
||||
reports)
|
||||
-T --row-total show a row total column (in multicolumn reports)
|
||||
--summary-only display only row summaries (e.g. row total,
|
||||
average) (in multicolumn reports)
|
||||
-N --no-total omit the final total row
|
||||
--no-elide don't squash boring parent accounts (in tree
|
||||
mode)
|
||||
--format=FORMATSTR use this custom line format (in simple reports)
|
||||
-S --sort-amount sort by amount instead of account code/name
|
||||
-% --percent express values in percentage of each column's
|
||||
total
|
||||
--layout=ARG how to show multi-commodity amounts:
|
||||
'wide[,WIDTH]': all commodities on one line
|
||||
'tall' : each commodity on a new line
|
||||
'bare' : bare numbers, symbols in a column
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
This report shows accounts declared with the Cash type (see account
|
||||
types). Or if no such accounts are declared, it shows accounts
|
||||
|
||||
@ -2,7 +2,8 @@ check
|
||||
|
||||
Check for various kinds of errors in your data.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
hledger provides a number of built-in correctness checks to help
|
||||
validate your data and prevent errors. Some are run automatically, some
|
||||
|
||||
@ -9,7 +9,35 @@ balances, or viewing lots. Like print, it prints valid journal entries.
|
||||
You can append or copy these to your journal file(s) when you are happy
|
||||
with how they look.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--migrate[=NEW] show closing and opening transactions, for Asset
|
||||
and Liability accounts by default, tagged for easy
|
||||
matching. The tag's default value can be overridden
|
||||
by providing NEW.
|
||||
--close[=NEW] (default) show a closing transaction
|
||||
--open[=NEW] show an opening transaction
|
||||
--assign[=NEW] show opening balance assignments
|
||||
--assert[=NEW] show closing balance assertions
|
||||
--retain[=NEW] show a retain earnings transaction, for Revenue
|
||||
and Expense accounts by default
|
||||
-x --explicit show all amounts explicitly
|
||||
--show-costs show amounts with different costs separately
|
||||
--interleaved show source and destination postings together
|
||||
--assertion-type=TYPE =, ==, =* or ==*
|
||||
--close-desc=DESC set closing transaction's description
|
||||
--close-acct=ACCT set closing transaction's destination account
|
||||
--open-desc=DESC set opening transaction's description
|
||||
--open-acct=ACCT set opening transaction's source account
|
||||
--round=TYPE how much rounding or padding should be done when
|
||||
displaying amounts ?
|
||||
none - show original decimal digits,
|
||||
as in journal
|
||||
soft - just add or remove decimal zeros
|
||||
to match precision (default)
|
||||
hard - round posting amounts to precision
|
||||
(can unbalance transactions)
|
||||
all - also round cost amounts to precision
|
||||
(can unbalance transactions)
|
||||
|
||||
close currently has six modes, selected by a single mode flag:
|
||||
|
||||
|
||||
@ -2,7 +2,8 @@ codes
|
||||
|
||||
List the codes seen in transactions, in the order parsed.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
This command prints the value of each transaction's code field, in the
|
||||
order transactions were parsed. The transaction code is an optional
|
||||
|
||||
@ -2,4 +2,5 @@ commodities
|
||||
|
||||
List all commodity/currency symbols used or declared in the journal.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
@ -2,7 +2,9 @@ demo
|
||||
|
||||
Play demos of hledger usage in the terminal, if asciinema is installed.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
-s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 is
|
||||
double, etc (default: 2))
|
||||
|
||||
Run this command with no argument to list the demos. To play a demo,
|
||||
write its number or a prefix or substring of its title. Tips:
|
||||
|
||||
@ -2,7 +2,8 @@ descriptions
|
||||
|
||||
List the unique descriptions that appear in transactions.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
This command lists the unique descriptions that appear in transactions,
|
||||
in alphabetic order. You can add a query to select a subset of
|
||||
|
||||
@ -4,18 +4,22 @@ Compares a particular account's transactions in two input files. It
|
||||
shows any transactions to this account which are in one file but not in
|
||||
the other.
|
||||
|
||||
More precisely, for each posting affecting this account in either file,
|
||||
it looks for a corresponding posting in the other file which posts the
|
||||
same amount to the same account (ignoring date, description, etc.) Since
|
||||
postings not transactions are compared, this also works when multiple
|
||||
bank transactions have been combined into a single journal entry.
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
This is useful eg if you have downloaded an account's transactions from
|
||||
your bank (eg as CSV data). When hledger and your bank disagree about
|
||||
the account balance, you can compare the bank data with your journal to
|
||||
find out the cause.
|
||||
More precisely: for each posting affecting this account in either file,
|
||||
this command looks for a corresponding posting in the other file which
|
||||
posts the same amount to the same account (ignoring date, description,
|
||||
etc).
|
||||
|
||||
_FLAGS
|
||||
Since it compares postings, not transactions, this also works when
|
||||
multiple bank transactions have been combined into a single journal
|
||||
entry.
|
||||
|
||||
This command is useful eg if you have downloaded an account's
|
||||
transactions from your bank (eg as CSV data): when hledger and your bank
|
||||
disagree about the account balance, you can compare the bank data with
|
||||
your journal to find out the cause.
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
@ -3,4 +3,5 @@ files
|
||||
List all files included in the journal. With a REGEX argument, only file
|
||||
names matching the regular expression (case sensitive) are shown.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
@ -3,7 +3,11 @@ help
|
||||
Show the hledger user manual with info, man, or a pager. With a (case
|
||||
insensitive) TOPIC argument, try to open it at that section heading.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
-i show the manual with info
|
||||
-m show the manual with man
|
||||
-p show the manual with $PAGER or less
|
||||
(less is always used if TOPIC is specified)
|
||||
|
||||
This command shows the hledger manual built in to your hledger
|
||||
executable. It can be useful when offline, or when you prefer the
|
||||
|
||||
@ -2,7 +2,9 @@ import
|
||||
|
||||
Import new transactions from one or more data files to the main journal.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--catchup just mark all transactions as already imported
|
||||
--dry-run just show the transactions to be imported
|
||||
|
||||
This command detects new transactions in each FILE argument since it was
|
||||
last run, and appends them to the main journal.
|
||||
|
||||
@ -6,7 +6,49 @@ Show revenue inflows and expense outflows during the report period.
|
||||
Amounts are shown with normal positive sign, as in conventional
|
||||
financial statements.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--sum show sum of posting amounts (default)
|
||||
--valuechange show total change of period-end historical
|
||||
balance value (caused by deposits, withdrawals,
|
||||
market price fluctuations)
|
||||
--gain show unrealised capital gain/loss (historical
|
||||
balance value minus cost basis)
|
||||
--budget show sum of posting amounts compared to budget
|
||||
goals defined by periodic transactions
|
||||
--change accumulate amounts from column start to column
|
||||
end (in multicolumn reports) (default)
|
||||
--cumulative accumulate amounts from report start (specified
|
||||
by e.g. -b/--begin) to column end
|
||||
-H --historical accumulate amounts from journal start to column
|
||||
end (includes postings before report start date)
|
||||
-l --flat show accounts as a flat list (default). Amounts
|
||||
exclude subaccount amounts, except where the
|
||||
account is depth-clipped.
|
||||
-t --tree show accounts as a tree. Amounts include
|
||||
subaccount amounts.
|
||||
--drop=N flat mode: omit N leading account name parts
|
||||
--declared include non-parent declared accounts (best used
|
||||
with -E)
|
||||
-A --average show a row average column (in multicolumn
|
||||
reports)
|
||||
-T --row-total show a row total column (in multicolumn reports)
|
||||
--summary-only display only row summaries (e.g. row total,
|
||||
average) (in multicolumn reports)
|
||||
-N --no-total omit the final total row
|
||||
--no-elide don't squash boring parent accounts (in tree
|
||||
mode)
|
||||
--format=FORMATSTR use this custom line format (in simple reports)
|
||||
-S --sort-amount sort by amount instead of account code/name
|
||||
-% --percent express values in percentage of each column's
|
||||
total
|
||||
--layout=ARG how to show multi-commodity amounts:
|
||||
'wide[,WIDTH]': all commodities on one line
|
||||
'tall' : each commodity on a new line
|
||||
'bare' : bare numbers, symbols in a column
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, html, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
This command displays an income statement, showing revenues and expenses
|
||||
during one or more periods.
|
||||
|
||||
@ -2,7 +2,8 @@ notes
|
||||
|
||||
List the unique notes that appear in transactions.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
This command lists the unique notes that appear in transactions, in
|
||||
alphabetic order. You can add a query to select a subset of
|
||||
|
||||
@ -2,7 +2,9 @@ payees
|
||||
|
||||
List the unique payee/payer names that appear in transactions.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--declared show payees declared with payee directives
|
||||
--used show payees referenced by transactions
|
||||
|
||||
This command lists unique payee/payer names which have been declared
|
||||
with payee directives (--declared), used in transaction descriptions
|
||||
|
||||
@ -5,6 +5,10 @@ Print the market prices declared with P directives. With
|
||||
costs. With --show-reverse, also show additional prices inferred by
|
||||
reversing known prices.
|
||||
|
||||
Flags:
|
||||
--show-reverse also show the prices inferred by reversing known
|
||||
prices
|
||||
|
||||
Price amounts are always displayed with their full precision, except for
|
||||
reverse prices which are limited to 8 decimal digits.
|
||||
|
||||
@ -14,5 +18,3 @@ Generally if you run this command with --infer-market-prices
|
||||
--show-reverse, it will show the same prices used internally to
|
||||
calculate value reports. But if in doubt, you can inspect those directly
|
||||
by running the value report with --debug=2.
|
||||
|
||||
_FLAGS
|
||||
|
||||
@ -2,7 +2,28 @@ print
|
||||
|
||||
Show full journal entries, representing transactions.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
-x --explicit show all amounts explicitly
|
||||
--show-costs show transaction prices even with conversion
|
||||
postings
|
||||
--round=TYPE how much rounding or padding should be done when
|
||||
displaying amounts ?
|
||||
none - show original decimal digits,
|
||||
as in journal
|
||||
soft - just add or remove decimal zeros
|
||||
to match precision (default)
|
||||
hard - round posting amounts to precision
|
||||
(can unbalance transactions)
|
||||
all - also round cost amounts to precision
|
||||
(can unbalance transactions)
|
||||
--new show only newer-dated transactions added in each
|
||||
file since last run
|
||||
-m --match=DESC fuzzy search for one recent transaction with
|
||||
description closest to DESC
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, beancount, csv, tsv, json, sql.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
The print command displays full journal entries (transactions) from the
|
||||
journal file, sorted by date (or with --date2, by secondary date).
|
||||
|
||||
@ -4,7 +4,24 @@ register
|
||||
|
||||
Show postings and their running total.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--cumulative show running total from report start date
|
||||
(default)
|
||||
-H --historical show historical running total/balance (includes
|
||||
postings before report start date)
|
||||
-A --average show running average of posting amounts instead
|
||||
of total (implies --empty)
|
||||
-m --match=DESC fuzzy search for one recent posting with
|
||||
description closest to DESC
|
||||
-r --related show postings' siblings instead
|
||||
--invert display all amounts with reversed sign
|
||||
-w --width=N set output width (default: terminal width or
|
||||
$COLUMNS). -wN,M sets description width as well.
|
||||
--align-all guarantee alignment across all lines (slower)
|
||||
-O --output-format=FMT select the output format. Supported formats:
|
||||
txt, csv, tsv, json.
|
||||
-o --output-file=FILE write output to FILE. A file extension matching
|
||||
one of the above formats selects that format.
|
||||
|
||||
The register command displays matched postings, across all accounts, in
|
||||
date order, with their running total or running historical balance. (See
|
||||
|
||||
@ -4,7 +4,15 @@ Print all transactions, rewriting the postings of matched transactions.
|
||||
For now the only rewrite available is adding new postings, like print
|
||||
--auto.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--add-posting='ACCT AMTEXPR' add a posting to ACCT, which may be
|
||||
parenthesised. AMTEXPR is either a literal
|
||||
amount, or *N which means the transaction's
|
||||
first matched amount multiplied by N (a
|
||||
decimal number). Two spaces separate ACCT
|
||||
and AMTEXPR.
|
||||
--diff generate diff suitable as an input for
|
||||
patch tool
|
||||
|
||||
This is a start at a generic rewriter of transaction entries. It reads
|
||||
the default journal and prints the transactions, like print, but adds
|
||||
|
||||
@ -3,7 +3,12 @@ roi
|
||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||
your investments.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--cashflow show all amounts that were used to compute
|
||||
returns
|
||||
--investment=QUERY query to select your investment transactions
|
||||
--profit-loss=QUERY --pnl query to select profit-and-loss or
|
||||
appreciation/valuation transactions
|
||||
|
||||
At a minimum, you need to supply a query (which could be just an account
|
||||
name) to select your investment(s) with --inv, and another query to
|
||||
|
||||
@ -2,7 +2,9 @@ stats
|
||||
|
||||
Show journal and performance statistics.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
-v --verbose show more detailed output
|
||||
-o --output-file=FILE write output to FILE.
|
||||
|
||||
The stats command shows summary information for the whole journal, or a
|
||||
matched part of it. With a reporting interval, it shows a report for
|
||||
|
||||
@ -2,7 +2,10 @@ tags
|
||||
|
||||
List the tags used in the journal, or their values.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
--values list tag values instead of tag names
|
||||
--parsed show tags/values in the order they were parsed,
|
||||
including duplicates
|
||||
|
||||
This command lists the tag names used in the journal, whether on
|
||||
transactions, postings, or account declarations.
|
||||
|
||||
@ -2,7 +2,8 @@ test
|
||||
|
||||
Run built-in unit tests.
|
||||
|
||||
_FLAGS
|
||||
Flags:
|
||||
no command-specific flags
|
||||
|
||||
This command runs the unit tests built in to hledger and hledger-lib,
|
||||
printing the results on stdout. If any test fails, the exit code will be
|
||||
|
||||
Loading…
Reference in New Issue
Block a user