Skip to content

Commit

Permalink
hledger-ui, hledger-web: add page; hledger: update page (#12824)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed May 24, 2024
1 parent 0b2f277 commit 8d02370
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 9 deletions.
33 changes: 33 additions & 0 deletions pages/common/hledger-ui.md
Original file line number Diff line number Diff line change
@@ -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`
33 changes: 33 additions & 0 deletions pages/common/hledger-web.md
Original file line number Diff line number Diff line change
@@ -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`
35 changes: 26 additions & 9 deletions pages/common/hledger.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 8d02370

Please sign in to comment.