hledger/site/docs.md
2016-04-05 16:39:58 -07:00

2.2 KiB
Raw Blame History

Documentation

Intro

Download

How to get hledger installed.

Step by Step Tutorial

Small, guided exercises introducing data entry, reporting, and accounting.

FAQ

Some questions and answers, mostly comparing hledger and Ledger.

Examples:

How to read CSV files

An example of converting bank data.

How to use account aliases

Aliases for account name rewriting.

How to use another account separator character

Writing some.sub.account instead of some:sub:account.

General info:

plaintextaccounting.org

A comprehensive collection common resources and practices from the plain text accounting community

More docs

A few more useful links, eg on accounting, not yet moved to the above

Reference

User Manual

The hledger reference manual, all on one page.

Or, here is more or less the same manual organized as unix man pages (work in progress):

hledger(1)

The main reporting tool and command-line interface.

hledger-ui(1)

A curses-style UI for quick exploration.

hledger-web(1)

A web UI for browsing and data entry, personal or shared.

hledger-api(1)

A REST-y JSON and file server, good for building client-side UIs.

File formats:

hledger_journal(5)

hledgers primary data format, representing a general journal.

hledger_csv(5)

How hledger reads Comma Separated Value data.

hledger_timelog(5)

Timeclock format, a sequence of clock-in/clock-out records.

hledger_timedot(5)

Timedot format, an alternative time logging format.