summaryrefslogtreecommitdiff
path: root/hledger-web.txt
diff options
context:
space:
mode:
Diffstat (limited to 'hledger-web.txt')
-rw-r--r--hledger-web.txt158
1 files changed, 86 insertions, 72 deletions
diff --git a/hledger-web.txt b/hledger-web.txt
index f6e59ae..2836cbe 100644
--- a/hledger-web.txt
+++ b/hledger-web.txt
@@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME
hledger-web is a web interface (WUI) for the hledger accounting tool.
- This manual is for hledger-web 1.22.2.
+ This manual is for hledger-web 1.23.
SYNOPSIS
hledger-web [OPTIONS]
@@ -145,6 +145,10 @@ OPTIONS
match the secondary date instead (see command help for other
effects)
+ --today=DATE
+ override today's date (affects relative smart dates, for
+ tests/examples)
+
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
@@ -161,34 +165,38 @@ OPTIONS
hide/aggregate accounts or postings more than NUM levels deep
-E --empty
- show items with zero amount, normally hidden (and vice-versa in
+ show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
-B --cost
convert amounts to their cost/selling amount at transaction time
-V --market
- convert amounts to their market value in default valuation com-
+ convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
- convert amounts to cost or market value, more flexibly than
+ convert amounts to cost or market value, more flexibly than
-B/-V/-X
--infer-market-prices
- use transaction prices (recorded with @ or @@) as additional
+ use transaction prices (recorded with @ or @@) as additional
market prices, as if they were P directives
--auto apply automated posting rules to modify transactions.
--forecast
- generate future transactions from periodic transaction rules,
- for the next 6 months or till report end date. In hledger-ui,
+ generate future transactions from periodic transaction rules,
+ for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
+ --commodity-style
+ Override the commodity style in the output for the specified
+ commodity. For example 'EUR1.000,00'.
+
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-
@@ -196,6 +204,12 @@ OPTIONS
piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
+ --pretty[=WHEN]
+ Show prettier output, e.g. using unicode box-drawing charac-
+ ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
+ 'never' also work). If you provide an argument you must use
+ '=', e.g. '--pretty=yes'.
+
When a reporting option appears more than once in the command line, the
last one takes precedence.
@@ -217,54 +231,54 @@ OPTIONS
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should
- contain one command line option/argument per line. (To prevent this,
+ contain one command line option/argument per line. (To prevent this,
insert a -- argument before.)
By default, hledger-web starts the web app in "transient mode" and also
opens it in your default web browser if possible. In this mode the web
app will keep running for as long as you have it open in a browser win-
- dow, and will exit after two minutes of inactivity (no requests and no
- browser windows viewing it). With --serve, it just runs the web app
- without exiting, and logs requests to the console. With --serve-api,
- only the JSON web api (see below) is served, with the usual HTML
+ dow, and will exit after two minutes of inactivity (no requests and no
+ browser windows viewing it). With --serve, it just runs the web app
+ without exiting, and logs requests to the console. With --serve-api,
+ only the JSON web api (see below) is served, with the usual HTML
server-side web UI disabled.
- By default the server listens on IP address 127.0.0.1, accessible only
- to local requests. You can use --host to change this, eg --host
+ By default the server listens on IP address 127.0.0.1, accessible only
+ to local requests. You can use --host to change this, eg --host
0.0.0.0 to listen on all configured addresses.
- Similarly, use --port to set a TCP port other than 5000, eg if you are
+ Similarly, use --port to set a TCP port other than 5000, eg if you are
running multiple hledger-web instances.
Both of these options are ignored when --socket is used. In this case,
- it creates an AF_UNIX socket file at the supplied path and uses that
- for communication. This is an alternative way of running multiple
- hledger-web instances behind a reverse proxy that handles authentica-
- tion for different users. The path can be derived in a predictable
+ it creates an AF_UNIX socket file at the supplied path and uses that
+ for communication. This is an alternative way of running multiple
+ hledger-web instances behind a reverse proxy that handles authentica-
+ tion for different users. The path can be derived in a predictable
way, eg by using the username within the path. As an example, nginx as
- reverse proxy can use the variable $remote_user to derive a path from
- the username used in a HTTP basic authentication. The following
- proxy_pass directive allows access to all hledger-web instances that
+ reverse proxy can use the variable $remote_user to derive a path from
+ the username used in a HTTP basic authentication. The following
+ proxy_pass directive allows access to all hledger-web instances that
created a socket in /tmp/hledger/:
proxy_pass http://unix:/tmp/hledger/${remote_user}.socket;
- 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 hyperlinks, useful eg for integrating hledger-web within
- a larger website. The default is http://HOST:PORT/ using the server's
+ a larger website. The default is http://HOST:PORT/ using the server's
configured host address and TCP port (or http://HOST if PORT is 80).
- With --file-url you can set a different base url for static files, eg
+ With --file-url you can set a different base url for static files, eg
for better caching or cookie-less serving on high performance websites.
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.
You can restrict who can reach it by
- 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
+ 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
machine.
o putting it behind an authenticating proxy, using eg apache or nginx
@@ -274,53 +288,53 @@ PERMISSIONS
You can restrict what the users who reach it can do, by
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:
o view - allows viewing the journal file and all included files
o add - allows adding new transactions to the main journal file
- o manage - allows editing, uploading or downloading the main or
+ o manage - allows editing, uploading or downloading the main or
included files
- o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
- header from which it will read capabilities to enable. hledger-web
- on Sandstorm uses the X-Sandstorm-Permissions header to integrate
+ o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
+ header from which it will read capabilities to enable. hledger-web
+ on Sandstorm uses the X-Sandstorm-Permissions header to integrate
with Sandstorm's permissions. This is disabled by default.
EDITING, UPLOADING, DOWNLOADING
- 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
- let you edit, upload, or download the journal file or any files it
+ 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
+ let you edit, upload, or download the journal file or any files it
includes.
- 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.
- Normally whenever a file is changed in this way, hledger-web saves a
- numbered backup (assuming file permissions allow it, the disk is not
- 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
+ Normally whenever a file is changed in this way, hledger-web saves a
+ numbered backup (assuming file permissions allow it, the disk is not
+ 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
yourself (eg with a cron job or a file watcher like entr).
- Changes which would leave the journal file(s) unparseable or non-valid
- (eg with failing balance assertions) are prevented. (Probably. This
+ Changes which would leave the journal file(s) unparseable or non-valid
+ (eg with failing balance assertions) are prevented. (Probably. This
needs re-testing.)
RELOADING
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
- 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
+ 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
+ makes a file unparseable, hledger-web will display an error message
until the file has been fixed.
(Note: if you are viewing files mounted from another machine, make sure
that both machine clocks are roughly in step.)
JSON API
- 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
+ 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
only, you can use the --serve-api flag. Eg:
$ hledger-web -f examples/sample.journal --serve-api
@@ -337,7 +351,7 @@ JSON API
/accounttransactions/ACCOUNTNAME
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):
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
@@ -378,25 +392,25 @@ JSON API
"aprice": null,
...
- 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
- on the various data types, eg Transaction. And for a higher level
+ 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
+ on the various data types, eg Transaction. And for a higher level
understanding, see the journal manual.
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
- at the source for the appropriate handler to see what it returns. Eg
+ 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
for /accounttransactions it's getAccounttransactionsR, returning a
- "accountTransactionsReport ...". Looking up the haddock for that we
+ "accountTransactionsReport ...". Looking up the haddock for that we
can 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).
- 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
+ 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
default). The payload must be the full, exact JSON representation of a
- hledger transaction (partial data won't do). You can get sample JSON
- from hledger-web's /transactions or /accounttransactions, or you can
+ hledger transaction (partial data won't do). You can get sample JSON
+ from hledger-web's /transactions or /accounttransactions, or you can
export it with hledger-lib, eg like so:
.../hledger$ stack ghci hledger-lib
@@ -492,23 +506,23 @@ JSON API
"tstatus": "Unmarked"
}
- And here's how to test adding it with curl. This should add a new
+ And here's how to test adding it with curl. This should add a new
entry to your journal:
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default:
- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
+ ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
- A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
- trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
+ A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
+ trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
rent.journal, where current.journal is a symbolic link to YYYY.journal.
On Mac computers, you can set this and other environment variables in a
- more thorough way that also affects applications started from the GUI
- (say, an Emacs dock icon). Eg on MacOS Catalina I have a
+ more thorough way that also affects applications started from the GUI
+ (say, an Emacs dock icon). Eg on MacOS Catalina I have a
~/.MacOSX/environment.plist file containing
{
@@ -518,13 +532,13 @@ ENVIRONMENT
To see the effect you may need to killall Dock, or reboot.
FILES
- Reads data from one or more files in hledger journal, timeclock, time-
- dot, or CSV format specified with -f, or $LEDGER_FILE, or
- $HOME/.hledger.journal (on windows, perhaps
+ Reads data from one or more files in hledger journal, timeclock, time-
+ dot, or CSV format specified with -f, or $LEDGER_FILE, or
+ $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
- The need to precede options with -- when invoked from hledger is awk-
+ The need to precede options with -- when invoked from hledger is awk-
ward.
-f- doesn't work (hledger-web can't read from stdin).
@@ -538,7 +552,7 @@ BUGS
REPORTING BUGS
- Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
+ Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)
@@ -556,4 +570,4 @@ SEE ALSO
-hledger-web-1.22.2 August 2021 HLEDGER-WEB(1)
+hledger-web-1.23 September 2021 HLEDGER-WEB(1)