2 # ABSTRACT: A tool to convert HomeBank files to Ledger format
3 # PODNAME: homebank2ledger
9 use App::HomeBank2Ledger;
11 our $VERSION = '0.001'; # VERSION
13 App::HomeBank2Ledger->main(@ARGV);
23 homebank2ledger - A tool to convert HomeBank files to Ledger format
31 homebank2ledger --input FILEPATH [--output FILEPATH]
32 [--version|--help|--manual]
33 [--format FORMAT] [--account-width NUM]
34 [--accounts|--no-accounts] [--payees|--no-payees]
35 [--tags|--no-tags] [--commodities|--no-commodities]
36 [--opening-date DATE] [--default-account STR]
37 [--rename-account STR]... [--exclude-account STR]...
41 C<homebank2ledger> converts L<HomeBank|http://homebank.free.fr/> files to a format usable by
42 L<Ledger|https://www.ledger-cli.org/>. It can also convert directly to the similar
43 L<Beancount|http://furius.ca/beancount/> format.
45 This software is B<EXPERIMENTAL>, in early development. Its interface may change without notice.
47 I wrote C<homebank2ledger> because I have been maintaining my own personal finances using HomeBank
48 (which is awesome) and I wanted to investigate using plain text accounting programs. It works well
49 enough for my data, but you may be using HomeBank features that I don't so there may be cases this
50 doesn't handle well or at all. Feel free to file a bug report. This script does NOT try to modify
51 the original HomeBank files it converts from, so there won't be any crazy data loss bugs... but no
60 Converts HomeBank accounts and categories into a typical set of double-entry accounts.
64 Retains HomeBank metadata, including payees and tags.
68 Offers some customization of the output ledger, like account renaming.
72 This program is feature-complete in my opinion (well, almost -- see L</CAVEATS>), but if there is
73 anything you think it could do to be even better, feedback is welcome; just file a bug report. Or
74 fork the code and have fun!
78 You can migrate the data you have in HomeBank so you can start maintaining your accounts in Ledger
81 Or if you don't plan to switch completely off of HomeBank, you can continue to maintain your
82 accounts in HomeBank and use this script to also take advantage of the reports Ledger offers.
88 Print the version and exit.
94 Print help/usage info and exit.
100 Print the full manual and exit.
104 =head2 --input FILEPATH
106 Specify the path to the HomeBank file to read (must already exist).
108 Alias: C<--file>, C<-i>
110 =head2 --output FILEPATH
112 Specify the path to the Ledger file to write (may not exist yet). If not provided, the formatted
113 ledger will be printed on C<STDOUT>.
119 Specify the output file format. If provided, must be one of:
133 =head2 --account-width NUM
135 Specify the number of characters to reserve for the account column in transactions. Adjusting this
136 can provide prettier formatting of the output.
142 Enables account declarations.
144 Defaults to enabled; use C<--no-accounts> to disable.
148 Enables payee declarations.
150 Defaults to enabled; use C<--no-payees> to disable.
154 Enables tag declarations.
156 Defaults to enabled; use C<--no-tags> to disable.
160 Enables commodity declarations.
162 Defaults to enabled; use C<--no-commodities> to disable.
164 =head2 --opening-date DATE
166 Specify the opening date for the "opening balances" transaction. This transaction is created (if
167 needed) to support HomeBank's ability to configure accounts with opening balances.
169 Date must be in the form "YYYY-MM-DD". Defaults to the date of the first transaction.
171 =head2 --default-account STR
173 Specify the account to use for one-sided transactions (if any). Defaults to "Expenses:No Category".
175 A default account may be necessary because with Ledger all transactions are double-entry.
177 =head2 --rename-account STR
179 Specifies a mapping for renaming accounts in the output. By default C<homebank2ledger> tries to come
180 up with sensible account names (based on your HomeBank accounts and categories) that fit into five
207 The value of the argument must be of the form "REGEXP=REPLACEMENT". See L</EXAMPLES>.
209 Can be repeated to rename multiple accounts.
211 =head2 --exclude-account STR
213 Specifies an account that will not be included in the output. All transactions related to this
214 account will be skipped.
216 Can be repeated to exclude multiple accounts.
222 # Convert homebank.xhb to a Ledger-compatible file:
223 homebank2ledger path/to/homebank.xhb -o ledger.dat
225 # Run the Ledger balance report:
226 ledger -f ledger.dat balance
228 You can also combine this into one command:
230 homebank2ledger path/to/homebank.xhb | ledger -f - balance
232 =head2 Account renaming
234 With the L</"--rename-account STR"> argument, you have some control over the resulting account
235 structure. This may be useful in cases where the organization imposed (or encouraged) by HomeBank
236 doesn't necessarily line up with an ideal double-entry structure.
238 homebank2ledger path/to/homebank.xhb -o ledger.dat \
239 --rename-account '^Assets:Credit Union Savings$=Assets:Bank:Credit Union:Savings' \
240 --rename-account '^Assets:Credit Union Checking$=Assets:Bank:Credit Union:Checking'
242 Multiple accounts can be renamed at the same time because the first part of the mapping is a regular
243 expression. The above example could be written like this:
245 homebank2ledger path/to/homebank.xhb -o ledger.dat \
246 --rename-account '^Assets:Credit Union =Assets:Bank:Credit Union:'
248 You can also merge accounts by simple renaming multiple accounts to the same name:
250 homebank2ledger path/to/homebank.xhb -o ledger.dat \
251 --rename-account '^Liabilities:Chase VISA$=Liabilities:All Credit Cards' \
252 --rename-account '^Liabilities:Amex$=Liabilities:All Credit Cards'
254 If you need to do anything more complicated, of course you can edit the output after converting;
255 it's just plain text.
259 # Convert homebank.xhb to a Beancount-compatible file:
260 homebank2ledger path/to/homebank.xhb -f beancount -o ledger.beancount
262 # Run the balances report:
263 bean-report ledger.beancount balances
271 I didn't intend to make this a releasable robust product, so it's lacking tests.
275 Budgets and scheduled transactions are not (yet) converted.
279 There are some minor formatting tweaks I will make (e.g. consolidate transaction tags and payees)
285 Please report any bugs or feature requests on the bugtracker website
286 L<https://github.com/chazmcgarvey/homebank2ledger/issues>
288 When submitting a bug or request, please include a test-file or a
289 patch to an existing test-file that illustrates the bug or desired
294 Charles McGarvey <chazmcgarvey@brokenzipper.com>
296 =head1 COPYRIGHT AND LICENSE
298 This software is Copyright (c) 2019 by Charles McGarvey.
300 This is free software, licensed under:
302 The MIT (X11) License