simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-18 17:57:11 +03:00
Code Issues Projects Releases Wiki Activity

;doc: update command help

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger/Hledger/Cli/Commands/Accounts.txt
View File

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

3
hledger/Hledger/Cli/Commands/Add.txt
View File

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

4
hledger/Hledger/Cli/Commands/Aregister.txt
View File

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

4
hledger/Hledger/Cli/Commands/Balance.txt
View File

@ -2,7 +2,9 @@ balance
(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

18
hledger/Hledger/Cli/Commands/Balancesheet.txt
View File

@ -2,17 +2,19 @@ balancesheet
(bs)
This command displays a balance sheet, showing historical ending
balances of asset and liability accounts. (To see equity as well, use
the balancesheetequity command.) Amounts are shown with normal positive
sign, as in conventional financial statements.
Show the end balances in asset and liability accounts. Amounts are shown
with normal positive sign, as in conventional financial statements.
_FLAGS
This report shows accounts declared with the Asset, Cash or Liability
type (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.
This command displays a balance sheet, showing historical ending
balances of asset and liability accounts. (To see equity as well, use
the balancesheetequity command.)
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:

30
hledger/Hledger/Cli/Commands/Import.txt
View File

@ -1,25 +1,27 @@
import
Read new transactions added to each FILE provided as arguments since
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.
Import new transactions from one or more data files to the main journal.
_FLAGS
This command may append new transactions to the main journal file (which
should be in journal format). Existing transactions are not changed.
This is one of the few hledger commands that writes to the journal file
(see also add).
This command detects new transactions in each FILE argument since it was
last run, and appends them to the main journal.
Unlike other hledger commands, with import the journal file is an output
file, and will be modified, though only by appending (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.
Or with --dry-run, it just print the transactions that would be added.
Or with --catchup, it just marks all of the FILEs' current transactions
as already imported.
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
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

17
hledger/Hledger/Cli/Commands/Incomestatement.txt
View File

@ -2,16 +2,19 @@ incomestatement
(is)
This command displays an income statement, showing revenues and expenses
during one or more periods. Amounts are shown with normal positive sign,
as in conventional financial statements.
Show revenue inflows and expense outflows during the report period.
Amounts are shown with normal positive sign, as in conventional
financial statements.
_FLAGS
This report 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.
This command displays an income statement, showing revenues and expenses
during one or more periods.
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:

2
hledger/Hledger/Cli/Commands/Print.txt
View File

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