;doc: update command help

This commit is contained in:
Simon Michael 2024-05-29 17:02:03 -10:00
parent d47513c669
commit 77ee3fd846
8 changed files with 44 additions and 36 deletions

View File

@ -1,6 +1,6 @@
accounts accounts
Show account names. List account names.
_FLAGS _FLAGS

View File

@ -1,7 +1,6 @@
add add
Prompt for transactions and add them to the journal. Any arguments will Record new transactions with interactive prompting in the console.
be used as default inputs for the first N prompts.
_FLAGS _FLAGS

View File

@ -2,8 +2,8 @@ aregister
(areg) (areg)
Show the transactions and running historical balance of a single Show the transactions and running balances in one account, with each
account, with each transaction displayed as one line. transaction on one line.
_FLAGS _FLAGS

View File

@ -2,7 +2,9 @@ balance
(bal) (bal)
Show accounts and their balances. 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

View File

@ -2,17 +2,19 @@ balancesheet
(bs) (bs)
This command displays a balance sheet, showing historical ending Show the end balances in asset and liability accounts. Amounts are shown
balances of asset and liability accounts. (To see equity as well, use with normal positive sign, as in conventional financial statements.
the balancesheetequity command.) Amounts are shown with normal positive
sign, as in conventional financial statements.
_FLAGS _FLAGS
This report shows accounts declared with the Asset, Cash or Liability This command displays a balance sheet, showing historical ending
type (see account types). Or if no such accounts are declared, it shows balances of asset and liability accounts. (To see equity as well, use
top-level accounts named asset or liability (case insensitive, plurals the balancesheetequity command.)
allowed) and their subaccounts.
Accounts declared with the Asset, Cash or Liability type are shown (see
account types). Or if no such accounts are declared, it shows top-level
accounts named asset or liability (case insensitive, plurals allowed)
and their subaccounts.
Example: Example:

View File

@ -1,25 +1,27 @@
import import
Read new transactions added to each FILE provided as arguments since Import new transactions from one or more data files to the main journal.
last run, and add them to the journal. Or with --dry-run, just print the
transactions that would be added. Or with --catchup, just mark all of
the FILEs' current transactions as imported, without importing them.
_FLAGS _FLAGS
This command may append new transactions to the main journal file (which This command detects new transactions in each FILE argument since it was
should be in journal format). Existing transactions are not changed. last run, and appends them to the main journal.
This is one of the few hledger commands that writes to the journal file
(see also add).
Unlike other hledger commands, with import the journal file is an output Or with --dry-run, it just print the transactions that would be added.
file, and will be modified, though only by appending (existing data will
not be changed). The input files are specified as arguments, so to Or with --catchup, it just marks all of the FILEs' current transactions
import one or more CSV files to your main journal, you will run as already imported.
hledger import bank.csv or perhaps hledger import *.csv.
This is one of the few hledger commands that writes to the journal file
(see also add). It only appends; existing data will not be changed.
The input files are specified as arguments, so to import one or more CSV
files to your main journal, you will run hledger import bank.csv or
perhaps hledger import *.csv.
Note you can import from any file format, though CSV files are the most Note you can import from any file format, though CSV files are the most
common import source, and these docs focus on that case. common import source, and these docs focus on that case. The target file
(main journal) should be in journal format.
Date skipping Date skipping

View File

@ -2,16 +2,19 @@ incomestatement
(is) (is)
This command displays an income statement, showing revenues and expenses Show revenue inflows and expense outflows during the report period.
during one or more periods. Amounts are shown with normal positive sign, Amounts are shown with normal positive sign, as in conventional
as in conventional financial statements. financial statements.
_FLAGS _FLAGS
This report shows accounts declared with the Revenue or Expense type This command displays an income statement, showing revenues and expenses
(see account types). Or if no such accounts are declared, it shows during one or more periods.
top-level accounts named revenue or income or expense (case insensitive,
plurals allowed) and their subaccounts. It shows accounts declared with the Revenue or Expense type (see account
types). Or if no such accounts are declared, it shows top-level accounts
named revenue or income or expense (case insensitive, plurals allowed)
and their subaccounts.
Example: Example:

View File

@ -1,6 +1,6 @@
print print
Show transaction journal entries, sorted by date. Show full journal entries, representing transactions.
_FLAGS _FLAGS