From 8abd5ee6fc5d565d54798b29d81302ee23333fc4 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 24 May 2024 08:57:36 -1000 Subject: [PATCH] hledger-*: add pages for seven hledger subcommands (#12828) Co-authored-by: K.B.Dharun Krishna Co-authored-by: Juri Dispan Co-authored-by: spageektti --- pages/common/hledger-accounts.md | 36 +++++++++++++++++++++++++ pages/common/hledger-add.md | 24 +++++++++++++++++ pages/common/hledger-aregister.md | 20 ++++++++++++++ pages/common/hledger-balancesheet.md | 32 ++++++++++++++++++++++ pages/common/hledger-import.md | 28 +++++++++++++++++++ pages/common/hledger-incomestatement.md | 20 ++++++++++++++ pages/common/hledger-print.md | 32 ++++++++++++++++++++++ 7 files changed, 192 insertions(+) create mode 100644 pages/common/hledger-accounts.md create mode 100644 pages/common/hledger-add.md create mode 100644 pages/common/hledger-aregister.md create mode 100644 pages/common/hledger-balancesheet.md create mode 100644 pages/common/hledger-import.md create mode 100644 pages/common/hledger-incomestatement.md create mode 100644 pages/common/hledger-print.md diff --git a/pages/common/hledger-accounts.md b/pages/common/hledger-accounts.md new file mode 100644 index 000000000..10daac16b --- /dev/null +++ b/pages/common/hledger-accounts.md @@ -0,0 +1,36 @@ +# hledger accounts + +> List account names. +> More information: . + +- Show all accounts used or declared in the default journal file: + +`hledger accounts` + +- Show accounts used by transactions: + +`hledger accounts --used` + +- Show accounts declared with account directives: + +`hledger accounts --declared` + +- Add new account directives, for accounts used but not declared, to the journal: + +`hledger accounts --undeclared --directives >> {{2024-accounts.journal}}` + +- Show accounts with `asset` in their name, and their declared/inferred types: + +`hledger accounts asset --types` + +- Show accounts of the Asset type: + +`hledger accounts type:a` + +- Show the first two levels of the accounts hierarchy: + +`hledger accounts --tree --depth 2` + +- Short form of the above: + +`hledger acc -t -2` diff --git a/pages/common/hledger-add.md b/pages/common/hledger-add.md new file mode 100644 index 000000000..8e61e09c6 --- /dev/null +++ b/pages/common/hledger-add.md @@ -0,0 +1,24 @@ +# hledger add + +> Record new transactions with interactive prompting in the console. +> More information: . + +- Record new transactions, saving to the default journal file: + +`hledger add` + +- Add transactions to `2024.journal`, but also load `2023.journal` for completions: + +`hledger add --file {{path/to/2024.journal}} --file {{path/to/2023.journal}}` + +- Provide answers for the first four prompts: + +`hledger add {{today}} '{{best buy}}' {{expenses:supplies}} '{{$20}}'` + +- Show `add`'s options and documentation with `$PAGER`: + +`hledger add --help` + +- Show `add`'s documentation with `info` or `man` if available: + +`hledger help add` diff --git a/pages/common/hledger-aregister.md b/pages/common/hledger-aregister.md new file mode 100644 index 000000000..80a97975f --- /dev/null +++ b/pages/common/hledger-aregister.md @@ -0,0 +1,20 @@ +# hledger aregister + +> Show the transactions and running balances in one account. +> More information: . + +- Show transactions and running balance in the `assets:bank:checking` account: + +`hledger aregister assets:bank:checking` + +- Show transactions and running balance in the first account named `*savings*`: + +`hledger aregister savings` + +- Show the checking account's cleared transactions, with a specified width: + +`hledger aregister checking --cleared --width {{120}}` + +- Show the checking register, including transactions from forecast rules: + +`hledger aregister checking --forecast` diff --git a/pages/common/hledger-balancesheet.md b/pages/common/hledger-balancesheet.md new file mode 100644 index 000000000..2ac871752 --- /dev/null +++ b/pages/common/hledger-balancesheet.md @@ -0,0 +1,32 @@ +# hledger balancesheet + +> Show the end balances in asset and liability accounts. +> More information: . + +- Show the current balances in Asset and Liability accounts, excluding zeros: + +`hledger balancesheet` + +- Show just the liquid assets (Cash account type): + +`hledger balancesheet type:c` + +- Include accounts with zero balances, and show the account hierarchy: + +`hledger balancesheet --empty --tree` + +- Show the balances at the end of each month: + +`hledger balancesheet --monthly` + +- Show the balances' market value in home currency at the end of each month: + +`hledger balancesheet --monthly -V` + +- Show quarterly balances, with just the top two levels of account hierarchy: + +`hledger balancesheet --quarterly --tree --depth 2` + +- Short form of the above, and generate HTML output in `bs.html`: + +`hledger bs -Qt -2 -o bs.html` diff --git a/pages/common/hledger-import.md b/pages/common/hledger-import.md new file mode 100644 index 000000000..d1d7a82ce --- /dev/null +++ b/pages/common/hledger-import.md @@ -0,0 +1,28 @@ +# hledger import + +> Import new transactions from one or more data files to the main journal. +> More information: . + +- Import new transactions from `bank.csv`, using `bank.csv.rules` to convert: + +`hledger import {{path/to/bank.csv}}` + +- Show what would be imported from these two files, without doing anything: + +`hledger import {{path/to/bank1.csv}} {{path/to/bank2.csv}} --dry-run` + +- Import new transactions from all CSV files, using the same rules for all: + +`hledger import --rules-file {{common.rules}} *.csv` + +- Show conversion errors or results while editing `bank.csv.rules`: + +`watchexec -- hledger -f {{path/to/bank.csv}} print` + +- Mark `bank.csv`'s current data as seen, as if already imported: + +`hledger import --catchup {{path/to/bank.csv}}` + +- Mark `bank.csv` as all new, as if not yet imported: + +`rm -f .latest.bank.csv` diff --git a/pages/common/hledger-incomestatement.md b/pages/common/hledger-incomestatement.md new file mode 100644 index 000000000..ba7143f2b --- /dev/null +++ b/pages/common/hledger-incomestatement.md @@ -0,0 +1,20 @@ +# hledger incomestatement + +> Show revenue inflows and expense outflows during the report period. +> More information: . + +- Show revenues and expenses (changes in Revenue and Expense accounts): + +`hledger incomestatement` + +- Show revenues and expenses each month: + +`hledger incomestatement --monthly` + +- Show monthly revenues/expenses/totals, largest first, summarised to 2 levels: + +`hledger incomestatement --monthly --row-total --average --sort --depth 2` + +- Short form of the above, and generate HTML output in `is.html`: + +`hledger is -MTAS -2 -o is.html` diff --git a/pages/common/hledger-print.md b/pages/common/hledger-print.md new file mode 100644 index 000000000..af3f0e5b8 --- /dev/null +++ b/pages/common/hledger-print.md @@ -0,0 +1,32 @@ +# hledger print + +> Show full journal entries, representing transactions. +> More information: . + +- Show all transactions in the default journal file: + +`hledger print` + +- Show transactions, with any implied amounts or costs made explicit: + +`hledger print --explicit --infer-costs` + +- Show transactions from two specified files, with amounts converted to cost: + +`hledger print --file {{path/to/2023.journal}} --file {{path/to/2024.journal}} --cost` + +- Show `$` transactions in `*food*` but not `*groceries*` accounts this month: + +`hledger print cur:\\$ food not:groceries date:thismonth` + +- Show transactions of amount 50 or more, with `whole foods` in their description: + +`hledger print amt:'>50' desc:'whole foods'` + +- Show cleared transactions, with `EUR` amounts rounded and with decimal commas: + +`hledger print --cleared --commodity '1000, EUR' --round hard` + +- Write transactions from `foo.journal` as a CSV file: + +`hledger print --file {{path/to/foo.journal}} --output-file {{path/to/output_file.csv}}`