Stupid invoice generator

Put the data you usually use to create your invoices into a YAML file, run this tool and done, you have a nice PDF invoice.

Note: This project has been rewritten in Crystal and now uses libharu for PDF generation instead of wkhtmltopdf/WebKit. It no longer depends on X11, WebKit, or any browser engine.

A pre-built static binary with no external dependencies can be downloaded from the releases page.

To see an example the fastest possible way, run:

$ invoicegenerator --show-yml-example | invoicegenerator --stdin

To have a starting point to write your YAML describing your invoice, type:

$ invoicegenerator --show-yml-example > invoice.yml

Then edit the generated invoice.yml to match your data.

You can find an example of the generated PDF at examples/invoice.pdf.

The invoice layout is built directly into the program. Changing the template is not currently supported.

Run invoicegenerator --show-yml-example and you will see an example. The supported fields are:

The first line of from and client is treated as the entity name and rendered more prominently; all subsequent lines are used as the address.

Each item under items has:

Any field in the YAML file can include the following variables, which are automatically substituted at generation time:

Example usage in your YAML:

invoice_number: "INV-$year-007"
notes: |
  Services rendered for $past_month $year.
  Thank you for your business!

All YAML fields can also be overridden via command-line flags. Run invoicegenerator --help for the full list. CLI flags take precedence over YAML values.

--from=TEXT            Issuing company (name + address, newline-separated)
--client=TEXT          Client info (name + address, newline-separated)
--invoice-number=TEXT  Invoice number
--date=YYYY-MM-DD      Invoice date
--due-date=YYYY-MM-DD  Due date
--currency=SYM         Currency symbol (default: $)
--tax-rate=RATE        Tax rate as decimal (e.g. 0.05)
--output=FILE          Output PDF path (overrides 'output' in YAML, default: invoice.pdf)
--file=FILE            YAML invoice data file (default: invoice.yml)
--stdin                Read YAML from STDIN instead of a file
--show-yml-example     Print an example YAML file and exit

You will need the Crystal compiler and shards (bundled with Crystal).

libharu is required at compile time when building from source.

$ shards build --release
$ ./bin/invoicegenerator --help

This binary embeds the DejaVu Sans fonts. DejaVu fonts are derived from Bitstream Vera fonts, copyright © 2003 Bitstream, Inc. DejaVu changes are in the public domain. The full license text is available at https://dejavu-fonts.github.io/License.html.

1. Fork it (https://github.com/hugopl/invoicegenerator/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

• Hugo Parente Lima - creator and maintainer