ledger-rest

ledger-rest

REST web service API to access the Ledger command-line interface (ledger-cli.org).

Ledger is a powerful, double-entry accounting system that is accessed from the UNIX command-line.

Dependencies

• Ledger 3
• Node.js and npm

Installing Ledger

The simplest way to install Ledger 3 is through Homebrew.

brew install ledger --HEAD

The --HEAD option is required to install version 3.x.

Usage

Install ledger-rest and its dependencies with npm.

npm install ledger-rest

Use the LedgerRest class to create a RESTful server.

LedgerRest = require('ledger-rest').LedgerRest;

var server = new LedgerRest({ file: 'path/to/ledger/journal/file.dat' });
server.listen(3000);

Or use the command line runner to start a server listening on the given port and serving a single Ledger .dat file.

ledger-rest -p <port> -f path/to/ledger/journal/file.dat