Skip to content

Commit

Permalink
hledger-ui, hledger-web: add page; hledger: update page
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed May 23, 2024
1 parent eaff8ea commit 4d7aa38
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 8 deletions.
32 changes: 32 additions & 0 deletions pages/common/hledger-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# hledger-ui

> A robust, friendly plain text accounting app (the terminal UI).
> More information: <https://hledger.org>.
- Start in the main menu screen, reading from the default journal file:

`hledger-ui`

- Start with a different color theme:

`hledger-ui --theme dark`

- Start in the balance sheet accounts screen, showing hierarchy, to level 3:

`hledger-ui --bs --tree --depth 3`

- Start in this account's screen, showing cleared txns, 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 2024.journal --file 2024-prices.journal --value now`

- Show command-line help:

`hledger-ui --help`

- Show the manual in Info format if possible:

`hledger-ui --info`
32 changes: 32 additions & 0 deletions pages/common/hledger-web.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# hledger-web

> A robust, friendly plain text accounting app (the web UI & API).
> More information: <https://hledger.org>.
- Start the web app, and a browser if possible, for local viewing and adding:

`hledger-web`

- As above but with a specified file, and allowing editing of existing data:

`hledger-web --file {{path/to/file.journal}} --allow edit`

- Start the web app only, allowing incoming connections to this host & port:

`hledger-web --serve --host {{my.host.name}} --port 8000`

- Start the web app's JSON API only, allowing read access only:

`hledger-web --serve-api --host {{my.host.name}} --allow view`

- Show amounts converted to current market value, when possible:

`hledger-web --value now --infer-market-prices`

- Show command-line help:

`hledger-web --help`

- Show the manual in Info format if possible:

`hledger-web --info`
32 changes: 24 additions & 8 deletions pages/common/hledger.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,36 @@
# hledger

> A plain text accounting software for the command-line.
> A robust, friendly plain text accounting app (the command-line interface).
> More information: <https://hledger.org>.
- 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 {{bank.csv}}`

- Show a monthly income statement:
- Print all transactions, reading from multiple specified journal files:

`hledger incomestatement --monthly --depth 2`
`hledger print --file {{2024.journal}} --file {{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 4d7aa38

Please sign in to comment.