3 homebank2ledger - A tool to convert HomeBank files to Ledger format
11 homebank2ledger --input FILEPATH [--output FILEPATH] [--format FORMAT]
12 [--version|--help|--manual] [--account-width NUM]
13 [--accounts|--no-accounts] [--payees|--no-payees]
14 [--tags|--no-tags] [--commodities|--no-commodities]
16 [--rename-account STR]... [--exclude-account STR]...
20 homebank2ledger converts HomeBank <http://homebank.free.fr/> files to a
21 format usable by Ledger <https://www.ledger-cli.org/>. It can also
22 convert directly to the similar Beancount
23 <https://beancount.github.io/docs/index.html> format.
25 This software is EXPERIMENTAL, in early development. Its interface may
26 change without notice.
28 I wrote homebank2ledger because I have been maintaining my own personal
29 finances using HomeBank (which is awesome) and I wanted to investigate
30 using plain text accounting programs. It works well enough for my data,
31 but you may be using HomeBank features that I don't so there may be
32 cases this doesn't handle well or at all. Feel free to file a bug
33 report. This script does NOT try to modify the original HomeBank files
34 it converts from, so there won't be any crazy data loss bugs... but no
39 * Converts HomeBank accounts and categories into a typical set of
40 double-entry accounts.
42 * Retains HomeBank metadata, including payees and tags.
44 * Offers some customization of the output ledger, like account
47 This program is feature-complete in my opinion (well, almost -- see
48 "CAVEATS"), but if there is anything you think it could do to be even
49 better, feedback is welcome; just file a bug report. Or fork the code
54 You can migrate the data you have in HomeBank so you can start
55 maintaining your accounts in Ledger (or Beancount).
57 Or if you don't plan to switch completely off of HomeBank, you can
58 continue to maintain your accounts in HomeBank and use this script to
59 also take advantage of the reports Ledger offers.
63 There are several ways to install homebank2ledger to your system.
67 You can install homebank2ledger using cpanm. If you have a local perl
68 (plenv, perlbrew, etc.), you can just do:
70 cpanm App::Homebank2Ledger
72 to install the homebank2ledger executable and its dependencies. The
73 executable will be installed to your perl's bin path, like
74 ~/perl5/perlbrew/bin/homebank2ledger.
76 If you're installing to your system perl, you can do:
78 cpanm --sudo App::Homebank2Ledger
80 to install the homebank2ledger executable to a system directory, like
81 /usr/local/bin/homebank2ledger (depending on your perl).
83 Downloading just the executable
85 You may also choose to download homebank2ledger as a single executable,
88 curl -OL https://raw.githubusercontent.com/chazmcgarvey/homebank2ledger/solo/homebank2ledger
89 chmod +x homebank2ledger
93 If you're a developer and want to hack on the source, clone the
94 repository and pull the dependencies:
96 git clone https://github.com/chazmcgarvey/homebank2ledger.git
98 make bootstrap # installs dependencies; requires cpanm
104 Print the version and exit.
110 Print help/usage info and exit.
116 Print the full manual and exit.
122 Specify the path to the HomeBank file to read (must already exist).
128 Specify the path to the Ledger file to write (may not exist yet). If
129 not provided, the formatted ledger will be printed on STDOUT.
135 Specify the output file format. If provided, must be one of:
143 Specify the number of characters to reserve for the account column in
144 transactions. Adjusting this can provide prettier formatting of the
151 Enables account declarations.
153 Defaults to enabled; use --no-accounts to disable.
157 Enables payee declarations.
159 Defaults to enabled; use --no-payees to disable.
163 Enables tag declarations.
165 Defaults to enabled; use --no-tags to disable.
169 Enables commodity declarations.
171 Defaults to enabled; use --no-commodities to disable.
175 Enables budget transactions.
177 Budget transactions are only supported by the Ledger format (for now).
178 This option is silently ignored otherwise.
180 Defaults to enabled; use --no-budget to disable.
184 Specify the opening date for the "opening balances" transaction. This
185 transaction is created (if needed) to support HomeBank's ability to
186 configure accounts with opening balances.
188 Date must be in the form "YYYY-MM-DD". Defaults to the date of the
193 Specifies a mapping for renaming accounts in the output. By default
194 homebank2ledger tries to come up with sensible account names (based on
195 your HomeBank accounts and categories) that fit into five root
208 The value of the argument must be of the form "REGEXP=REPLACEMENT". See
211 Can be repeated to rename multiple accounts.
213 --exclude-account STR
215 Specifies an account that will not be included in the output. All
216 transactions related to this account will be skipped.
218 Can be repeated to exclude multiple accounts.
224 # Convert homebank.xhb to a Ledger-compatible file:
225 homebank2ledger path/to/homebank.xhb -o ledger.dat
227 # Run the Ledger balance report:
228 ledger -f ledger.dat balance
230 You can also combine this into one command:
232 homebank2ledger path/to/homebank.xhb | ledger -f - balance
236 With the "--rename-account STR" argument, you have some control over
237 the resulting account structure. This may be useful in cases where the
238 organization imposed (or encouraged) by HomeBank doesn't necessarily
239 line up with an ideal double-entry structure.
241 homebank2ledger path/to/homebank.xhb -o ledger.dat \
242 --rename-account '^Assets:Credit Union Savings$=Assets:Bank:Credit Union:Savings' \
243 --rename-account '^Assets:Credit Union Checking$=Assets:Bank:Credit Union:Checking'
245 Multiple accounts can be renamed at the same time because the first
246 part of the mapping is a regular expression. The above example could be
249 homebank2ledger path/to/homebank.xhb -o ledger.dat \
250 --rename-account '^Assets:Credit Union =Assets:Bank:Credit Union:'
252 You can also merge accounts by simple renaming multiple accounts to the
255 homebank2ledger path/to/homebank.xhb -o ledger.dat \
256 --rename-account '^Liabilities:Chase VISA$=Liabilities:All Credit Cards' \
257 --rename-account '^Liabilities:Amex$=Liabilities:All Credit Cards'
259 If you need to do anything more complicated, of course you can edit the
260 output after converting; it's just plain text.
264 # Convert homebank.xhb to a Beancount-compatible file:
265 homebank2ledger path/to/homebank.xhb -f beancount -o ledger.beancount
267 # Run the balances report:
268 bean-report ledger.beancount balances
272 * I didn't intend to make this a releasable robust product, so it's
275 * Scheduled transactions are not (yet) converted.
277 * There are some minor formatting tweaks I will make (e.g.
278 consolidate transaction tags and payees)
282 Please report any bugs or feature requests on the bugtracker website
283 https://github.com/chazmcgarvey/homebank2ledger/issues
285 When submitting a bug or request, please include a test-file or a patch
286 to an existing test-file that illustrates the bug or desired feature.
290 Charles McGarvey <chazmcgarvey@brokenzipper.com>
292 COPYRIGHT AND LICENSE
294 This software is Copyright (c) 2019 by Charles McGarvey.
296 This is free software, licensed under:
298 The MIT (X11) License