mirror of https://github.com/simonmichael/hledger.git synced 2025-01-08 03:40:17 +03:00

Simon Michael f21e9d1c25 doc: more deduplication of options help

Help for reporting options is now also defined once in lib.m4
(in addition to CliOptions.hs). Also fixed some duplication of general
options in docs. hledger-* manuals now include the full list of general
and reporting options; we assume that any inapplicable options get
harmlessly ignored and that this will not surprise users.

2016-06-03 09:38:06 -07:00

2.5 KiB

Raw Blame History

% hledger-api(1) hledger-api version % author % monthyear

web({{ m4_dnl versions({{hledger-api}})

version: dev

_toc_ }}) _man_({{

NAME

hledger-api - web API server for the hledger accounting tool

SYNOPSIS

hledger-api [OPTIONS]
hledger-api --swagger
hledger api -- [OPTIONS]

DESCRIPTION

hledger is a cross-platform program for tracking money, time, or any other commodity, using double-entry accounting and a simple, editable file format. hledger is inspired by and largely compatible with ledger(1).

}})

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.

Data is served from the usual hledger journal file: ~/.hledger.journal, $LEDGER_FILE, or another file specified with -f. For more about the format, see hledger(1) or hledger_journal(5).

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 sets the default journal file path. If not set, it is ~/.hledger.journal.

FILES

Reads data from a hledger journal file ($LEDGER_FILE or ~/.hledger.journal by default), or a CSV file plus associated CSV rules file.

BUGS

The need to precede options with -- when invoked from hledger is awkward.

}})

2.5 KiB Raw Blame History