179 lines
5.8 KiB
Markdown
179 lines
5.8 KiB
Markdown
# hledger docs
|
|
|
|
<style>
|
|
h2 { font-size:x-large; margin-top:0.5em; }
|
|
h3 { font-size:large; margin-bottom:0.2em; }
|
|
tr { border-top:thin solid #bbb; border-bottom:thin solid #bbb; vertical-align:top; }
|
|
td:nth-child(1) { padding-right:1em; white-space:nowrap; }
|
|
</style>
|
|
|
|
<div class="container">
|
|
|
|
hledger-specific docs are collected here.
|
|
For more docs relevant to all ledger-likes, see [plaintextaccounting.org](http://plaintextaccounting.org).
|
|
|
|
## Help/feedback
|
|
|
|
|
|---------------|----------------------------------------------------------------------------|
|
|
| IRC | [#hledger](http://irc.hledger.org) on Freenode (<!-- [chat log](http://ircbrowse.net/browse/hledger); --> see also [#ledger](http://webchat.freenode.net?channels=ledger&randomnick=1)) <!-- *Quick help and background chat.* --> <!-- *If you don't get an answer promptly, you can type `sm` to alert me, or leave the window open and check back later.* -->
|
|
| Twitter | [#hledger](https://twitter.com/search?q=%23hledger&src=typd&f=realtime) hashtag (see also [#plaintextaccounting](https://twitter.com/search?q=%23plaintextaccounting&src=typd&f=realtime), <a href="https://twitter.com/ledgertips">@LedgerTips</a>) <!-- *Social!* -->
|
|
| Mail list | [mail.hledger.org](http://mail.hledger.org) <!-- *Slightly less quick, more eyeballs.* -->
|
|
| Issue tracker | [bugs.hledger.org](http://bugs.hledger.org) (just the bugs), [issues.hledger.org](http://issues.hledger.org) (all issues). <!-- *Always check here.* --> <!-- *Bug reports are welcome.* -->
|
|
<!-- | hledger-web demo | [demo.hledger.org](http://demo.hledger.org) -->
|
|
<!-- | hledger-web on Sandstorm | [hledger-web app](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90), [issues](https://github.com/simonmichael/hledger/issues?utf8=✓&q=label%3A%22platform%3A%20sandstorm%22%20) -->
|
|
<!-- | hledger-api demo | <\!-- [demo.hledger.org/api](http://demo.hledger.org/api/swagger.json), -\-> [in swagger editor](http://editor.swagger.io/#/?import=demo.hledger.org/api/swagger.json&no-proxy) -->
|
|
|
|
<div class="row">
|
|
|
|
<div class="col-sm-3">
|
|
|
|
## Introduction
|
|
|
|
### What is hledger?
|
|
An enhanced, well-documented rewrite of the original plain text accounting tool.\
|
|
[hledger intro](http://hledger.org)\
|
|
[Frequently Asked Questions](faq.html)\
|
|
[Download](download.html)\
|
|
[Release notes](release-notes.html)\
|
|
|
|
|
|
### What is Plain Text Accounting?
|
|
Using plain text data formats and modular free software tools for robust, efficient accounting.\
|
|
[plaintextaccounting.org](http://plaintextaccounting.org)\
|
|
|
|
|
|
### What is Accounting?
|
|
Tracking your use of valuable commodities, such as money or time, for increased awareness and effectiveness.\
|
|
[Selected accounting links](more-docs.html#accounting)\
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="col-sm-3">
|
|
|
|
## [Guide](guide.html){title="all on one page"}
|
|
|
|
A growing collection of tutorials, how-tos and discussion of general topics.
|
|
(Please help complete this!)
|
|
|
|
### Getting started
|
|
|
|
[hledger Step by Step](step-by-step.html) tutorial\
|
|
|
|
|
|
### Journal management
|
|
|
|
[Start a journal](start-journal.html)\
|
|
[Track changes with version control](version-control.html)\
|
|
|
|
|
|
### Account names
|
|
|
|
[PTA: choosing accounts](http://plaintextaccounting.org/#choosing-accounts)\
|
|
[Rewrite account names](account-aliases.html)\
|
|
[Use another account separator character](account-separator.html)\
|
|
|
|
|
|
### Journal entries
|
|
|
|
[Basic journal entries](entries.html)\
|
|
[Project accounting](project-accounting.html)\
|
|
|
|
|
|
### Data entry/import
|
|
|
|
[Convert CSV files](csv-import.html)\
|
|
|
|
|
|
### Investing
|
|
|
|
[Track investments](investments.html)\
|
|
|
|
|
|
### More..
|
|
|
|
[Save frequently used options](argfiles.html)\
|
|
[PTA: Common tasks](http://plaintextaccounting.org/#common-tasks)\
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="col-sm-3">
|
|
|
|
## [Reference](manual.html){title="all on one page"}
|
|
|
|
Reference manuals, covering every part of hledger's functionality.
|
|
|
|
### Core tools
|
|
|
|
[hledger](hledger.html)
|
|
is the command-line UI
|
|
|
|
[hledger-ui](hledger-ui.html)
|
|
is a curses-style UI
|
|
|
|
[hledger-web](hledger-web.html)
|
|
is a web UI
|
|
|
|
[hledger-api](hledger-api.html)
|
|
is a HTTP-JSON API
|
|
|
|
### File formats
|
|
|
|
[journal format](journal.html)
|
|
is hledger's native data format, representing an accounting journal
|
|
|
|
[csv format](csv.html)
|
|
allows hledger to read and write CSV, a common download format
|
|
|
|
[timeclock format](timeclock.html)
|
|
is for precise time logging with clock-in/clock-out
|
|
|
|
[timedot format](timedot.html)
|
|
is for human-friendly approximate time logging
|
|
|
|
### Addon tools
|
|
|
|
(cf [download -> D](download.html#d))
|
|
|
|
[hledger-diff](http://hackage.haskell.org/package/hledger-diff)
|
|
shows differences in an account's transactions between one journal file and another.
|
|
|
|
[hledger-iadd](http://hackage.haskell.org/package/hledger-iadd)
|
|
is a curses-style replacement for hledger's add command.
|
|
|
|
[hledger-interest](http://hackage.haskell.org/package/hledger-interest)
|
|
generates interest transactions for an account according to various schemes.
|
|
|
|
[hledger-irr](http://hackage.haskell.org/package/hledger-irr)
|
|
calculates the internal rate of return of an investment account.
|
|
|
|
Some experimental tools:
|
|
|
|
[hledger-budget.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-budget.hs#L10)
|
|
adds Ledger-style periodic transactions and budget reports.
|
|
|
|
[hledger-check.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check.hs)
|
|
checks more powerful account balance assertions.
|
|
|
|
Also:
|
|
|
|
[ledger-autosync](https://pypi.python.org/pypi/ledger-autosync),
|
|
can download, deduplicate and/or convert OFX data (includes hledger support,
|
|
rename/symlink it to hledger-autosync to see it in commands list)
|
|
|
|
[PTA: related tools](http://plaintextaccounting.org/#related-tools)
|
|
lists all known plain text accounting helper tools
|
|
|
|
|
|
</div> <!-- col -->
|
|
|
|
</div> <!-- row -->
|
|
</div> <!-- container -->
|
|
|
|
<!-- For more docs relevant to all ledger-likes, see also [plaintextaccounting.org](http://plaintextaccounting.org) -->
|
|
|