hledger-ui 1.34 → 1.40
raw patch · 7 files changed
+260/−222 lines, 7 filesdep ~brickdep ~hledgerdep ~hledger-libPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: brick, hledger, hledger-lib, megaparsec
API changes (from Hackage documentation)
Files
- CHANGES.md +21/−2
- Hledger/UI/MenuScreen.hs +12/−6
- Hledger/UI/UIOptions.hs +1/−2
- hledger-ui.1 +37/−32
- hledger-ui.cabal +8/−8
- hledger-ui.info +60/−55
- hledger-ui.txt +121/−117
CHANGES.md view
@@ -7,12 +7,12 @@ Breaking changes +Fixes+ Features Improvements -Fixes- Docs API@@ -22,6 +22,21 @@ See also the hledger changelog. +# 1.40 2024-09-09++Improvements++- The menu screen now supports the shift arrow and shift T keys,+ and its header shows any narrowed time period in effect, like other screens.++- Support brick 2.4.++Docs++- The description of the shift-T key (set period to today) has been fixed.+- The shift arrow keys and period narrowing have been clarified++ # 1.34 2024-06-01 Features@@ -291,6 +306,10 @@ Improvements - Require base >=4.11, prevent red squares on Hackage's build matrix.++Fixes++- Do not display a screen full of .. when there are no transactions. (#822) API changes
Hledger/UI/MenuScreen.hs view
@@ -36,10 +36,11 @@ import Hledger.UI.ErrorScreen (uiReloadJournal, uiCheckBalanceAssertions, uiReloadJournalIfChanged) import Hledger.UI.Editor (runIadd, runEditor, endPosition) import Brick.Widgets.Edit (getEditContents, handleEditorEvent)+import Control.Arrow ((>>>)) msDraw :: UIState -> [Widget Name]-msDraw UIState{aopts=_uopts@UIOpts{uoCliOpts=copts@CliOpts{reportspec_=_rspec}}+msDraw UIState{aopts=_uopts@UIOpts{uoCliOpts=copts@CliOpts{reportspec_=_rspec@ReportSpec{_rsReportOpts=ropts}}} ,ajournal=j ,aScreen=MS sst ,aMode=mode@@ -53,6 +54,7 @@ where toplabel = withAttr (attrName "border" <> attrName "filename") files+ <+> borderPeriodStr "" (period_ ropts) <+> (if ignore_assertions_ . balancingopts_ $ inputopts_ copts then withAttr (attrName "border" <> attrName "query") (str " ignoring balance assertions") else str "")@@ -113,6 +115,7 @@ Nothing -> Nothing nonblanks = V.takeWhile (not . T.null . msItemScreenName) $ listElements $ _mssList sst lastnonblankidx = max 0 (length nonblanks - 1)+ journalspan = journalDateSpan False j d <- liftIO getCurrentDay case mode of@@ -177,7 +180,6 @@ -- VtyEvent (EvKey (KChar 'T') []) -> put' $ regenerateScreens j d $ setReportPeriod (DayPeriod d) ui -- -- display mode/query toggles--- VtyEvent (EvKey (KChar 'H') []) -> modify' (regenerateScreens j d . toggleHistorical) >> msCenterAndContinue -- VtyEvent (EvKey (KChar 't') []) -> modify' (regenerateScreens j d . toggleTree) >> msCenterAndContinue -- VtyEvent (EvKey (KChar c) []) | c `elem` ['z','Z'] -> modify' (regenerateScreens j d . toggleEmpty) >> msCenterAndContinue -- VtyEvent (EvKey (KChar 'R') []) -> modify' (regenerateScreens j d . toggleReal) >> msCenterAndContinue@@ -185,11 +187,15 @@ -- VtyEvent (EvKey (KChar 'P') []) -> modify' (regenerateScreens j d . togglePending) >> msCenterAndContinue -- VtyEvent (EvKey (KChar 'C') []) -> modify' (regenerateScreens j d . toggleCleared) >> msCenterAndContinue -- VtyEvent (EvKey (KChar 'F') []) -> modify' (regenerateScreens j d . toggleForecast d)+ -- VtyEvent (EvKey (KChar 'H') []) -> modify' (toggleHistorical >>> regenerateScreens j d) - -- VtyEvent (EvKey (KDown) [MShift]) -> put' $ regenerateScreens j d $ shrinkReportPeriod d ui- -- VtyEvent (EvKey (KUp) [MShift]) -> put' $ regenerateScreens j d $ growReportPeriod d ui- -- VtyEvent (EvKey (KRight) [MShift]) -> put' $ regenerateScreens j d $ nextReportPeriod journalspan ui- -- VtyEvent (EvKey (KLeft) [MShift]) -> put' $ regenerateScreens j d $ previousReportPeriod journalspan ui+ -- narrow/widen/move the period as on other screens, for consistency+ VtyEvent (EvKey (KDown) [MShift]) -> modify' (shrinkReportPeriod d >>> regenerateScreens j d)+ VtyEvent (EvKey (KUp) [MShift]) -> modify' (growReportPeriod d >>> regenerateScreens j d)+ VtyEvent (EvKey (KRight) [MShift]) -> modify' (nextReportPeriod journalspan >>> regenerateScreens j d)+ VtyEvent (EvKey (KLeft) [MShift]) -> modify' (previousReportPeriod journalspan >>> regenerateScreens j d)+ VtyEvent (EvKey (KChar 'T') []) -> modify' (setReportPeriod (DayPeriod d) >>> regenerateScreens j d)+ VtyEvent (EvKey (KChar '/') []) -> put' $ regenerateScreens j d $ showMinibuffer "filter" Nothing ui VtyEvent (EvKey k []) | k `elem` [KBS, KDel] -> (put' $ regenerateScreens j d $ resetFilter ui)
Hledger/UI/UIOptions.hs view
@@ -47,7 +47,6 @@ uiflags = [- -- flagNone ["debug-ui"] (setboolopt "rules-file") "run with no terminal output, showing console" flagNone ["watch","w"] (setboolopt "watch") "watch for data and date changes and reload automatically" ,flagReq ["theme"] (\s opts -> Right $ setopt "theme" s opts) "THEME" ("use this custom display theme ("++intercalate ", " themeNames++")") ,flagNone ["cash"] (setboolopt "cash") "start in the cash accounts screen"@@ -123,7 +122,7 @@ --getHledgerUIOpts = processArgs uimode >>= return >>= rawOptsToUIOpts getHledgerUIOpts = do args <- getArgs >>= expandArgsAt- let args' = replaceNumericFlags $ ensureDebugHasArg args+ let args' = ensureDebugFlagHasVal $ replaceNumericFlags args let cmdargopts = either usageError id $ process uimode args' rawOptsToUIOpts cmdargopts
hledger-ui.1 view
@@ -1,5 +1,5 @@ -.TH "HLEDGER\-UI" "1" "June 2024" "hledger-ui-1.34 " "hledger User Manuals"+.TH "HLEDGER\-UI" "1" "September 2024" "hledger-ui-1.40 " "hledger User Manuals" @@ -17,7 +17,7 @@ .PD \f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION-This manual is for hledger\[aq]s terminal interface, version 1.34.+This manual is for hledger\[aq]s terminal interface, version 1.40. See also the hledger manual for common concepts and file formats. .PP hledger is a robust, user\-friendly, cross\-platform set of programs for@@ -70,12 +70,13 @@ .IP .EX General input/data transformation flags:- \-f \-\-file=FILE Read data from FILE, or from stdin if \-. Can be- specified more than once. If not specified, reads- from $LEDGER_FILE or $HOME/.hledger.journal.- \-\-rules\-file=RULEFILE Use conversion rules from this file for+ \-f \-\-file=[FMT:]FILE Read data from FILE, or from stdin if FILE is \-,+ inferring format from extension or a FMT: prefix.+ Can be specified more than once. If not specified,+ reads from $LEDGER_FILE or $HOME/.hledger.journal.+ \-\-rules=RULESFILE Use rules defined in this rules file for converting subsequent CSV/SSV/TSV files. If not- specified, uses FILE.rules for each such FILE.+ specified, uses FILE.csv.rules for each FILE.csv. \-\-alias=A=B|/RGX/=RPL transform account names from A to B, or by replacing regular expression matches \-\-auto generate extra postings by applying auto posting@@ -138,7 +139,6 @@ \-\-pretty[=YN] Use box\-drawing characters in text output? Can be \[aq]y\[aq]/\[aq]yes\[aq] or \[aq]n\[aq]/\[aq]no\[aq]. If YN is specified, the equals is required.- \-\-debug=[1\-9] show this level of debug output (default: 1) General help flags: \-h \-\-help show command line help@@ -146,6 +146,7 @@ \-\-info show the manual with info \-\-man show the manual with man \-\-version show version information+ \-\-debug=[1\-9] show this much debug output (default: 1) .EE .PP With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to@@ -177,31 +178,10 @@ (\f[CR]CTRL\-p\f[R]/\f[CR]CTRL\-n\f[R]/\f[CR]CTRL\-f\f[R]/\f[CR]CTRL\-b\f[R]) and VI\-style (\f[CR]k\f[R],\f[CR]j\f[R],\f[CR]l\f[R],\f[CR]h\f[R]) movement keys are also supported.-A tip: movement speed is limited by your keyboard repeat rate, to move-faster you may want to adjust it.-(If you\[aq]re on a mac, the karabiner app is one way to do that.) .PP-With shift pressed, the cursor keys adjust the report period, limiting-the transactions to be shown (by default, all are shown).-\f[CR]SHIFT\-DOWN/UP\f[R] steps downward and upward through these-standard report period durations: year, quarter, month, week, day.-Then, \f[CR]SHIFT\-LEFT/RIGHT\f[R] moves to the previous/next period.-\f[CR]T\f[R] sets the report period to today.-With the \f[CR]\-w/\-\-watch\f[R] option, when viewing a-\[dq]current\[dq] period (the current day, week, month, quarter, or-year), the period will move automatically to track the current date.-To set a non\-standard period, you can use \f[CR]/\f[R] and a-\f[CR]date:\f[R] query.-.PP-(Mac users: SHIFT\-DOWN/UP keys do not work by default in Terminal, as-of MacOS Monterey.-You can configure them as follows: open Terminal, press CMD\-comma to-open preferences, click Profiles, select your current terminal profile-on the left, click Keyboard on the right, click + and add this for-Shift\-Down: \f[CR]\[rs]033[1;2B\f[R], click + and add this for-Shift\-Up: \f[CR]\[rs]033[1;2A\f[R].-Press the Escape key to enter the \f[CR]\[rs]033\f[R] part, you-can\[aq]t type it directly.)+(Tip: movement speed is limited by your keyboard repeat rate, to move+faster you may want to adjust it.+On a mac, the Karabiner app is one way to do that.) .PP \f[CR]/\f[R] lets you set a general filter query limiting the data shown, using the same query terms as in hledger and hledger\-web.@@ -217,6 +197,31 @@ transactions generated by rule. \f[CR]F\f[R] toggles forecast mode, in which future/forecasted transactions are shown.+.PP+Pressing \f[CR]SHIFT\-DOWN\f[R] narrows the report period, and pressing+\f[CR]SHIFT\-UP\f[R] expands it again.+When narrowed, the current report period is displayed in the header+line, pressing \f[CR]SHIFT\-LEFT\f[R] or \f[CR]SHIFT\-RIGHT\f[R] moves+to the previous or next period, and pressing \f[CR]T\f[R] sets the+period to \[dq]today\[dq].+If you are using \f[CR]\-w/\-\-watch\f[R] and viewing a narrowed period+containing today, the view will follow any changes in system date+(moving to the period containing the new date).+.PP+You can also specify a non\-standard period with \f[CR]/\f[R] and a+\f[CR]date:\f[R] query; in this case, the period is not movable with the+arrow keys.+.PP+(Tip: arrow keys with Shift do not work out of the box in all terminal+software.+Eg in Apple\[aq]s Terminal, the SHIFT\-DOWN and SHIFT\-UP keys must be+configured as follows: in Terminal\[aq]s preferences, click Profiles,+select your current profile on the left, click Keyboard on the right,+click + and add this for SHIFT\-DOWN: \f[CR]\[rs]033[1;2B\f[R], click ++and add this for SHIFT\-UP: \f[CR]\[rs]033[1;2A\f[R].+\ In other terminals (Windows Terminal ?)+you might need to configure SHIFT\-RIGHT and SHIFT\-LEFT to emit+\f[CR]\[rs]033[1;2C\f[R] and \f[CR]\[rs]033[1;2D\f[R] respectively.) .PP \f[CR]ESCAPE\f[R] resets the UI state and jumps back to the top screen, restoring the app\[aq]s initial state at startup.
hledger-ui.cabal view
@@ -1,11 +1,11 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.36.0.+-- This file has been generated from package.yaml by hpack version 0.37.0. -- -- see: https://github.com/sol/hpack name: hledger-ui-version: 1.34+version: 1.40 synopsis: Terminal interface for the hledger accounting system description: A simple terminal user interface for the hledger accounting system. It can be a more convenient way to browse your accounts than the CLI.@@ -73,23 +73,23 @@ hs-source-dirs: ./ ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind- cpp-options: -DVERSION="1.34" -DVERSION="1.34"+ cpp-options: -DVERSION="1.40" -DVERSION="1.40" build-depends: ansi-terminal >=0.9 , async , base >=4.14 && <4.20- , brick >=2.1.1 && <2.4+ , brick >=2.1.1 && <2.3.2 || >2.3.2 && <2.5 , cmdargs >=0.8 , containers >=0.5.9 , data-default , directory- , doclayout >=0.3 && <0.5+ , doclayout >=0.3 && <0.6 , extra >=1.6.3 , filepath , fsnotify ==0.4.* , githash >=0.1.6.2- , hledger ==1.34.*- , hledger-lib ==1.34.*+ , hledger ==1.40.*+ , hledger-lib ==1.40.* , megaparsec >=7.0.0 && <9.7 , microlens >=0.4 , microlens-platform >=0.2.3.1@@ -123,7 +123,7 @@ hs-source-dirs: app ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind- cpp-options: -DVERSION="1.34"+ cpp-options: -DVERSION="1.40" build-depends: base >=4.14 && <4.20 , hledger-ui
hledger-ui.info view
@@ -18,7 +18,7 @@ or 'hledger ui -- [OPTS] [QUERYARGS]' - This manual is for hledger's terminal interface, version 1.34. See+ This manual is for hledger's terminal interface, version 1.40. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs@@ -81,12 +81,13 @@ and also supports many of hledger's general options: General input/data transformation flags:- -f --file=FILE Read data from FILE, or from stdin if -. Can be- specified more than once. If not specified, reads- from $LEDGER_FILE or $HOME/.hledger.journal.- --rules-file=RULEFILE Use conversion rules from this file for+ -f --file=[FMT:]FILE Read data from FILE, or from stdin if FILE is -,+ inferring format from extension or a FMT: prefix.+ Can be specified more than once. If not specified,+ reads from $LEDGER_FILE or $HOME/.hledger.journal.+ --rules=RULESFILE Use rules defined in this rules file for converting subsequent CSV/SSV/TSV files. If not- specified, uses FILE.rules for each such FILE.+ specified, uses FILE.csv.rules for each FILE.csv. --alias=A=B|/RGX/=RPL transform account names from A to B, or by replacing regular expression matches --auto generate extra postings by applying auto posting@@ -149,7 +150,6 @@ --pretty[=YN] Use box-drawing characters in text output? Can be 'y'/'yes' or 'n'/'no'. If YN is specified, the equals is required.- --debug=[1-9] show this level of debug output (default: 1) General help flags: -h --help show command line help@@ -157,6 +157,7 @@ --info show the manual with info --man show the manual with man --version show version information+ --debug=[1-9] show this much debug output (default: 1) With hledger-ui, the '--debug' option sends debug output to a 'hledger-ui.log' file in the current directory.@@ -191,27 +192,11 @@ returns to the previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END' move up and down through lists. Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') and VI-style ('k','j','l','h')-movement keys are also supported. A tip: movement speed is limited by-your keyboard repeat rate, to move faster you may want to adjust it.-(If you're on a mac, the karabiner app is one way to do that.)-- With shift pressed, the cursor keys adjust the report period,-limiting the transactions to be shown (by default, all are shown).-'SHIFT-DOWN/UP' steps downward and upward through these standard report-period durations: year, quarter, month, week, day. Then,-'SHIFT-LEFT/RIGHT' moves to the previous/next period. 'T' sets the-report period to today. With the '-w/--watch' option, when viewing a-"current" period (the current day, week, month, quarter, or year), the-period will move automatically to track the current date. To set a-non-standard period, you can use '/' and a 'date:' query.+movement keys are also supported. - (Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as-of MacOS Monterey. You can configure them as follows: open Terminal,-press CMD-comma to open preferences, click Profiles, select your current-terminal profile on the left, click Keyboard on the right, click + and-add this for Shift-Down: '\033[1;2B', click + and add this for Shift-Up:-'\033[1;2A'. Press the Escape key to enter the '\033' part, you can't-type it directly.)+ (Tip: movement speed is limited by your keyboard repeat rate, to move+faster you may want to adjust it. On a mac, the Karabiner app is one+way to do that.) '/' lets you set a general filter query limiting the data shown, using the same query terms as in hledger and hledger-web. While editing@@ -226,6 +211,26 @@ transactions generated by rule. 'F' toggles forecast mode, in which future/forecasted transactions are shown. + Pressing 'SHIFT-DOWN' narrows the report period, and pressing+'SHIFT-UP' expands it again. When narrowed, the current report period+is displayed in the header line, pressing 'SHIFT-LEFT' or 'SHIFT-RIGHT'+moves to the previous or next period, and pressing 'T' sets the period+to "today". If you are using '-w/--watch' and viewing a narrowed period+containing today, the view will follow any changes in system date+(moving to the period containing the new date).++ You can also specify a non-standard period with '/' and a 'date:'+query; in this case, the period is not movable with the arrow keys.++ (Tip: arrow keys with Shift do not work out of the box in all+terminal software. Eg in Apple's Terminal, the SHIFT-DOWN and SHIFT-UP+keys must be configured as follows: in Terminal's preferences, click+Profiles, select your current profile on the left, click Keyboard on the+right, click + and add this for SHIFT-DOWN: '\033[1;2B', click + and add+this for SHIFT-UP: '\033[1;2A'. In other terminals (Windows Terminal ?)+you might need to configure SHIFT-RIGHT and SHIFT-LEFT to emit+'\033[1;2C' and '\033[1;2D' respectively.)+ 'ESCAPE' resets the UI state and jumps back to the top screen, restoring the app's initial state at startup. Or, it cancels minibuffer data entry or the help dialog.@@ -532,34 +537,34 @@ Node: Top221 Node: OPTIONS1870 Ref: #options1968-Node: MOUSE8148-Ref: #mouse8243-Node: KEYS8480-Ref: #keys8573-Node: SCREENS13228-Ref: #screens13332-Node: Menu screen13968-Ref: #menu-screen14089-Node: Cash accounts screen14284-Ref: #cash-accounts-screen14461-Node: Balance sheet accounts screen14645-Ref: #balance-sheet-accounts-screen14861-Node: Income statement accounts screen14981-Ref: #income-statement-accounts-screen15202-Node: All accounts screen15366-Ref: #all-accounts-screen15547-Node: Register screen15729-Ref: #register-screen15888-Node: Transaction screen18172-Ref: #transaction-screen18330-Node: Error screen19747-Ref: #error-screen19869-Node: WATCH MODE20113-Ref: #watch-mode20230-Node: ENVIRONMENT21689-Ref: #environment21805-Node: BUGS21996-Ref: #bugs22079+Node: MOUSE8234+Ref: #mouse8329+Node: KEYS8566+Ref: #keys8659+Node: SCREENS13394+Ref: #screens13498+Node: Menu screen14134+Ref: #menu-screen14255+Node: Cash accounts screen14450+Ref: #cash-accounts-screen14627+Node: Balance sheet accounts screen14811+Ref: #balance-sheet-accounts-screen15027+Node: Income statement accounts screen15147+Ref: #income-statement-accounts-screen15368+Node: All accounts screen15532+Ref: #all-accounts-screen15713+Node: Register screen15895+Ref: #register-screen16054+Node: Transaction screen18338+Ref: #transaction-screen18496+Node: Error screen19913+Ref: #error-screen20035+Node: WATCH MODE20279+Ref: #watch-mode20396+Node: ENVIRONMENT21855+Ref: #environment21971+Node: BUGS22162+Ref: #bugs22245 End Tag Table
hledger-ui.txt view
@@ -11,7 +11,7 @@ hledger ui -- [OPTS] [QUERYARGS] DESCRIPTION- This manual is for hledger's terminal interface, version 1.34. See+ This manual is for hledger's terminal interface, version 1.40. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs for@@ -59,12 +59,13 @@ and also supports many of hledger's general options: General input/data transformation flags:- -f --file=FILE Read data from FILE, or from stdin if -. Can be- specified more than once. If not specified, reads- from $LEDGER_FILE or $HOME/.hledger.journal.- --rules-file=RULEFILE Use conversion rules from this file for+ -f --file=[FMT:]FILE Read data from FILE, or from stdin if FILE is -,+ inferring format from extension or a FMT: prefix.+ Can be specified more than once. If not specified,+ reads from $LEDGER_FILE or $HOME/.hledger.journal.+ --rules=RULESFILE Use rules defined in this rules file for converting subsequent CSV/SSV/TSV files. If not- specified, uses FILE.rules for each such FILE.+ specified, uses FILE.csv.rules for each FILE.csv. --alias=A=B|/RGX/=RPL transform account names from A to B, or by replacing regular expression matches --auto generate extra postings by applying auto posting@@ -127,7 +128,6 @@ --pretty[=YN] Use box-drawing characters in text output? Can be 'y'/'yes' or 'n'/'no'. If YN is specified, the equals is required.- --debug=[1-9] show this level of debug output (default: 1) General help flags: -h --help show command line help@@ -135,6 +135,7 @@ --info show the manual with info --man show the manual with man --version show version information+ --debug=[1-9] show this much debug output (default: 1) With hledger-ui, the --debug option sends debug output to a hledger-ui.log file in the current directory.@@ -160,28 +161,11 @@ The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists. Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) and VI-style- (k,j,l,h) movement keys are also supported. A tip: movement speed is- limited by your keyboard repeat rate, to move faster you may want to- adjust it. (If you're on a mac, the karabiner app is one way to do- that.)-- With shift pressed, the cursor keys adjust the report period, limiting- the transactions to be shown (by default, all are shown).- SHIFT-DOWN/UP steps downward and upward through these standard report- period durations: year, quarter, month, week, day. Then,- SHIFT-LEFT/RIGHT moves to the previous/next period. T sets the report- period to today. With the -w/--watch option, when viewing a "current"- period (the current day, week, month, quarter, or year), the period- will move automatically to track the current date. To set a non-stan-- dard period, you can use / and a date: query.+ (k,j,l,h) movement keys are also supported. - (Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as- of MacOS Monterey. You can configure them as follows: open Terminal,- press CMD-comma to open preferences, click Profiles, select your cur-- rent terminal profile on the left, click Keyboard on the right, click +- and add this for Shift-Down: \033[1;2B, click + and add this for- Shift-Up: \033[1;2A. Press the Escape key to enter the \033 part, you- can't type it directly.)+ (Tip: movement speed is limited by your keyboard repeat rate, to move+ faster you may want to adjust it. On a mac, the Karabiner app is one+ way to do that.) / lets you set a general filter query limiting the data shown, using the same query terms as in hledger and hledger-web. While editing the@@ -195,52 +179,72 @@ actions generated by rule. F toggles forecast mode, in which fu- ture/forecasted transactions are shown. - ESCAPE resets the UI state and jumps back to the top screen, restoring+ Pressing SHIFT-DOWN narrows the report period, and pressing SHIFT-UP+ expands it again. When narrowed, the current report period is dis-+ played in the header line, pressing SHIFT-LEFT or SHIFT-RIGHT moves to+ the previous or next period, and pressing T sets the period to "today".+ If you are using -w/--watch and viewing a narrowed period containing+ today, the view will follow any changes in system date (moving to the+ period containing the new date).++ You can also specify a non-standard period with / and a date: query; in+ this case, the period is not movable with the arrow keys.++ (Tip: arrow keys with Shift do not work out of the box in all terminal+ software. Eg in Apple's Terminal, the SHIFT-DOWN and SHIFT-UP keys+ must be configured as follows: in Terminal's preferences, click Pro-+ files, select your current profile on the left, click Keyboard on the+ right, click + and add this for SHIFT-DOWN: \033[1;2B, click + and add+ this for SHIFT-UP: \033[1;2A. In other terminals (Windows Terminal ?)+ you might need to configure SHIFT-RIGHT and SHIFT-LEFT to emit+ \033[1;2C and \033[1;2D respectively.)++ ESCAPE resets the UI state and jumps back to the top screen, restoring the app's initial state at startup. Or, it cancels minibuffer data en- try or the help dialog. CTRL-l redraws the screen and centers the selection if possible (selec-- tions near the top won't be centered, since we don't scroll above the+ tions near the top won't be centered, since we don't scroll above the top). - g reloads from the data file(s) and updates the current screen and any- previous screens. (With large files, this could cause a noticeable+ g reloads from the data file(s) and updates the current screen and any+ previous screens. (With large files, this could cause a noticeable pause.) - I toggles balance assertion checking. Disabling balance assertions+ I toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. - a runs command-line hledger's add command, and reloads the updated+ a runs command-line hledger's add command, and reloads the updated file. This allows some basic data entry. - A is like a, but runs the hledger-iadd tool, which provides a terminal- interface. This key will be available if hledger-iadd is installed in+ A is like a, but runs the hledger-iadd tool, which provides a terminal+ interface. This key will be available if hledger-iadd is installed in $path. - E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""- -nw) on the journal file. With some editors (emacs, vi), the cursor- will be positioned at the current transaction when invoked from the- register and transaction screens, and at the error location (if possi-+ E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""+ -nw) on the journal file. With some editors (emacs, vi), the cursor+ will be positioned at the current transaction when invoked from the+ register and transaction screens, and at the error location (if possi- ble) when invoked from the error screen. - B toggles cost mode, showing amounts converted to their cost's commod-+ B toggles cost mode, showing amounts converted to their cost's commod- ity (see hledger manual > Cost reporting. - V toggles value mode, showing amounts converted to their market value+ V toggles value mode, showing amounts converted to their market value (see hledger manual > Valuation flag). More specifically, - 1. By default, the V key toggles showing end value (--value=end) on or- off. The valuation date will be the report end date if specified,+ 1. By default, the V key toggles showing end value (--value=end) on or+ off. The valuation date will be the report end date if specified, otherwise today. - 2. If you started hledger-ui with some other valuation (such as+ 2. If you started hledger-ui with some other valuation (such as --value=then,EUR), the V key toggles that off or on. - Cost/value tips: - When showing end value, you can change the report- end date without restarting, by pressing / and adding a query like- date:..YYYY-MM-DD. - Either cost mode, or value mode, can be active,- but not both at once. Cost mode takes precedence. - There's not yet- any visual indicator that cost or value mode is active, other than the+ Cost/value tips: - When showing end value, you can change the report+ end date without restarting, by pressing / and adding a query like+ date:..YYYY-MM-DD. - Either cost mode, or value mode, can be active,+ but not both at once. Cost mode takes precedence. - There's not yet+ any visual indicator that cost or value mode is active, other than the amount values. q quits the application.@@ -248,47 +252,47 @@ Additional screen-specific keys are described below. SCREENS- At startup, hledger-ui shows a menu screen by default. From here you+ At startup, hledger-ui shows a menu screen by default. From here you can navigate to other screens using the cursor keys: UP/DOWN to select,- RIGHT to move to the selected screen, LEFT to return to the previous+ RIGHT to move to the selected screen, LEFT to return to the previous screen. Or you can use ESC to return directly to the top menu screen. - You can also use a command line flag to specific a different startup+ You can also use a command line flag to specific a different startup screen (--cs, --bs, --is, --all, or --register=ACCT). Menu screen- This is the top-most screen. From here you can navigate to several- screens listing accounts of various types. Note some of these may not+ This is the top-most screen. From here you can navigate to several+ screens listing accounts of various types. Note some of these may not show anything until you have configured account types. Cash accounts screen This screen shows "cash" (ie, liquid asset) accounts (like hledger bal-- ancesheet type:c). It always shows balances (historical ending bal-+ ancesheet type:c). It always shows balances (historical ending bal- ances on the date shown in the title line). Balance sheet accounts screen- This screen shows asset, liability and equity accounts (like hledger+ This screen shows asset, liability and equity accounts (like hledger balancesheetequity). It always shows balances. Income statement accounts screen- This screen shows revenue and expense accounts (like hledger incomes-- tatement). It always shows changes (balance changes in the period+ This screen shows revenue and expense accounts (like hledger incomes-+ tatement). It always shows changes (balance changes in the period shown in the title line). All accounts screen- This screen shows all accounts in your journal (unless filtered by a- query; like hledger balance). It shows balances by default; you can+ This screen shows all accounts in your journal (unless filtered by a+ query; like hledger balance). It shows balances by default; you can toggle showing changes with the H key. Register screen- This screen shows the transactions affecting a particular account.+ This screen shows the transactions affecting a particular account. Each line represents one transaction, and shows: - o the other account(s) involved, in abbreviated form. (If there are- both real and virtual postings, it shows only the accounts affected+ o the other account(s) involved, in abbreviated form. (If there are+ both real and virtual postings, it shows only the accounts affected by real postings.) - o the overall change to the current account's balance; positive for an+ o the overall change to the current account's balance; positive for an inflow to this account, negative for an outflow. o the running total after the transaction. With the H key you can tog-@@ -296,90 +300,90 @@ o the period total, which is from just the transactions displayed - o or the historical total, which includes any undisplayed transac-- tions before the start of the report period (and matching the fil-- ter query if any). This will be the running historical balance- (what you would see on a bank's website, eg) if not disturbed by a+ o or the historical total, which includes any undisplayed transac-+ tions before the start of the report period (and matching the fil-+ ter query if any). This will be the running historical balance+ (what you would see on a bank's website, eg) if not disturbed by a query. - Note, this screen combines each transaction's in-period postings to a- single line item, dated with the earliest in-period transaction or- posting date (like hledger's aregister). So custom posting dates can- cause the running balance to be temporarily inaccurate. (See hledger+ Note, this screen combines each transaction's in-period postings to a+ single line item, dated with the earliest in-period transaction or+ posting date (like hledger's aregister). So custom posting dates can+ cause the running balance to be temporarily inaccurate. (See hledger manual > aregister and posting dates.) - Transactions affecting this account's subaccounts will be included in+ Transactions affecting this account's subaccounts will be included in the register if the accounts screen is in tree mode, or if it's in list- mode but this account has subaccounts which are not shown due to a- depth limit. In other words, the register always shows the transac-- tions contributing to the balance shown on the accounts screen. Tree+ mode but this account has subaccounts which are not shown due to a+ depth limit. In other words, the register always shows the transac-+ tions contributing to the balance shown on the accounts screen. Tree mode/list mode can be toggled with t here also. - U toggles filtering by unmarked status, showing or hiding unmarked+ U toggles filtering by unmarked status, showing or hiding unmarked transactions. Similarly, P toggles pending transactions, and C toggles- cleared transactions. (By default, transactions with all statuses are- shown; if you activate one or two status filters, only those transac-+ cleared transactions. (By default, transactions with all statuses are+ shown; if you activate one or two status filters, only those transac- tions are shown; and if you activate all three, the filter is removed.) R toggles real mode, in which virtual postings are ignored. - z toggles nonzero mode, in which only transactions posting a nonzero- change are shown (hledger-ui shows zero items by default, unlike com-+ z toggles nonzero mode, in which only transactions posting a nonzero+ change are shown (hledger-ui shows zero items by default, unlike com- mand-line hledger). Press RIGHT to view the selected transaction in detail. Transaction screen- This screen shows a single transaction, as a general journal entry,- similar to hledger's print command and journal format (hledger_jour-+ This screen shows a single transaction, as a general journal entry,+ similar to hledger's print command and journal format (hledger_jour- nal(5)). - The transaction's date(s) and any cleared flag, transaction code, de-- scription, comments, along with all of its account postings are shown.- Simple transactions have two postings, but there can be more (or in+ The transaction's date(s) and any cleared flag, transaction code, de-+ scription, comments, along with all of its account postings are shown.+ Simple transactions have two postings, but there can be more (or in certain cases, fewer). - UP and DOWN will step through all transactions listed in the previous- account register screen. In the title bar, the numbers in parentheses- show your position within that account register. They will vary de-+ UP and DOWN will step through all transactions listed in the previous+ account register screen. In the title bar, the numbers in parentheses+ show your position within that account register. They will vary de- pending on which account register you came from (remember most transac-- tions appear in multiple account registers). The #N number preceding+ tions appear in multiple account registers). The #N number preceding them is the transaction's position within the complete unfiltered jour- nal, which is a more stable id (at least until the next reload). On this screen (and the register screen), the E key will open your text- editor with the cursor positioned at the current transaction if possi-+ editor with the cursor positioned at the current transaction if possi- ble. - This screen has a limitation with showing file updates: it will not- show them until you exit and re-enter it. So eg to see the effect of+ This screen has a limitation with showing file updates: it will not+ show them until you exit and re-enter it. So eg to see the effect of using the E key, currently you must: - press E, edit and save the file,- then exit the editor, returning to hledger-ui - press g to reload the- file (or use -w/--watch mode) - press LEFT then RIGHT to exit and+ then exit the editor, returning to hledger-ui - press g to reload the+ file (or use -w/--watch mode) - press LEFT then RIGHT to exit and re-enter the transaction screen. Error screen- This screen will appear if there is a problem, such as a parse error,- when you press g to reload. Once you have fixed the problem, press g+ This screen will appear if there is a problem, such as a parse error,+ when you press g to reload. Once you have fixed the problem, press g again to reload and resume normal operation. (Or, you can press escape to cancel the reload attempt.) WATCH MODE- One of hledger-ui's best features is the auto-reloading -w/--watch- mode. With this flag, it will update the display automatically when-+ One of hledger-ui's best features is the auto-reloading -w/--watch+ mode. With this flag, it will update the display automatically when- ever changes are saved to the data files. - This is very useful when reconciling. A good workflow is to have your- bank's online register open in a browser window, for reference; the- journal file open in an editor window; and hledger-ui in watch mode in+ This is very useful when reconciling. A good workflow is to have your+ bank's online register open in a browser window, for reference; the+ journal file open in an editor window; and hledger-ui in watch mode in a terminal window, eg: $ hledger-ui --watch --register checking -C - As you mark things cleared in the editor, you can see the effect imme-- diately without having to context switch. This leaves more mental- bandwidth for your accounting. Of course you can still interact with- hledger-ui when needed, eg to toggle cleared mode, or to explore the+ As you mark things cleared in the editor, you can see the effect imme-+ diately without having to context switch. This leaves more mental+ bandwidth for your accounting. Of course you can still interact with+ hledger-ui when needed, eg to toggle cleared mode, or to explore the history. There are currently some limitations with --watch:@@ -387,27 +391,27 @@ It may not work correctly for you, depending on platform or system con- figuration. (Eg #836.) - At least on mac, there can be a slow build-up of CPU usage over time,- until the program is restarted (or, suspending and restarting with+ At least on mac, there can be a slow build-up of CPU usage over time,+ until the program is restarted (or, suspending and restarting with CTRL-z fg may be enough). - It will not detect file changes made by certain editors, such as Jet-- brains IDEs or gedit, or on certain less common filesystems. (To work- around, press g to reload manually, or try #1617's fs.ino-+ It will not detect file changes made by certain editors, such as Jet-+ brains IDEs or gedit, or on certain less common filesystems. (To work+ around, press g to reload manually, or try #1617's fs.ino- tify.max_user_watches workaround and let us know.) - If you are viewing files mounted from another machine, the system+ If you are viewing files mounted from another machine, the system clocks on both machines should be roughly in agreement. ENVIRONMENT COLUMNS The screen width to use. Default: the full terminal width. - LEDGER_FILE The main journal file to use when not specified with+ LEDGER_FILE The main journal file to use when not specified with -f/--file. Default: $HOME/.hledger.journal. BUGS We welcome bug reports in the hledger issue tracker (shortcut:- http://bugs.hledger.org), or on the #hledger chat or hledger mail list+ http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). Some known issues:@@ -419,7 +423,7 @@ The Transaction screen does not update from file changes until you exit and re-endter it (see SCREENS > Transaction above). - --watch is not yet fully robust on all platforms (see Watch mode+ --watch is not yet fully robust on all platforms (see Watch mode above). @@ -440,4 +444,4 @@ SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.34 June 2024 HLEDGER-UI(1)+hledger-ui-1.40 September 2024 HLEDGER-UI(1)