;doc: update manuals
This commit is contained in:
Simon Michael
parent
77ee3fd846
commit
12eaee8dcb
@ -4,7 +4,8 @@
|
|||||||
|
|
||||||
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
hledger\-ui \- robust, friendly plain text accounting (TUI version)
|
hledger\-ui \- terminal interface (TUI) for \f[CR]hledger\f[R], a
|
||||||
|
robust, friendly plain text accounting app.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
\f[CR]hledger\-ui [OPTS] [QUERYARGS]\f[R]
|
\f[CR]hledger\-ui [OPTS] [QUERYARGS]\f[R]
|
||||||
.PD 0
|
.PD 0
|
||||||
|
|||||||
@ -11,7 +11,8 @@ File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
|
|||||||
hledger-ui(1)
|
hledger-ui(1)
|
||||||
*************
|
*************
|
||||||
|
|
||||||
hledger-ui - robust, friendly plain text accounting (TUI version)
|
hledger-ui - terminal interface (TUI) for 'hledger', a robust, friendly
|
||||||
|
plain text accounting app.
|
||||||
|
|
||||||
'hledger-ui [OPTS] [QUERYARGS]'
|
'hledger-ui [OPTS] [QUERYARGS]'
|
||||||
'hledger ui -- [OPTS] [QUERYARGS]'
|
'hledger ui -- [OPTS] [QUERYARGS]'
|
||||||
@ -580,42 +581,42 @@ above).
|
|||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
Node: Top221
|
Node: Top221
|
||||||
Node: OPTIONS1830
|
Node: OPTIONS1863
|
||||||
Ref: #options1928
|
Ref: #options1961
|
||||||
Node: General options2895
|
Node: General options2928
|
||||||
Ref: #general-options2999
|
Ref: #general-options3032
|
||||||
Node: MOUSE8149
|
Node: MOUSE8182
|
||||||
Ref: #mouse8244
|
Ref: #mouse8277
|
||||||
Node: KEYS8481
|
Node: KEYS8514
|
||||||
Ref: #keys8574
|
Ref: #keys8607
|
||||||
Node: SCREENS13229
|
Node: SCREENS13262
|
||||||
Ref: #screens13327
|
Ref: #screens13360
|
||||||
Node: Menu screen13963
|
Node: Menu screen13996
|
||||||
Ref: #menu-screen14084
|
Ref: #menu-screen14117
|
||||||
Node: Cash accounts screen14279
|
Node: Cash accounts screen14312
|
||||||
Ref: #cash-accounts-screen14456
|
Ref: #cash-accounts-screen14489
|
||||||
Node: Balance sheet accounts screen14640
|
Node: Balance sheet accounts screen14673
|
||||||
Ref: #balance-sheet-accounts-screen14856
|
Ref: #balance-sheet-accounts-screen14889
|
||||||
Node: Income statement accounts screen14976
|
Node: Income statement accounts screen15009
|
||||||
Ref: #income-statement-accounts-screen15197
|
Ref: #income-statement-accounts-screen15230
|
||||||
Node: All accounts screen15361
|
Node: All accounts screen15394
|
||||||
Ref: #all-accounts-screen15542
|
Ref: #all-accounts-screen15575
|
||||||
Node: Register screen15724
|
Node: Register screen15757
|
||||||
Ref: #register-screen15883
|
Ref: #register-screen15916
|
||||||
Node: Transaction screen18167
|
Node: Transaction screen18200
|
||||||
Ref: #transaction-screen18325
|
Ref: #transaction-screen18358
|
||||||
Node: Error screen19742
|
Node: Error screen19775
|
||||||
Ref: #error-screen19864
|
Ref: #error-screen19897
|
||||||
Node: TIPS20108
|
Node: TIPS20141
|
||||||
Ref: #tips20207
|
Ref: #tips20240
|
||||||
Node: Watch mode20249
|
Node: Watch mode20282
|
||||||
Ref: #watch-mode20356
|
Ref: #watch-mode20389
|
||||||
Node: Debug output21815
|
Node: Debug output21848
|
||||||
Ref: #debug-output21926
|
Ref: #debug-output21959
|
||||||
Node: ENVIRONMENT22138
|
Node: ENVIRONMENT22171
|
||||||
Ref: #environment22248
|
Ref: #environment22281
|
||||||
Node: BUGS22439
|
Node: BUGS22472
|
||||||
Ref: #bugs22522
|
Ref: #bugs22555
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|||||||
@ -2,41 +2,42 @@
|
|||||||
HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
|
HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
hledger-ui - robust, friendly plain text accounting (TUI version)
|
hledger-ui - terminal interface (TUI) for hledger, a robust, friendly
|
||||||
|
plain text accounting app.
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
hledger-ui [OPTS] [QUERYARGS]
|
hledger-ui [OPTS] [QUERYARGS]
|
||||||
hledger ui -- [OPTS] [QUERYARGS]
|
hledger ui -- [OPTS] [QUERYARGS]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
This manual is for hledger's terminal interface, version 1.33.99. See
|
This manual is for hledger's terminal interface, version 1.33.99. See
|
||||||
also the hledger manual for common concepts and file formats.
|
also the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
tracking money, time, or any other commodity, using double-entry ac-
|
tracking money, time, or any other commodity, using double-entry ac-
|
||||||
counting and a simple, editable file format. hledger is inspired by
|
counting and a simple, editable file format. hledger is inspired by
|
||||||
and largely compatible with ledger(1), and largely interconvertible
|
and largely compatible with ledger(1), and largely interconvertible
|
||||||
with beancount(1).
|
with beancount(1).
|
||||||
|
|
||||||
hledger-ui is hledger's terminal interface, providing an efficient
|
hledger-ui is hledger's terminal interface, providing an efficient
|
||||||
full-window text UI for viewing accounts and transactions, and some
|
full-window text UI for viewing accounts and transactions, and some
|
||||||
limited data entry capability. It is easier than hledger's com-
|
limited data entry capability. It is easier than hledger's com-
|
||||||
mand-line interface, and sometimes quicker and more convenient than the
|
mand-line interface, and sometimes quicker and more convenient than the
|
||||||
web interface.
|
web interface.
|
||||||
|
|
||||||
Like hledger, it reads from (and appends to) a journal file specified
|
Like hledger, it reads from (and appends to) a journal file specified
|
||||||
by the LEDGER_FILE environment variable (defaulting to
|
by the LEDGER_FILE environment variable (defaulting to
|
||||||
$HOME/.hledger.journal); or you can specify files with -f options. It
|
$HOME/.hledger.journal); or you can specify files with -f options. It
|
||||||
can also read timeclock files, timedot files, or any CSV/SSV/TSV file
|
can also read timeclock files, timedot files, or any CSV/SSV/TSV file
|
||||||
with a date field. (See hledger(1) -> Input for details.)
|
with a date field. (See hledger(1) -> Input for details.)
|
||||||
|
|
||||||
Unlike hledger, hledger-ui hides all future-dated transactions by de-
|
Unlike hledger, hledger-ui hides all future-dated transactions by de-
|
||||||
fault. They can be revealed, along with any rule-generated periodic
|
fault. They can be revealed, along with any rule-generated periodic
|
||||||
transactions, by pressing the F key (or starting with --forecast) to
|
transactions, by pressing the F key (or starting with --forecast) to
|
||||||
enable "forecast mode".
|
enable "forecast mode".
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
Any QUERYARGS are interpreted as a hledger search query which filters
|
Any QUERYARGS are interpreted as a hledger search query which filters
|
||||||
the data.
|
the data.
|
||||||
|
|
||||||
hledger-ui provides the following options:
|
hledger-ui provides the following options:
|
||||||
@ -61,7 +62,7 @@ OPTIONS
|
|||||||
start in the (first) matched account's register screen
|
start in the (first) matched account's register screen
|
||||||
|
|
||||||
--change
|
--change
|
||||||
show period balances (changes) at startup instead of historical
|
show period balances (changes) at startup instead of historical
|
||||||
balances
|
balances
|
||||||
|
|
||||||
-l --flat
|
-l --flat
|
||||||
@ -70,7 +71,7 @@ OPTIONS
|
|||||||
-t --tree
|
-t --tree
|
||||||
show accounts as a tree
|
show accounts as a tree
|
||||||
|
|
||||||
hledger-ui also supports many of hledger's general options (and the
|
hledger-ui also supports many of hledger's general options (and the
|
||||||
hledger manual's command line tips also apply here):
|
hledger manual's command line tips also apply here):
|
||||||
|
|
||||||
General options
|
General options
|
||||||
@ -154,7 +155,7 @@ OPTIONS
|
|||||||
--version show version information
|
--version show version information
|
||||||
|
|
||||||
MOUSE
|
MOUSE
|
||||||
In most modern terminals, you can navigate through the screens with a
|
In most modern terminals, you can navigate through the screens with a
|
||||||
mouse or touchpad:
|
mouse or touchpad:
|
||||||
|
|
||||||
o Use mouse wheel or trackpad to scroll up and down
|
o Use mouse wheel or trackpad to scroll up and down
|
||||||
@ -166,95 +167,95 @@ MOUSE
|
|||||||
KEYS
|
KEYS
|
||||||
Keyboard gives more control.
|
Keyboard gives more control.
|
||||||
|
|
||||||
? shows a help dialog listing all keys. (Some of these also appear in
|
? shows a help dialog listing all keys. (Some of these also appear in
|
||||||
the quick help at the bottom of each screen.) Press ? again (or ES-
|
the quick help at the bottom of each screen.) Press ? again (or ES-
|
||||||
CAPE, or LEFT, or q) to close it. The following keys work on most
|
CAPE, or LEFT, or q) to close it. The following keys work on most
|
||||||
screens:
|
screens:
|
||||||
|
|
||||||
The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to
|
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
|
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
|
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
|
(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
|
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
|
adjust it. (If you're on a mac, the karabiner app is one way to do
|
||||||
that.)
|
that.)
|
||||||
|
|
||||||
With shift pressed, the cursor keys adjust the report period, limiting
|
With shift pressed, the cursor keys adjust the report period, limiting
|
||||||
the transactions to be shown (by default, all are shown).
|
the transactions to be shown (by default, all are shown).
|
||||||
SHIFT-DOWN/UP steps downward and upward through these standard report
|
SHIFT-DOWN/UP steps downward and upward through these standard report
|
||||||
period durations: year, quarter, month, week, day. Then,
|
period durations: year, quarter, month, week, day. Then,
|
||||||
SHIFT-LEFT/RIGHT moves to the previous/next period. T sets the report
|
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 to today. With the -w/--watch option, when viewing a "current"
|
||||||
period (the current day, week, month, quarter, or year), the period
|
period (the current day, week, month, quarter, or year), the period
|
||||||
will move automatically to track the current date. To set a non-stan-
|
will move automatically to track the current date. To set a non-stan-
|
||||||
dard period, you can use / and a date: query.
|
dard period, you can use / and a date: query.
|
||||||
|
|
||||||
(Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as
|
(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,
|
of MacOS Monterey. You can configure them as follows: open Terminal,
|
||||||
press CMD-comma to open preferences, click Profiles, select your cur-
|
press CMD-comma to open preferences, click Profiles, select your cur-
|
||||||
rent terminal profile on the left, click Keyboard on the right, click +
|
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
|
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
|
Shift-Up: \033[1;2A. Press the Escape key to enter the \033 part, you
|
||||||
can't type it directly.)
|
can't type it directly.)
|
||||||
|
|
||||||
/ lets you set a general filter query limiting the data shown, using
|
/ 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
|
the same query terms as in hledger and hledger-web. While editing the
|
||||||
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
|
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
|
||||||
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
|
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
|
||||||
common filters like account depth and transaction status (see below).
|
common filters like account depth and transaction status (see below).
|
||||||
BACKSPACE or DELETE removes all filters, showing all transactions.
|
BACKSPACE or DELETE removes all filters, showing all transactions.
|
||||||
|
|
||||||
As mentioned above, by default hledger-ui hides future transactions -
|
As mentioned above, by default hledger-ui hides future transactions -
|
||||||
both ordinary transactions recorded in the journal, and periodic trans-
|
both ordinary transactions recorded in the journal, and periodic trans-
|
||||||
actions generated by rule. F toggles forecast mode, in which fu-
|
actions generated by rule. F toggles forecast mode, in which fu-
|
||||||
ture/forecasted transactions are shown.
|
ture/forecasted transactions are shown.
|
||||||
|
|
||||||
ESCAPE resets the UI state and jumps back to the top screen, restoring
|
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-
|
the app's initial state at startup. Or, it cancels minibuffer data en-
|
||||||
try or the help dialog.
|
try or the help dialog.
|
||||||
|
|
||||||
CTRL-l redraws the screen and centers the selection if possible (selec-
|
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).
|
top).
|
||||||
|
|
||||||
g reloads from the data file(s) and updates the current screen and any
|
g reloads from the data file(s) and updates the current screen and any
|
||||||
previous screens. (With large files, this could cause a noticeable
|
previous screens. (With large files, this could cause a noticeable
|
||||||
pause.)
|
pause.)
|
||||||
|
|
||||||
I toggles balance assertion checking. Disabling balance assertions
|
I toggles balance assertion checking. Disabling balance assertions
|
||||||
temporarily can be useful for troubleshooting.
|
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.
|
file. This allows some basic data entry.
|
||||||
|
|
||||||
A is like a, but runs the hledger-iadd tool, which provides a terminal
|
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
|
interface. This key will be available if hledger-iadd is installed in
|
||||||
$path.
|
$path.
|
||||||
|
|
||||||
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
|
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
|
||||||
-nw) on the journal file. With some editors (emacs, vi), the cursor
|
-nw) on the journal file. With some editors (emacs, vi), the cursor
|
||||||
will be positioned at the current transaction when invoked from the
|
will be positioned at the current transaction when invoked from the
|
||||||
register and transaction screens, and at the error location (if possi-
|
register and transaction screens, and at the error location (if possi-
|
||||||
ble) when invoked from the error screen.
|
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.
|
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,
|
(see hledger manual > Valuation flag). More specifically,
|
||||||
|
|
||||||
1. By default, the V key toggles showing end value (--value=end) on or
|
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,
|
off. The valuation date will be the report end date if specified,
|
||||||
otherwise today.
|
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.
|
--value=then,EUR), the V key toggles that off or on.
|
||||||
|
|
||||||
Cost/value tips: - When showing end value, you can change the report
|
Cost/value tips: - When showing end value, you can change the report
|
||||||
end date without restarting, by pressing / and adding a query like
|
end date without restarting, by pressing / and adding a query like
|
||||||
date:..YYYY-MM-DD. - Either cost mode, or value mode, can be active,
|
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
|
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
|
any visual indicator that cost or value mode is active, other than the
|
||||||
amount values.
|
amount values.
|
||||||
|
|
||||||
q quits the application.
|
q quits the application.
|
||||||
@ -262,47 +263,47 @@ KEYS
|
|||||||
Additional screen-specific keys are described below.
|
Additional screen-specific keys are described below.
|
||||||
|
|
||||||
SCREENS
|
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,
|
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.
|
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).
|
screen (--cs, --bs, --is, --all, or --register=ACCT).
|
||||||
|
|
||||||
Menu screen
|
Menu screen
|
||||||
This is the top-most screen. From here you can navigate to several
|
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
|
screens listing accounts of various types. Note some of these may not
|
||||||
show anything until you have configured account types.
|
show anything until you have configured account types.
|
||||||
|
|
||||||
Cash accounts screen
|
Cash accounts screen
|
||||||
This screen shows "cash" (ie, liquid asset) accounts (like hledger bal-
|
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).
|
ances on the date shown in the title line).
|
||||||
|
|
||||||
Balance sheet accounts screen
|
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.
|
balancesheetequity). It always shows balances.
|
||||||
|
|
||||||
Income statement accounts screen
|
Income statement accounts screen
|
||||||
This screen shows revenue and expense accounts (like hledger incomes-
|
This screen shows revenue and expense accounts (like hledger incomes-
|
||||||
tatement). It always shows changes (balance changes in the period
|
tatement). It always shows changes (balance changes in the period
|
||||||
shown in the title line).
|
shown in the title line).
|
||||||
|
|
||||||
All accounts screen
|
All accounts screen
|
||||||
This screen shows all accounts in your journal (unless filtered by a
|
This screen shows all accounts in your journal (unless filtered by a
|
||||||
query; like hledger balance). It shows balances by default; you can
|
query; like hledger balance). It shows balances by default; you can
|
||||||
toggle showing changes with the H key.
|
toggle showing changes with the H key.
|
||||||
|
|
||||||
Register screen
|
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:
|
Each line represents one transaction, and shows:
|
||||||
|
|
||||||
o the other account(s) involved, in abbreviated form. (If there are
|
o the other account(s) involved, in abbreviated form. (If there are
|
||||||
both real and virtual postings, it shows only the accounts affected
|
both real and virtual postings, it shows only the accounts affected
|
||||||
by real postings.)
|
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.
|
inflow to this account, negative for an outflow.
|
||||||
|
|
||||||
o the running total after the transaction. With the H key you can tog-
|
o the running total after the transaction. With the H key you can tog-
|
||||||
@ -310,91 +311,91 @@ SCREENS
|
|||||||
|
|
||||||
o the period total, which is from just the transactions displayed
|
o the period total, which is from just the transactions displayed
|
||||||
|
|
||||||
o or the historical total, which includes any undisplayed transac-
|
o or the historical total, which includes any undisplayed transac-
|
||||||
tions before the start of the report period (and matching the fil-
|
tions before the start of the report period (and matching the fil-
|
||||||
ter query if any). This will be the running historical balance
|
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
|
(what you would see on a bank's website, eg) if not disturbed by a
|
||||||
query.
|
query.
|
||||||
|
|
||||||
Note, this screen combines each transaction's in-period postings to a
|
Note, this screen combines each transaction's in-period postings to a
|
||||||
single line item, dated with the earliest in-period transaction or
|
single line item, dated with the earliest in-period transaction or
|
||||||
posting date (like hledger's aregister). So custom posting dates can
|
posting date (like hledger's aregister). So custom posting dates can
|
||||||
cause the running balance to be temporarily inaccurate. (See hledger
|
cause the running balance to be temporarily inaccurate. (See hledger
|
||||||
manual > aregister and posting dates.)
|
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
|
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
|
mode but this account has subaccounts which are not shown due to a
|
||||||
depth limit. In other words, the register always shows the transac-
|
depth limit. In other words, the register always shows the transac-
|
||||||
tions contributing to the balance shown on the accounts screen. Tree
|
tions contributing to the balance shown on the accounts screen. Tree
|
||||||
mode/list mode can be toggled with t here also.
|
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
|
transactions. Similarly, P toggles pending transactions, and C toggles
|
||||||
cleared transactions. (By default, transactions with all statuses are
|
cleared transactions. (By default, transactions with all statuses are
|
||||||
shown; if you activate one or two status filters, only those transac-
|
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.)
|
tions are shown; and if you activate all three, the filter is removed.)
|
||||||
|
|
||||||
R toggles real mode, in which virtual postings are ignored.
|
R toggles real mode, in which virtual postings are ignored.
|
||||||
|
|
||||||
z toggles nonzero mode, in which only transactions posting a nonzero
|
z toggles nonzero mode, in which only transactions posting a nonzero
|
||||||
change are shown (hledger-ui shows zero items by default, unlike com-
|
change are shown (hledger-ui shows zero items by default, unlike com-
|
||||||
mand-line hledger).
|
mand-line hledger).
|
||||||
|
|
||||||
Press RIGHT to view the selected transaction in detail.
|
Press RIGHT to view the selected transaction in detail.
|
||||||
|
|
||||||
Transaction screen
|
Transaction screen
|
||||||
This screen shows a single transaction, as a general journal entry,
|
This screen shows a single transaction, as a general journal entry,
|
||||||
similar to hledger's print command and journal format (hledger_jour-
|
similar to hledger's print command and journal format (hledger_jour-
|
||||||
nal(5)).
|
nal(5)).
|
||||||
|
|
||||||
The transaction's date(s) and any cleared flag, transaction code, de-
|
The transaction's date(s) and any cleared flag, transaction code, de-
|
||||||
scription, comments, along with all of its account postings are shown.
|
scription, comments, along with all of its account postings are shown.
|
||||||
Simple transactions have two postings, but there can be more (or in
|
Simple transactions have two postings, but there can be more (or in
|
||||||
certain cases, fewer).
|
certain cases, fewer).
|
||||||
|
|
||||||
UP and DOWN will step through all transactions listed in the previous
|
UP and DOWN will step through all transactions listed in the previous
|
||||||
account register screen. In the title bar, the numbers in parentheses
|
account register screen. In the title bar, the numbers in parentheses
|
||||||
show your position within that account register. They will vary de-
|
show your position within that account register. They will vary de-
|
||||||
pending on which account register you came from (remember most transac-
|
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-
|
them is the transaction's position within the complete unfiltered jour-
|
||||||
nal, which is a more stable id (at least until the next reload).
|
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
|
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.
|
ble.
|
||||||
|
|
||||||
This screen has a limitation with showing file updates: it will not
|
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
|
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,
|
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
|
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
|
file (or use -w/--watch mode) - press LEFT then RIGHT to exit and
|
||||||
re-enter the transaction screen.
|
re-enter the transaction screen.
|
||||||
|
|
||||||
Error screen
|
Error screen
|
||||||
This screen will appear if there is a problem, such as a parse error,
|
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
|
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
|
again to reload and resume normal operation. (Or, you can press escape
|
||||||
to cancel the reload attempt.)
|
to cancel the reload attempt.)
|
||||||
|
|
||||||
TIPS
|
TIPS
|
||||||
Watch mode
|
Watch mode
|
||||||
One of hledger-ui's best features is the auto-reloading -w/--watch
|
One of hledger-ui's best features is the auto-reloading -w/--watch
|
||||||
mode. With this flag, it will update the display automatically when-
|
mode. With this flag, it will update the display automatically when-
|
||||||
ever changes are saved to the data files.
|
ever changes are saved to the data files.
|
||||||
|
|
||||||
This is very useful when reconciling. A good workflow is to have your
|
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
|
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
|
journal file open in an editor window; and hledger-ui in watch mode in
|
||||||
a terminal window, eg:
|
a terminal window, eg:
|
||||||
|
|
||||||
$ hledger-ui --watch --register checking -C
|
$ hledger-ui --watch --register checking -C
|
||||||
|
|
||||||
As you mark things cleared in the editor, you can see the effect imme-
|
As you mark things cleared in the editor, you can see the effect imme-
|
||||||
diately without having to context switch. This leaves more mental
|
diately without having to context switch. This leaves more mental
|
||||||
bandwidth for your accounting. Of course you can still interact with
|
bandwidth for your accounting. Of course you can still interact with
|
||||||
hledger-ui when needed, eg to toggle cleared mode, or to explore the
|
hledger-ui when needed, eg to toggle cleared mode, or to explore the
|
||||||
history.
|
history.
|
||||||
|
|
||||||
There are currently some limitations with --watch:
|
There are currently some limitations with --watch:
|
||||||
@ -402,32 +403,32 @@ TIPS
|
|||||||
It may not work correctly for you, depending on platform or system con-
|
It may not work correctly for you, depending on platform or system con-
|
||||||
figuration. (Eg #836.)
|
figuration. (Eg #836.)
|
||||||
|
|
||||||
At least on mac, there can be a slow build-up of CPU usage over time,
|
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
|
until the program is restarted (or, suspending and restarting with
|
||||||
CTRL-z fg may be enough).
|
CTRL-z fg may be enough).
|
||||||
|
|
||||||
It will not detect file changes made by certain editors, such as Jet-
|
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
|
brains IDEs or gedit, or on certain less common filesystems. (To work
|
||||||
around, press g to reload manually, or try #1617's fs.ino-
|
around, press g to reload manually, or try #1617's fs.ino-
|
||||||
tify.max_user_watches workaround and let us know.)
|
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.
|
clocks on both machines should be roughly in agreement.
|
||||||
|
|
||||||
Debug output
|
Debug output
|
||||||
You can add --debug[=N] to the command line to log debug output. This
|
You can add --debug[=N] to the command line to log debug output. This
|
||||||
will be logged to the file hledger-ui.log in the current directory. N
|
will be logged to the file hledger-ui.log in the current directory. N
|
||||||
ranges from 1 (least output, the default) to 9 (maximum output).
|
ranges from 1 (least output, the default) to 9 (maximum output).
|
||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
COLUMNS The screen width to use. Default: the full terminal width.
|
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.
|
-f/--file. Default: $HOME/.hledger.journal.
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
We welcome bug reports in the hledger issue tracker (shortcut:
|
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).
|
(https://hledger.org/support).
|
||||||
|
|
||||||
Some known issues:
|
Some known issues:
|
||||||
@ -439,7 +440,7 @@ BUGS
|
|||||||
The Transaction screen does not update from file changes until you exit
|
The Transaction screen does not update from file changes until you exit
|
||||||
and re-endter it (see SCREENS > Transaction above).
|
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).
|
above).
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -4,7 +4,8 @@
|
|||||||
|
|
||||||
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
hledger\-web \- robust, friendly plain text accounting (Web version)
|
hledger\-web \- web interface and API for \f[CR]hledger\f[R], a robust,
|
||||||
|
friendly plain text accounting app.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
\f[CR]hledger\-web [\-\-serve|\-\-serve\-api] [OPTS] [ARGS]\f[R]
|
\f[CR]hledger\-web [\-\-serve|\-\-serve\-api] [OPTS] [ARGS]\f[R]
|
||||||
.PD 0
|
.PD 0
|
||||||
|
|||||||
@ -11,7 +11,8 @@ File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
|
|||||||
hledger-web(1)
|
hledger-web(1)
|
||||||
**************
|
**************
|
||||||
|
|
||||||
hledger-web - robust, friendly plain text accounting (Web version)
|
hledger-web - web interface and API for 'hledger', a robust, friendly
|
||||||
|
plain text accounting app.
|
||||||
|
|
||||||
'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
|
'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
|
||||||
'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
|
'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
|
||||||
@ -547,26 +548,26 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list
|
|||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
Node: Top223
|
Node: Top223
|
||||||
Node: OPTIONS2578
|
Node: OPTIONS2608
|
||||||
Ref: #options2683
|
Ref: #options2713
|
||||||
Node: General options5587
|
Node: General options5617
|
||||||
Ref: #general-options5692
|
Ref: #general-options5722
|
||||||
Node: PERMISSIONS10842
|
Node: PERMISSIONS10872
|
||||||
Ref: #permissions10981
|
Ref: #permissions11011
|
||||||
Node: EDITING UPLOADING DOWNLOADING12193
|
Node: EDITING UPLOADING DOWNLOADING12223
|
||||||
Ref: #editing-uploading-downloading12374
|
Ref: #editing-uploading-downloading12404
|
||||||
Node: RELOADING13208
|
Node: RELOADING13238
|
||||||
Ref: #reloading13342
|
Ref: #reloading13372
|
||||||
Node: JSON API13775
|
Node: JSON API13805
|
||||||
Ref: #json-api13890
|
Ref: #json-api13920
|
||||||
Node: DEBUG OUTPUT19378
|
Node: DEBUG OUTPUT19408
|
||||||
Ref: #debug-output19503
|
Ref: #debug-output19533
|
||||||
Node: Debug output19530
|
Node: Debug output19560
|
||||||
Ref: #debug-output-119631
|
Ref: #debug-output-119661
|
||||||
Node: ENVIRONMENT20048
|
Node: ENVIRONMENT20078
|
||||||
Ref: #environment20167
|
Ref: #environment20197
|
||||||
Node: BUGS20284
|
Node: BUGS20314
|
||||||
Ref: #bugs20368
|
Ref: #bugs20398
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|||||||
@ -2,48 +2,49 @@
|
|||||||
HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
|
HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
hledger-web - robust, friendly plain text accounting (Web version)
|
hledger-web - web interface and API for hledger, a robust, friendly
|
||||||
|
plain text accounting app.
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
hledger-web [--serve|--serve-api] [OPTS] [ARGS]
|
hledger-web [--serve|--serve-api] [OPTS] [ARGS]
|
||||||
hledger web -- [--serve|--serve-api] [OPTS] [ARGS]
|
hledger web -- [--serve|--serve-api] [OPTS] [ARGS]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
This manual is for hledger's web interface, version 1.33.99. See also
|
This manual is for hledger's web interface, version 1.33.99. See also
|
||||||
the hledger manual for common concepts and file formats.
|
the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
tracking money, time, or any other commodity, using double-entry ac-
|
tracking money, time, or any other commodity, using double-entry ac-
|
||||||
counting and a simple, editable file format. hledger is inspired by
|
counting and a simple, editable file format. hledger is inspired by
|
||||||
and largely compatible with ledger(1), and largely interconvertible
|
and largely compatible with ledger(1), and largely interconvertible
|
||||||
with beancount(1).
|
with beancount(1).
|
||||||
|
|
||||||
hledger-web is a simple web application for browsing and adding trans-
|
hledger-web is a simple web application for browsing and adding trans-
|
||||||
actions. It provides a more user-friendly UI than the hledger CLI or
|
actions. It provides a more user-friendly UI than the hledger CLI or
|
||||||
hledger-ui TUI, showing more at once (accounts, the current account
|
hledger-ui TUI, showing more at once (accounts, the current account
|
||||||
register, balance charts) and allowing history-aware data entry, inter-
|
register, balance charts) and allowing history-aware data entry, inter-
|
||||||
active searching, and bookmarking.
|
active searching, and bookmarking.
|
||||||
|
|
||||||
hledger-web also lets you share a journal with multiple users, or even
|
hledger-web also lets you share a journal with multiple users, or even
|
||||||
the public web. There is no access control, so if you need that you
|
the public web. There is no access control, so if you need that you
|
||||||
should put it behind a suitable web proxy. As a small protection
|
should put it behind a suitable web proxy. As a small protection
|
||||||
against data loss when running an unprotected instance, it writes a
|
against data loss when running an unprotected instance, it writes a
|
||||||
numbered backup of the main journal file (only) on every edit.
|
numbered backup of the main journal file (only) on every edit.
|
||||||
|
|
||||||
Like hledger, it reads from (and appends to) a journal file specified
|
Like hledger, it reads from (and appends to) a journal file specified
|
||||||
by the LEDGER_FILE environment variable (defaulting to
|
by the LEDGER_FILE environment variable (defaulting to
|
||||||
$HOME/.hledger.journal); or you can specify files with -f options. It
|
$HOME/.hledger.journal); or you can specify files with -f options. It
|
||||||
can also read timeclock files, timedot files, or any CSV/SSV/TSV file
|
can also read timeclock files, timedot files, or any CSV/SSV/TSV file
|
||||||
with a date field. (See hledger(1) -> Input for details.)
|
with a date field. (See hledger(1) -> Input for details.)
|
||||||
|
|
||||||
hledger-web can be run in three modes:
|
hledger-web can be run in three modes:
|
||||||
|
|
||||||
o Transient mode (the default): your default web browser will be opened
|
o Transient mode (the default): your default web browser will be opened
|
||||||
to show the app if possible, and the app exits automatically after
|
to show the app if possible, and the app exits automatically after
|
||||||
two minutes of inactivity (no requests received and no open browser
|
two minutes of inactivity (no requests received and no open browser
|
||||||
windows viewing it).
|
windows viewing it).
|
||||||
|
|
||||||
o With --serve: the app runs without stopping, and without opening a
|
o With --serve: the app runs without stopping, and without opening a
|
||||||
browser.
|
browser.
|
||||||
|
|
||||||
o With --serve-api: only the JSON API is served.
|
o With --serve-api: only the JSON API is served.
|
||||||
@ -61,36 +62,36 @@ OPTIONS
|
|||||||
like --serve, but serve only the JSON web API, not the web UI
|
like --serve, but serve only the JSON web API, not the web UI
|
||||||
|
|
||||||
--allow=view|add|edit
|
--allow=view|add|edit
|
||||||
set the user's access level for changing data (default: add).
|
set the user's access level for changing data (default: add).
|
||||||
It also accepts sandstorm for use on that platform (reads per-
|
It also accepts sandstorm for use on that platform (reads per-
|
||||||
missions from the X-Sandstorm-Permissions request header).
|
missions from the X-Sandstorm-Permissions request header).
|
||||||
|
|
||||||
--cors=ORIGIN
|
--cors=ORIGIN
|
||||||
allow cross-origin requests from the specified origin; setting
|
allow cross-origin requests from the specified origin; setting
|
||||||
ORIGIN to "*" allows requests from any origin
|
ORIGIN to "*" allows requests from any origin
|
||||||
|
|
||||||
--host=IPADDR
|
--host=IPADDR
|
||||||
listen on this IP address (default: 127.0.0.1)
|
listen on this IP address (default: 127.0.0.1)
|
||||||
|
|
||||||
By default the server listens on IP address 127.0.0.1, which is acces-
|
By default the server listens on IP address 127.0.0.1, which is acces-
|
||||||
sible only to requests from the local machine.. You can use --host to
|
sible only to requests from the local machine.. You can use --host to
|
||||||
listen on a different address configured on the machine, eg to allow
|
listen on a different address configured on the machine, eg to allow
|
||||||
access from other machines. The special address 0.0.0.0 causes it to
|
access from other machines. The special address 0.0.0.0 causes it to
|
||||||
listen on all addresses configured on the machine.
|
listen on all addresses configured on the machine.
|
||||||
|
|
||||||
--port=PORT
|
--port=PORT
|
||||||
listen on this TCP port (default: 5000)
|
listen on this TCP port (default: 5000)
|
||||||
|
|
||||||
Similarly, you can use --port to listen on a TCP port other than 5000.
|
Similarly, you can use --port to listen on a TCP port other than 5000.
|
||||||
This is useful if you want to run multiple hledger-web instances on a
|
This is useful if you want to run multiple hledger-web instances on a
|
||||||
machine.
|
machine.
|
||||||
|
|
||||||
--socket=SOCKETFILE
|
--socket=SOCKETFILE
|
||||||
listen on the given unix socket instead of an IP address and
|
listen on the given unix socket instead of an IP address and
|
||||||
port (unix only; implies --serve)
|
port (unix only; implies --serve)
|
||||||
|
|
||||||
When --socket is used, hledger-web creates and communicates via a
|
When --socket is used, hledger-web creates and communicates via a
|
||||||
socket file instead of a TCP port. This can be more secure, respects
|
socket file instead of a TCP port. This can be more secure, respects
|
||||||
unix file permissions, and makes certain use cases easier, such as run-
|
unix file permissions, and makes certain use cases easier, such as run-
|
||||||
ning per-user instances behind an nginx reverse proxy. (Eg: proxy_pass
|
ning per-user instances behind an nginx reverse proxy. (Eg: proxy_pass
|
||||||
http://unix:/tmp/hledger/${remote_user}.socket;.)
|
http://unix:/tmp/hledger/${remote_user}.socket;.)
|
||||||
@ -98,28 +99,28 @@ OPTIONS
|
|||||||
--base-url=URL
|
--base-url=URL
|
||||||
set the base url (default: http://IPADDR:PORT).
|
set the base url (default: http://IPADDR:PORT).
|
||||||
|
|
||||||
You can use --base-url to change the protocol, hostname, port and path
|
You can use --base-url to change the protocol, hostname, port and path
|
||||||
that appear in hledger-web's hyperlinks. This is useful eg when inte-
|
that appear in hledger-web's hyperlinks. This is useful eg when inte-
|
||||||
grating hledger-web within a larger website. The default is
|
grating hledger-web within a larger website. The default is
|
||||||
http://HOST:PORT/ using the server's configured host address and TCP
|
http://HOST:PORT/ using the server's configured host address and TCP
|
||||||
port (or http://HOST if PORT is 80). Note this affects url generation
|
port (or http://HOST if PORT is 80). Note this affects url generation
|
||||||
but not route parsing.
|
but not route parsing.
|
||||||
|
|
||||||
--test run hledger-web's tests and exit. hspec test runner args may
|
--test run hledger-web's tests and exit. hspec test runner args may
|
||||||
follow a --, eg: hledger-web --test -- --help
|
follow a --, eg: hledger-web --test -- --help
|
||||||
|
|
||||||
hledger-web also supports many of hledger's general options. Query op-
|
hledger-web also supports many of hledger's general options. Query op-
|
||||||
tions and arguments may be used to set an initial filter, which al-
|
tions and arguments may be used to set an initial filter, which al-
|
||||||
though not shown in the UI, will restrict the data shown, in addition
|
though not shown in the UI, will restrict the data shown, in addition
|
||||||
to any search query entered in the UI.
|
to any search query entered in the UI.
|
||||||
|
|
||||||
Note that hledger-web shows accounts with zero balances by default,
|
Note that hledger-web shows accounts with zero balances by default,
|
||||||
like hledger-ui (and unlike hledger). Using the -E/--empty flag at
|
like hledger-ui (and unlike hledger). Using the -E/--empty flag at
|
||||||
startup will hide them.
|
startup will hide them.
|
||||||
|
|
||||||
If you see accounts which appear to have a zero balance, but cannot be
|
If you see accounts which appear to have a zero balance, but cannot be
|
||||||
hidden with -E: these have a mixed-cost balance which looks like zero
|
hidden with -E: these have a mixed-cost balance which looks like zero
|
||||||
when costs are hidden. Currently hledger-web does not show costs at
|
when costs are hidden. Currently hledger-web does not show costs at
|
||||||
all.
|
all.
|
||||||
|
|
||||||
General options
|
General options
|
||||||
@ -203,13 +204,13 @@ OPTIONS
|
|||||||
--version show version information
|
--version show version information
|
||||||
|
|
||||||
PERMISSIONS
|
PERMISSIONS
|
||||||
By default, hledger-web allows anyone who can reach it to view the
|
By default, hledger-web allows anyone who can reach it to view the
|
||||||
journal and to add new transactions, but not to change existing data.
|
journal and to add new transactions, but not to change existing data.
|
||||||
|
|
||||||
You can restrict who can reach it by
|
You can restrict who can reach it by
|
||||||
|
|
||||||
o setting the IP address it listens on (see --host above). By default
|
o setting the IP address it listens on (see --host above). By default
|
||||||
it listens on 127.0.0.1, accessible to all users on the local ma-
|
it listens on 127.0.0.1, accessible to all users on the local ma-
|
||||||
chine.
|
chine.
|
||||||
|
|
||||||
o putting it behind an authenticating proxy, using eg apache or nginx
|
o putting it behind an authenticating proxy, using eg apache or nginx
|
||||||
@ -219,44 +220,44 @@ PERMISSIONS
|
|||||||
You can restrict what the users who reach it can do, by
|
You can restrict what the users who reach it can do, by
|
||||||
|
|
||||||
o using the --capabilities=CAP[,CAP..] flag when you start it, enabling
|
o using the --capabilities=CAP[,CAP..] flag when you start it, enabling
|
||||||
one or more of the following capabilities. The default value is
|
one or more of the following capabilities. The default value is
|
||||||
view,add:
|
view,add:
|
||||||
|
|
||||||
o view - allows viewing the journal file and all included files
|
o view - allows viewing the journal file and all included files
|
||||||
|
|
||||||
o add - allows adding new transactions to the main journal file
|
o add - allows adding new transactions to the main journal file
|
||||||
|
|
||||||
o manage - allows editing, uploading or downloading the main or in-
|
o manage - allows editing, uploading or downloading the main or in-
|
||||||
cluded files
|
cluded files
|
||||||
|
|
||||||
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
|
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
|
||||||
header from which it will read capabilities to enable. hledger-web
|
header from which it will read capabilities to enable. hledger-web
|
||||||
on Sandstorm uses the X-Sandstorm-Permissions header to integrate
|
on Sandstorm uses the X-Sandstorm-Permissions header to integrate
|
||||||
with Sandstorm's permissions. This is disabled by default.
|
with Sandstorm's permissions. This is disabled by default.
|
||||||
|
|
||||||
EDITING, UPLOADING, DOWNLOADING
|
EDITING, UPLOADING, DOWNLOADING
|
||||||
If you enable the manage capability mentioned above, you'll see a new
|
If you enable the manage capability mentioned above, you'll see a new
|
||||||
"spanner" button to the right of the search form. Clicking this will
|
"spanner" button to the right of the search form. Clicking this will
|
||||||
let you edit, upload, or download the journal file or any files it in-
|
let you edit, upload, or download the journal file or any files it in-
|
||||||
cludes.
|
cludes.
|
||||||
|
|
||||||
Note, unlike any other hledger command, in this mode you (or any visi-
|
Note, unlike any other hledger command, in this mode you (or any visi-
|
||||||
tor) can alter or wipe the data files.
|
tor) can alter or wipe the data files.
|
||||||
|
|
||||||
Normally whenever a file is changed in this way, hledger-web saves a
|
Normally whenever a file is changed in this way, hledger-web saves a
|
||||||
numbered backup (assuming file permissions allow it, the disk is not
|
numbered backup (assuming file permissions allow it, the disk is not
|
||||||
full, etc.) hledger-web is not aware of version control systems, cur-
|
full, etc.) hledger-web is not aware of version control systems, cur-
|
||||||
rently; if you use one, you'll have to arrange to commit the changes
|
rently; if you use one, you'll have to arrange to commit the changes
|
||||||
yourself (eg with a cron job or a file watcher like entr).
|
yourself (eg with a cron job or a file watcher like entr).
|
||||||
|
|
||||||
Changes which would leave the journal file(s) unparseable or non-valid
|
Changes which would leave the journal file(s) unparseable or non-valid
|
||||||
(eg with failing balance assertions) are prevented. (Probably. This
|
(eg with failing balance assertions) are prevented. (Probably. This
|
||||||
needs re-testing.)
|
needs re-testing.)
|
||||||
|
|
||||||
RELOADING
|
RELOADING
|
||||||
hledger-web detects changes made to the files by other means (eg if you
|
hledger-web detects changes made to the files by other means (eg if you
|
||||||
edit it directly, outside of hledger-web), and it will show the new
|
edit it directly, outside of hledger-web), and it will show the new
|
||||||
data when you reload the page or navigate to a new page. If a change
|
data when you reload the page or navigate to a new page. If a change
|
||||||
makes a file unparseable, hledger-web will display an error message un-
|
makes a file unparseable, hledger-web will display an error message un-
|
||||||
til the file has been fixed.
|
til the file has been fixed.
|
||||||
|
|
||||||
@ -264,8 +265,8 @@ RELOADING
|
|||||||
that both machine clocks are roughly in step.)
|
that both machine clocks are roughly in step.)
|
||||||
|
|
||||||
JSON API
|
JSON API
|
||||||
In addition to the web UI, hledger-web also serves a JSON API that can
|
In addition to the web UI, hledger-web also serves a JSON API that can
|
||||||
be used to get data or add new transactions. If you want the JSON API
|
be used to get data or add new transactions. If you want the JSON API
|
||||||
only, you can use the --serve-api flag. Eg:
|
only, you can use the --serve-api flag. Eg:
|
||||||
|
|
||||||
$ hledger-web -f examples/sample.journal --serve-api
|
$ hledger-web -f examples/sample.journal --serve-api
|
||||||
@ -282,7 +283,7 @@ JSON API
|
|||||||
/accounttransactions/ACCOUNTNAME
|
/accounttransactions/ACCOUNTNAME
|
||||||
|
|
||||||
Eg, all account names in the journal (similar to the accounts command).
|
Eg, all account names in the journal (similar to the accounts command).
|
||||||
(hledger-web's JSON does not include newlines, here we use python to
|
(hledger-web's JSON does not include newlines, here we use python to
|
||||||
prettify it):
|
prettify it):
|
||||||
|
|
||||||
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
|
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
|
||||||
@ -323,25 +324,25 @@ JSON API
|
|||||||
"aprice": null,
|
"aprice": null,
|
||||||
...
|
...
|
||||||
|
|
||||||
Most of the JSON corresponds to hledger's data types; for details of
|
Most of the JSON corresponds to hledger's data types; for details of
|
||||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||||
on the various data types, eg Transaction. And for a higher level un-
|
on the various data types, eg Transaction. And for a higher level un-
|
||||||
derstanding, see the journal docs.
|
derstanding, see the journal docs.
|
||||||
|
|
||||||
In some cases there is outer JSON corresponding to a "Report" type. To
|
In some cases there is outer JSON corresponding to a "Report" type. To
|
||||||
understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
||||||
at the source for the appropriate handler to see what it returns. Eg
|
at the source for the appropriate handler to see what it returns. Eg
|
||||||
for /accounttransactions it's getAccounttransactionsR, returning a "ac-
|
for /accounttransactions it's getAccounttransactionsR, returning a "ac-
|
||||||
countTransactionsReport ...". Looking up the haddock for that we can
|
countTransactionsReport ...". Looking up the haddock for that we can
|
||||||
see that /accounttransactions returns an AccountTransactionsReport,
|
see that /accounttransactions returns an AccountTransactionsReport,
|
||||||
which consists of a report title and a list of AccountTransactionsRe-
|
which consists of a report title and a list of AccountTransactionsRe-
|
||||||
portItem (etc).
|
portItem (etc).
|
||||||
|
|
||||||
You can add a new transaction to the journal with a PUT request to
|
You can add a new transaction to the journal with a PUT request to
|
||||||
/add, if hledger-web was started with the add capability (enabled by
|
/add, if hledger-web was started with the add capability (enabled by
|
||||||
default). The payload must be the full, exact JSON representation of a
|
default). The payload must be the full, exact JSON representation of a
|
||||||
hledger transaction (partial data won't do). You can get sample JSON
|
hledger transaction (partial data won't do). You can get sample JSON
|
||||||
from hledger-web's /transactions or /accounttransactions, or you can
|
from hledger-web's /transactions or /accounttransactions, or you can
|
||||||
export it with hledger-lib, eg like so:
|
export it with hledger-lib, eg like so:
|
||||||
|
|
||||||
.../hledger$ stack ghci hledger-lib
|
.../hledger$ stack ghci hledger-lib
|
||||||
@ -437,28 +438,28 @@ JSON API
|
|||||||
"tstatus": "Unmarked"
|
"tstatus": "Unmarked"
|
||||||
}
|
}
|
||||||
|
|
||||||
And here's how to test adding it with curl. This should add a new en-
|
And here's how to test adding it with curl. This should add a new en-
|
||||||
try to your journal:
|
try to your journal:
|
||||||
|
|
||||||
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
|
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
|
||||||
|
|
||||||
DEBUG OUTPUT
|
DEBUG OUTPUT
|
||||||
Debug output
|
Debug output
|
||||||
You can add --debug[=N] to the command line to log debug output. N
|
You can add --debug[=N] to the command line to log debug output. N
|
||||||
ranges from 1 (least output, the default) to 9 (maximum output). Typi-
|
ranges from 1 (least output, the default) to 9 (maximum output). Typi-
|
||||||
cally you would start with 1 and increase until you are seeing enough.
|
cally you would start with 1 and increase until you are seeing enough.
|
||||||
Debug output goes to stderr, interleaved with the requests logged on
|
Debug output goes to stderr, interleaved with the requests logged on
|
||||||
stdout. To capture debug output in a log file instead, you can usually
|
stdout. To capture debug output in a log file instead, you can usually
|
||||||
redirect stderr, eg:
|
redirect stderr, eg:
|
||||||
hledger-web --debug=3 2>hledger-web.log.
|
hledger-web --debug=3 2>hledger-web.log.
|
||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
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.
|
-f/--file. Default: $HOME/.hledger.journal.
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
We welcome bug reports in the hledger issue tracker (shortcut:
|
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).
|
(https://hledger.org/support).
|
||||||
|
|
||||||
Some known issues:
|
Some known issues:
|
||||||
|
|||||||
@ -5,7 +5,8 @@
|
|||||||
|
|
||||||
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
hledger \- robust, friendly plain text accounting (CLI version)
|
hledger \- a robust, friendly plain text accounting app (command line
|
||||||
|
version).
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
\f[CR]hledger\f[R]
|
\f[CR]hledger\f[R]
|
||||||
.PD 0
|
.PD 0
|
||||||
@ -7837,8 +7838,7 @@ Runs hledger\-ui (if installed).
|
|||||||
Runs hledger\-web (if installed).
|
Runs hledger\-web (if installed).
|
||||||
.SH Data entry commands
|
.SH Data entry commands
|
||||||
.SS add
|
.SS add
|
||||||
Prompt for transactions and add them to the journal.
|
Record new transactions with interactive prompting in the console.
|
||||||
Any arguments will be used as default inputs for the first N prompts.
|
|
||||||
.PP
|
.PP
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV.
|
generate them from CSV.
|
||||||
@ -7914,21 +7914,21 @@ Provide answers for the first four prompts:
|
|||||||
.PP
|
.PP
|
||||||
There is a detailed tutorial at https://hledger.org/add.html.
|
There is a detailed tutorial at https://hledger.org/add.html.
|
||||||
.SS import
|
.SS import
|
||||||
Read new transactions added to each FILE provided as arguments since
|
Import new transactions from one or more data files to the main journal.
|
||||||
last run, and add them to the journal.
|
.PP
|
||||||
Or with \-\-dry\-run, just print the transactions that would be added.
|
This command detects new transactions in each FILE argument since it was
|
||||||
Or with \-\-catchup, just mark all of the FILEs\[aq] current
|
last run, and appends them to the main journal.
|
||||||
transactions as imported, without importing them.
|
.PP
|
||||||
|
Or with \f[CR]\-\-dry\-run\f[R], it just print the transactions that
|
||||||
|
would be added.
|
||||||
|
.PP
|
||||||
|
Or with \f[CR]\-\-catchup\f[R], it just marks all of the FILEs\[aq]
|
||||||
|
current transactions as already imported.
|
||||||
.PP
|
.PP
|
||||||
This command may append new transactions to the main journal file (which
|
|
||||||
should be in journal format).
|
|
||||||
Existing transactions are not changed.
|
|
||||||
This is one of the few hledger commands that writes to the journal file
|
This is one of the few hledger commands that writes to the journal file
|
||||||
(see also \f[CR]add\f[R]).
|
(see also \f[CR]add\f[R]).
|
||||||
|
It only appends; existing data will not be changed.
|
||||||
.PP
|
.PP
|
||||||
Unlike other hledger commands, with \f[CR]import\f[R] the journal file
|
|
||||||
is an output file, and will be modified, though only by appending
|
|
||||||
(existing data will not be changed).
|
|
||||||
The input files are specified as arguments, so to import one or more CSV
|
The input files are specified as arguments, so to import one or more CSV
|
||||||
files to your main journal, you will run
|
files to your main journal, you will run
|
||||||
\f[CR]hledger import bank.csv\f[R] or perhaps
|
\f[CR]hledger import bank.csv\f[R] or perhaps
|
||||||
@ -7936,6 +7936,7 @@ files to your main journal, you will run
|
|||||||
.PP
|
.PP
|
||||||
Note you can import from any file format, though CSV files are the most
|
Note you can import from any file format, though CSV files are the most
|
||||||
common import source, and these docs focus on that case.
|
common import source, and these docs focus on that case.
|
||||||
|
The target file (main journal) should be in journal format.
|
||||||
.SS Date skipping
|
.SS Date skipping
|
||||||
\f[CR]import\f[R] tries to import only the transactions which are new
|
\f[CR]import\f[R] tries to import only the transactions which are new
|
||||||
since the last import, ignoring any that it has seen in previous runs.
|
since the last import, ignoring any that it has seen in previous runs.
|
||||||
@ -8057,7 +8058,7 @@ amounts.
|
|||||||
Related: CSV > Amount decimal places.
|
Related: CSV > Amount decimal places.
|
||||||
.SH Basic report commands
|
.SH Basic report commands
|
||||||
.SS accounts
|
.SS accounts
|
||||||
Show account names.
|
List account names.
|
||||||
.PP
|
.PP
|
||||||
This command lists account names.
|
This command lists account names.
|
||||||
By default it shows all known accounts, either used in transactions or
|
By default it shows all known accounts, either used in transactions or
|
||||||
@ -8319,7 +8320,7 @@ also acquire tags from their account and transaction, transactions also
|
|||||||
acquire tags from their postings.
|
acquire tags from their postings.
|
||||||
.SH Standard report commands
|
.SH Standard report commands
|
||||||
.SS print
|
.SS print
|
||||||
Show transaction journal entries, sorted by date.
|
Show full journal entries, representing transactions.
|
||||||
.PP
|
.PP
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file, sorted by date (or with \f[CR]\-\-date2\f[R], by secondary
|
journal file, sorted by date (or with \f[CR]\-\-date2\f[R], by secondary
|
||||||
@ -8511,8 +8512,8 @@ negative amounts under credit and zero or greater amounts under debit.)
|
|||||||
.SS aregister
|
.SS aregister
|
||||||
(areg)
|
(areg)
|
||||||
.PP
|
.PP
|
||||||
Show the transactions and running historical balance of a single
|
Show the transactions and running balances in one account, with each
|
||||||
account, with each transaction displayed as one line.
|
transaction on one line.
|
||||||
.PP
|
.PP
|
||||||
\f[CR]aregister\f[R] shows the overall transactions affecting a
|
\f[CR]aregister\f[R] shows the overall transactions affecting a
|
||||||
particular account (and any subaccounts).
|
particular account (and any subaccounts).
|
||||||
@ -8753,14 +8754,16 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
|
|||||||
.SS balancesheet
|
.SS balancesheet
|
||||||
(bs)
|
(bs)
|
||||||
.PP
|
.PP
|
||||||
This command displays a balance sheet, showing historical ending
|
Show the end balances in asset and liability accounts.
|
||||||
balances of asset and liability accounts.
|
|
||||||
(To see equity as well, use the balancesheetequity command.)
|
|
||||||
Amounts are shown with normal positive sign, as in conventional
|
Amounts are shown with normal positive sign, as in conventional
|
||||||
financial statements.
|
financial statements.
|
||||||
.PP
|
.PP
|
||||||
This report shows accounts declared with the \f[CR]Asset\f[R],
|
This command displays a balance sheet, showing historical ending
|
||||||
\f[CR]Cash\f[R] or \f[CR]Liability\f[R] type (see account types).
|
balances of asset and liability accounts.
|
||||||
|
(To see equity as well, use the balancesheetequity command.)
|
||||||
|
.PP
|
||||||
|
Accounts declared with the \f[CR]Asset\f[R], \f[CR]Cash\f[R] or
|
||||||
|
\f[CR]Liability\f[R] type are shown (see account types).
|
||||||
Or if no such accounts are declared, it shows top\-level accounts named
|
Or if no such accounts are declared, it shows top\-level accounts named
|
||||||
\f[CR]asset\f[R] or \f[CR]liability\f[R] (case insensitive, plurals
|
\f[CR]asset\f[R] or \f[CR]liability\f[R] (case insensitive, plurals
|
||||||
allowed) and their subaccounts.
|
allowed) and their subaccounts.
|
||||||
@ -8916,12 +8919,14 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
|
|||||||
.SS incomestatement
|
.SS incomestatement
|
||||||
(is)
|
(is)
|
||||||
.PP
|
.PP
|
||||||
This command displays an income statement, showing revenues and expenses
|
Show revenue inflows and expense outflows during the report period.
|
||||||
during one or more periods.
|
|
||||||
Amounts are shown with normal positive sign, as in conventional
|
Amounts are shown with normal positive sign, as in conventional
|
||||||
financial statements.
|
financial statements.
|
||||||
.PP
|
.PP
|
||||||
This report shows accounts declared with the \f[CR]Revenue\f[R] or
|
This command displays an income statement, showing revenues and expenses
|
||||||
|
during one or more periods.
|
||||||
|
.PP
|
||||||
|
It shows accounts declared with the \f[CR]Revenue\f[R] or
|
||||||
\f[CR]Expense\f[R] type (see account types).
|
\f[CR]Expense\f[R] type (see account types).
|
||||||
Or if no such accounts are declared, it shows top\-level accounts named
|
Or if no such accounts are declared, it shows top\-level accounts named
|
||||||
\f[CR]revenue\f[R] or \f[CR]income\f[R] or \f[CR]expense\f[R] (case
|
\f[CR]revenue\f[R] or \f[CR]income\f[R] or \f[CR]expense\f[R] (case
|
||||||
@ -8968,7 +8973,10 @@ options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R],
|
|||||||
.SS balance
|
.SS balance
|
||||||
(bal)
|
(bal)
|
||||||
.PP
|
.PP
|
||||||
Show accounts and their balances.
|
A flexible, general purpose \[dq]summing\[dq] report that shows accounts
|
||||||
|
with some kind of numeric data.
|
||||||
|
This can be balance changes per period, end balances, budget
|
||||||
|
performance, unrealised capital gains, etc.
|
||||||
.PP
|
.PP
|
||||||
\f[CR]balance\f[R] is one of hledger\[aq]s oldest and most versatile
|
\f[CR]balance\f[R] is one of hledger\[aq]s oldest and most versatile
|
||||||
commands, for listing account balances, balance changes, values, value
|
commands, for listing account balances, balance changes, values, value
|
||||||
|
|||||||
1442
hledger/hledger.info
1442
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
3517
hledger/hledger.txt
3517
hledger/hledger.txt
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user