2 # ABSTRACT: A tool to convert HomeBank files to Ledger format
3 # PODNAME: homebank2ledger
7 homebank2ledger --input FILEPATH [--output FILEPATH] [--format FORMAT]
8 [--version|--help|--manual] [--account-width NUM]
9 [--accounts|--no-accounts] [--payees|--no-payees]
10 [--tags|--no-tags] [--commodities|--no-commodities]
12 [--rename-account STR]... [--exclude-account STR]...
16 C<homebank2ledger> converts L<HomeBank|http://homebank.free.fr/> files to a format usable by
17 L<Ledger|https://www.ledger-cli.org/>. It can also convert directly to the similar
18 L<Beancount|http://furius.ca/beancount/> format.
20 This software is B<EXPERIMENTAL>, in early development. Its interface may change without notice.
22 I wrote C<homebank2ledger> because I have been maintaining my own personal finances using HomeBank
23 (which is awesome) and I wanted to investigate using plain text accounting programs. It works well
24 enough for my data, but you may be using HomeBank features that I don't so there may be cases this
25 doesn't handle well or at all. Feel free to file a bug report. This script does NOT try to modify
26 the original HomeBank files it converts from, so there won't be any crazy data loss bugs... but no
32 * Converts HomeBank accounts and categories into a typical set of double-entry accounts.
33 * Retains HomeBank metadata, including payees and tags.
34 * Offers some customization of the output ledger, like account renaming.
36 This program is feature-complete in my opinion (well, almost -- see L</CAVEATS>), but if there is
37 anything you think it could do to be even better, feedback is welcome; just file a bug report. Or
38 fork the code and have fun!
42 You can migrate the data you have in HomeBank so you can start maintaining your accounts in Ledger
45 Or if you don't plan to switch completely off of HomeBank, you can continue to maintain your
46 accounts in HomeBank and use this script to also take advantage of the reports Ledger offers.
52 Print the version and exit.
58 Print help/usage info and exit.
64 Print the full manual and exit.
68 =head2 --input FILEPATH
70 Specify the path to the HomeBank file to read (must already exist).
72 Alias: C<--file>, C<-i>
74 =head2 --output FILEPATH
76 Specify the path to the Ledger file to write (may not exist yet). If not provided, the formatted
77 ledger will be printed on C<STDOUT>.
83 Specify the output file format. If provided, must be one of:
89 =head2 --account-width NUM
91 Specify the number of characters to reserve for the account column in transactions. Adjusting this
92 can provide prettier formatting of the output.
98 Enables account declarations.
100 Defaults to enabled; use C<--no-accounts> to disable.
104 Enables payee declarations.
106 Defaults to enabled; use C<--no-payees> to disable.
110 Enables tag declarations.
112 Defaults to enabled; use C<--no-tags> to disable.
116 Enables commodity declarations.
118 Defaults to enabled; use C<--no-commodities> to disable.
122 Enables budget transactions.
124 Budget transactions are only supported by the Ledger format (for now). This option is silently
127 Defaults to enabled; use C<--no-budget> to disable.
129 =head2 --opening-date DATE
131 Specify the opening date for the "opening balances" transaction. This transaction is created (if
132 needed) to support HomeBank's ability to configure accounts with opening balances.
134 Date must be in the form "YYYY-MM-DD". Defaults to the date of the first transaction.
136 =head2 --rename-account STR
138 Specifies a mapping for renaming accounts in the output. By default C<homebank2ledger> tries to come
139 up with sensible account names (based on your HomeBank accounts and categories) that fit into five
149 The value of the argument must be of the form "REGEXP=REPLACEMENT". See L</EXAMPLES>.
151 Can be repeated to rename multiple accounts.
153 =head2 --exclude-account STR
155 Specifies an account that will not be included in the output. All transactions related to this
156 account will be skipped.
158 Can be repeated to exclude multiple accounts.
164 # Convert homebank.xhb to a Ledger-compatible file:
165 homebank2ledger path/to/homebank.xhb -o ledger.dat
167 # Run the Ledger balance report:
168 ledger -f ledger.dat balance
170 You can also combine this into one command:
172 homebank2ledger path/to/homebank.xhb | ledger -f - balance
174 =head2 Account renaming
176 With the L</"--rename-account STR"> argument, you have some control over the resulting account
177 structure. This may be useful in cases where the organization imposed (or encouraged) by HomeBank
178 doesn't necessarily line up with an ideal double-entry structure.
180 homebank2ledger path/to/homebank.xhb -o ledger.dat \
181 --rename-account '^Assets:Credit Union Savings$=Assets:Bank:Credit Union:Savings' \
182 --rename-account '^Assets:Credit Union Checking$=Assets:Bank:Credit Union:Checking'
184 Multiple accounts can be renamed at the same time because the first part of the mapping is a regular
185 expression. The above example could be written like this:
187 homebank2ledger path/to/homebank.xhb -o ledger.dat \
188 --rename-account '^Assets:Credit Union =Assets:Bank:Credit Union:'
190 You can also merge accounts by simple renaming multiple accounts to the same name:
192 homebank2ledger path/to/homebank.xhb -o ledger.dat \
193 --rename-account '^Liabilities:Chase VISA$=Liabilities:All Credit Cards' \
194 --rename-account '^Liabilities:Amex$=Liabilities:All Credit Cards'
196 If you need to do anything more complicated, of course you can edit the output after converting;
197 it's just plain text.
201 # Convert homebank.xhb to a Beancount-compatible file:
202 homebank2ledger path/to/homebank.xhb -f beancount -o ledger.beancount
204 # Run the balances report:
205 bean-report ledger.beancount balances
210 * I didn't intend to make this a releasable robust product, so it's lacking tests.
211 * Scheduled transactions are not (yet) converted.
212 * There are some minor formatting tweaks I will make (e.g. consolidate transaction tags and payees)
219 use App::HomeBank2Ledger;
221 our $VERSION = '9999.999'; # VERSION
223 App::HomeBank2Ledger->main(@ARGV);