| 1 |
setup |
| 2 |
|
| 3 |
Check the status of the hledger installation. |
| 4 |
|
| 5 |
Flags: |
| 6 |
no command-specific flags |
| 7 |
|
| 8 |
setup tests your hledger installation and prints a list of results, |
| 9 |
sometimes with helpful hints. This is a good first command to run after |
| 10 |
installing hledger. Also after upgrading, or when something's not |
| 11 |
working, or just when you want a reminder of where things are. |
| 12 |
|
| 13 |
It makes one network request to detect the latest hledger release |
| 14 |
version. It's ok if this fails or times out. It will use ANSI color by |
| 15 |
default, unless disabled by NO_COLOR or --color=n. It does not use a |
| 16 |
pager or a config file. |
| 17 |
|
| 18 |
It expects that the hledger version you are running is installed in your |
| 19 |
PATH. If not, it will stop until you have done that (to keep things |
| 20 |
simple). |
| 21 |
|
| 22 |
Example: |
| 23 |
|
| 24 |
$ hledger setup |
| 25 |
Checking your hledger setup.. |
| 26 |
Legend: good, neutral, unknown, warning |
| 27 |
|
| 28 |
hledger |
| 29 |
* is a released version ? no hledger 1.42.99-gbca4b39c5-20250425, mac-aarch64 |
| 30 |
* is up to date ? yes 1.42.99 installed, latest is 1.42.1 |
| 31 |
* is a native binary for this machine ? yes aarch64 |
| 32 |
* is installed in PATH ? yes /Users/simon/.local/bin/hledger |
| 33 |
* has a system text encoding configured ? yes UTF-8, data files should use this encoding |
| 34 |
* has a user config file ? (optional) no |
| 35 |
* current directory has a local config ? yes /Users/simon/src/hledger/hledger.conf |
| 36 |
* the config file is readable ? yes /Users/simon/src/hledger/hledger.conf |
| 37 |
|
| 38 |
terminal |
| 39 |
* the NO_COLOR variable is defined ? no |
| 40 |
* --color is configured by config file ? no |
| 41 |
* hledger will use color by default ? yes |
| 42 |
* the PAGER variable is defined ? yes less |
| 43 |
* --pager is configured by config file ? no |
| 44 |
* hledger will use a pager when needed ? yes /opt/homebrew/bin/less |
| 45 |
* the LESS variable is defined ? yes |
| 46 |
* the HLEDGER_LESS variable is defined ? no |
| 47 |
* adjusting LESS variable for color etc. ? yes |
| 48 |
* --pretty is enabled by config file ? no tables will use ASCII characters |
| 49 |
* bash shell completions are installed ? ? |
| 50 |
* zsh shell completions are installed ? ? |
| 51 |
|
| 52 |
journal |
| 53 |
* the LEDGER_FILE variable is defined ? yes /Users/simon/finance/2025/2025.journal |
| 54 |
* a default journal file is readable ? yes /Users/simon/finance/2025/2025.journal |
| 55 |
* it includes additional files ? yes 15 |
| 56 |
* all commodities are declared ? yes 10 |
| 57 |
* all accounts are declared ? yes 160 |
| 58 |
* all accounts have types ? no 14 untyped |
| 59 |
* accounts of each type were detected ? yes ALERXCV |
| 60 |
* commodities/accounts are checked ? no use -s to check commodities/accounts |
| 61 |
* balance assertions are checked ? yes use -I to ignore assertions |