2016-02-21 23:39:32 +03:00
< style >
2017-04-28 00:18:18 +03:00
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; }
2016-02-21 23:39:32 +03:00
< / style >
2017-04-28 00:18:18 +03:00
# User guide
2016-02-21 23:39:32 +03:00
< div class = "container" >
2017-04-28 00:18:18 +03:00
## Get help
|
|---------------|----------------------------------------------------------------------------|
| 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 ) -->
2016-02-21 23:39:32 +03:00
< div class = "row" >
2016-04-08 17:03:23 +03:00
< div class = "col-sm-3" >
2017-04-28 00:18:18 +03:00
## Get started
2016-04-08 17:03:23 +03:00
2017-04-28 00:18:18 +03:00
### [Home](index.html)
What is hledger ?
2016-02-21 23:39:32 +03:00
2017-04-28 00:18:18 +03:00
### [Download](download.html)
How to get it, and [release notes ](release-notes.html ).
2016-02-21 23:39:32 +03:00
2017-04-28 00:18:18 +03:00
### [Step by Step Tutorial](step-by-step.html)
2016-02-21 23:39:32 +03:00
Small, guided exercises introducing data entry, reporting, and accounting.
2017-04-28 00:18:18 +03:00
### [FAQ](faq.html)
Some frequently asked questions.
### [plaintextaccounting.org](http://plaintextaccounting.org)
More background, tips and tools from the plaintext accounting community.
### [Misc. links](more-docs.html)
Some learning resources not yet moved to the above.
2016-04-08 17:03:23 +03:00
2017-04-28 00:18:18 +03:00
< / div >
< div class = "col-sm-3" >
2016-02-21 23:39:32 +03:00
2017-04-28 00:18:18 +03:00
## Get things done
2017-01-26 17:40:50 +03:00
2017-04-28 00:18:18 +03:00
### [The Cookbook](cookbook.html)
Practical recipes and examples, including:
< div style = "padding-left:0em;" >
[Start a journal ](start-journal.html )\
[Track changes with version control ](version-control.html )\
[Example journal entries ](entries.html )\
[Convert CSV files ](csv-import.html )\
[Rewrite account names ](account-aliases.html )\
[Use another account separator character ](account-separator.html )\
[Track investments ](investments.html )\
2017-01-26 17:40:50 +03:00
2017-04-28 00:18:18 +03:00
< / div >
2017-01-26 17:59:53 +03:00
2016-04-08 17:03:23 +03:00
< / div >
2016-04-11 04:20:55 +03:00
< div class = "col-sm-3" >
2016-02-21 23:39:32 +03:00
2017-04-28 00:18:18 +03:00
## Get the details
2016-02-21 23:39:32 +03:00
2017-04-28 00:18:18 +03:00
### [Manuals](manual.html)
The full reference guide. Includes:
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
< div style = "padding-left:0em;" >
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**Tools**
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**[`hledger`](hledger.html)**\
2017-01-26 17:40:50 +03:00
The command-line UI
, for flexibility and automation.
2016-05-28 18:52:23 +03:00
2017-01-26 17:59:53 +03:00
**[`hledger-ui`](hledger-ui.html)**\
2016-05-28 18:52:23 +03:00
A curses-style UI
2017-01-05 04:30:23 +03:00
, for quick review and monitoring.
2016-05-28 18:52:23 +03:00
2017-01-26 17:59:53 +03:00
**[`hledger-web`](hledger-web.html)**\
2016-05-28 18:52:23 +03:00
A web UI
2017-01-05 04:30:23 +03:00
, for browsing, sharing, and collaboration.
2016-05-28 18:52:23 +03:00
2017-01-26 17:59:53 +03:00
**[`hledger-api`](hledger-api.html)**\
2016-05-28 18:52:23 +03:00
A basic web API
, for building client-side apps.
2017-01-26 17:59:53 +03:00
**File formats**
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**[Journal](journal.html)**\
2017-01-08 22:00:26 +03:00
hledger's native data format, representing an accounting journal.
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**[CSV](csv.html)**\
2017-01-08 22:00:26 +03:00
Comma Separated Values, used for import/export.
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**[Timeclock](timeclock.html)**\
2017-01-08 22:00:26 +03:00
For time logging, with clock-in/clock-out records.
2016-02-21 23:39:32 +03:00
2017-01-26 17:59:53 +03:00
**[Timedot](timedot.html)**\
2017-01-05 04:30:23 +03:00
A more human-friendly time logging format.
< / div >
2016-04-11 04:20:55 +03:00
2017-04-28 00:18:18 +03:00
< / div > <!-- col -->
2016-04-08 17:03:23 +03:00
2017-04-28 00:18:18 +03:00
< / div > <!-- row -->
< / div > <!-- container -->
2016-04-08 17:03:23 +03:00