view release on metacpan or  search on metacpan

bin/homebank2ledger  view on Meta::CPAN

doesn't handle well or at all. Feel free to file a bug report. This script does NOT try to modify
the original HomeBank files it converts from, so there won't be any crazy data loss bugs... but no
warranty.

=head2 Features

=over 4

=item *

Converts HomeBank accounts and categories into a typical set of double-entry accounts.

=item *

Retains HomeBank metadata, including payees and tags.

=item *

Offers some customization of the output ledger, like account renaming.

=back

This program is feature-complete in my opinion (well, almost -- see L</CAVEATS>), but if there is
anything you think it could do to be even better, feedback is welcome; just file a bug report. Or
fork the code and have fun!

=head2 Use cases

You can migrate the data you have in HomeBank so you can start maintaining your accounts in Ledger
(or Beancount).

Or if you don't plan to switch completely off of HomeBank, you can continue to maintain your
accounts in HomeBank and use this script to also take advantage of the reports Ledger offers.

=head1 INSTALL

There are several ways to install F<homebank2ledger> to your system.

=head2 using cpanm

You can install F<homebank2ledger> using L<cpanm>. If you have a local perl (plenv, perlbrew, etc.),
you can just do:

    cpanm App::Homebank2Ledger

to install the F<homebank2ledger> executable and its dependencies. The executable will be installed
to your perl's bin path, like F<~/perl5/perlbrew/bin/homebank2ledger>.

If you're installing to your system perl, you can do:

    cpanm --sudo App::Homebank2Ledger

to install the F<homebank2ledger> executable to a system directory, like
F</usr/local/bin/homebank2ledger> (depending on your perl).

=head2 Downloading just the executable

You may also choose to download F<homebank2ledger> as a single executable, like this:

    curl -OL https://raw.githubusercontent.com/chazmcgarvey/homebank2ledger/solo/homebank2ledger
    chmod +x homebank2ledger

=head2 For developers

If you're a developer and want to hack on the source, clone the repository and pull the
dependencies:

    git clone https://github.com/chazmcgarvey/homebank2ledger.git
    cd homebank2ledger
    make bootstrap      # installs dependencies; requires cpanm

=head1 OPTIONS

=head2 --version

Print the version and exit.

Alias: C<-V>

=head2 --help

Print help/usage info and exit.

Alias: C<-h>, C<-?>

=head2 --manual

Print the full manual and exit.

Alias: C<--man>

=head2 --input FILEPATH

Specify the path to the HomeBank file to read (must already exist).

Alias: C<--file>, C<-i>

=head2 --output FILEPATH

Specify the path to the Ledger file to write (may not exist yet). If not provided, the formatted
ledger will be printed on C<STDOUT>.

Alias: C<-o>

=head2 --format STR

Specify the output file format. If provided, must be one of:

=over 4

=item *

ledger

=item *

beancount

=back

=head2 --account-width NUM