hledger/hledger/Hledger/Cli/Commands/Accounts.txt
2024-06-07 07:05:52 -07:00

68 lines
2.6 KiB
Plaintext

accounts
List account names.
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
directives.
With query arguments, only matched account names and account names
referenced by matched postings are shown.
Or it can show just the used accounts (--used/-u), the declared accounts
(--declared/-d), the accounts declared but not used (--unused), the
accounts used but not declared (--undeclared), or the first account
matched by an account name pattern, if any (--find).
It shows a flat list by default. With --tree, it uses indentation to
show the account hierarchy. In flat mode you can add --drop N to omit
the first few account name components. Account names can be
depth-clipped with depth:N or --depth N or -N.
With --types, it also shows each account's type, if it's known. (See
Declaring accounts > Account types.)
With --positions, it also shows the file and line number of each
account's declaration, if any, and the account's overall declaration
order; these may be useful when troubleshooting account display order.
With --directives, it adds the account keyword, showing valid account
directives which can be pasted into a journal file. This is useful
together with --undeclared when updating your account declarations to
satisfy hledger check accounts.
The --find flag can be used to look up a single account name, in the
same way that the aregister command does. It returns the
alphanumerically-first matched account name, or if none can be found, it
fails with a non-zero exit code.
Examples:
$ hledger accounts
assets:bank:checking
assets:bank:saving
assets:cash
expenses:food
expenses:supplies
income:gifts
income:salary
liabilities:debts
$ hledger accounts --undeclared --directives >> $LEDGER_FILE
$ hledger check accounts