From 8d023703b6a09c511b150188d677d4491015c683 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Thu, 23 May 2024 16:49:48 -1000
Subject: [PATCH] hledger-ui, hledger-web: add page; hledger: update page
 (#12824)

---
 pages/common/hledger-ui.md  | 33 +++++++++++++++++++++++++++++++++
 pages/common/hledger-web.md | 33 +++++++++++++++++++++++++++++++++
 pages/common/hledger.md     | 35 ++++++++++++++++++++++++++---------
 3 files changed, 92 insertions(+), 9 deletions(-)
 create mode 100644 pages/common/hledger-ui.md
 create mode 100644 pages/common/hledger-web.md

diff --git a/pages/common/hledger-ui.md b/pages/common/hledger-ui.md
new file mode 100644
index 0000000000..bd2a7f5ae1
--- /dev/null
+++ b/pages/common/hledger-ui.md
@@ -0,0 +1,33 @@
+# hledger-ui
+
+> Terminal UI (TUI) to `hledger`.
+> A robust, friendly plain text accounting app.
+> More information: <https://hledger.org/hledger-ui.html>.
+
+- Start in the main menu screen, reading from the default journal file:
+
+`hledger-ui`
+
+- Start with a different color theme:
+
+`hledger-ui --theme {{terminal|greenterm|dark}}`
+
+- Start in the balance sheet accounts screen, showing hierarchy down to level 3:
+
+`hledger-ui --bs --tree --depth 3`
+
+- Start in this account's screen, showing cleared transactions, and reload on change:
+
+`hledger-ui --register {{assets:bank:checking}} --cleared --watch`
+
+- Read two journal files, and show amounts as current value when known:
+
+`hledger-ui --file {{path/to/2024.journal}} --file {{path/to/2024-prices.journal}} --value now`
+
+- Show the manual in Info format, if possible:
+
+`hledger-ui --info`
+
+- Display help:
+
+`hledger-ui --help`
diff --git a/pages/common/hledger-web.md b/pages/common/hledger-web.md
new file mode 100644
index 0000000000..76f1c10639
--- /dev/null
+++ b/pages/common/hledger-web.md
@@ -0,0 +1,33 @@
+# hledger-web
+
+> Web interface and API to `hledger`.
+> A robust, friendly plain text accounting app.
+> More information: <https://hledger.org/hledger-web.html>.
+
+- Start the web app, and a browser if possible, for local viewing and adding only:
+
+`hledger-web`
+
+- As above but with a specified file, and allow editing of existing data:
+
+`hledger-web --file {{path/to/file.journal}} --allow edit`
+
+- Start just the web app, and accept incoming connections to the specified host and port:
+
+`hledger-web --serve --host {{my.host.name}} --port 8000`
+
+- Start just the web app's JSON API, and allow only read access:
+
+`hledger-web --serve-api --host {{my.host.name}} --allow view`
+
+- Show amounts converted to current market value in your base currency when known:
+
+`hledger-web --value now --infer-market-prices`
+
+- Show the manual in Info format if possible:
+
+`hledger-web --info`
+
+- Display help:
+
+`hledger-web --help`
diff --git a/pages/common/hledger.md b/pages/common/hledger.md
index 3e678374ed..585c84f19b 100644
--- a/pages/common/hledger.md
+++ b/pages/common/hledger.md
@@ -1,20 +1,37 @@
 # hledger
 
-> A plain text accounting software for the command-line.
-> More information: <https://hledger.org>.
+> A robust, friendly plain text accounting app.
+> See also: `hledger-ui` for TUI, `hledger-web` for web interface.
+> More information: <https://hledger.org/hledger.html>.
 
-- Add transactions to your journal interactively:
+- Record new transactions interactively, saving to the default journal file:
 
 `hledger add`
 
-- Show the account hierarchy, using a specific journal file:
+- Import new transactions from `bank.csv`, using `bank.csv.rules` to convert:
 
-`hledger --file {{path/to/file.journal}} accounts --tree`
+`hledger import {{path/to/bank.csv}}`
 
-- Show a monthly income statement:
+- Print all transactions, reading from multiple specified journal files:
 
-`hledger incomestatement --monthly --depth 2`
+`hledger print --file {{path/to/prices-2024.journal}} --file {{path/to/prices-2023.journal}}`
 
-- Print the amount of cash spent on food:
+- Show all accounts, as a hierarchy, and their types:
 
-`hledger print assets:cash | hledger -f- -I balance expenses:food --depth 2`
+`hledger accounts --tree --types`
+
+- Show asset and liability account balances, including zeros, hierarchically:
+
+`hledger balancesheet --empty --tree --no-elide`
+
+- Show monthly incomes/expenses/totals, largest first, summarised to 2 levels:
+
+`hledger incomestatement --monthly --row-total --average --sort --depth 2`
+
+- Show the `assets:bank:checking` account's transactions and running balance:
+
+`hledger aregister assets:bank:checking`
+
+- Show the amount spent on food from the `assets:cash` account:
+
+`hledger print assets:cash | hledger -f- -I aregister expenses:food`