77 lines
1.5 KiB
Markdown
77 lines
1.5 KiB
Markdown
% hledger-api(1) hledger-api _version_
|
|
% _author_
|
|
% _monthyear_
|
|
|
|
_web_({{
|
|
m4_dnl _versions_({{hledger-api}})
|
|
<div class="versions">
|
|
version:
|
|
<a href="$1.html">dev</a>
|
|
</div>
|
|
_toc_
|
|
}})
|
|
|
|
_man_({{
|
|
# NAME
|
|
|
|
hledger-api - web API server for the hledger accounting tool
|
|
|
|
# SYNOPSIS
|
|
|
|
`hledger-api [OPTIONS]`\
|
|
`hledger-api --swagger`\
|
|
`hledger api -- [OPTIONS]`
|
|
|
|
# DESCRIPTION
|
|
|
|
_hledgerdescription_
|
|
}})
|
|
|
|
hledger-api is a simple web API server, intended to support
|
|
client-side web apps operating on hledger data. It comes with a series
|
|
of simple client-side app examples, which drive it's evolution.
|
|
|
|
Like hledger, it reads _files_
|
|
For more about this see hledger(1), hledger_journal(5) etc.
|
|
|
|
The server listens on port 8001, or another specified with `-p PORT`.
|
|
Note there is no built-in access control, so you will need to hide
|
|
hledger-api behind an authenticating proxy if you want to restrict
|
|
access.
|
|
|
|
If invoked as `hledger-api --swagger`, instead of starting a server
|
|
the API docs will be printed in Swagger 2.0 format.
|
|
|
|
# OPTIONS
|
|
|
|
Note: if invoking hledger-api as a hledger subcommand, write `--` before options as shown above.
|
|
|
|
`-d --static-dir=DIR`
|
|
: serve files from a different directory (default: `.`)
|
|
|
|
`-p --port=PORT`
|
|
: use a different TCP port (default: 8001)
|
|
|
|
`--swagger`
|
|
: print API docs in Swagger 2.0 format, and exit
|
|
|
|
hledger general options:
|
|
|
|
_generaloptions_
|
|
|
|
_man_({{
|
|
|
|
# ENVIRONMENT
|
|
|
|
_LEDGER_FILE_
|
|
|
|
# FILES
|
|
|
|
Reads _files_
|
|
|
|
# BUGS
|
|
|
|
The need to precede options with `--` when invoked from hledger is awkward.
|
|
|
|
}})
|