hledger/site/docs.md
2016-03-09 07:16:04 -08:00

2.1 KiB

Documentation

## Getting started

Download

How to get hledger installed.

Step by Step tutorial

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

Frequently Asked Questions

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

More docs

A useful collection of links, eg on accounting, being moved to:

plaintextaccounting.org

A comprehensive survey of our larger community and common practices

## Reference

User Manual

The comprehensive manual, all on one page.

Tools

Here is the same manual (more or less) 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)

hledger's 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.