A simple command line tool to generate PDF invoices from YAML files. This tool reads a YAML file containing invoice data and generates a PDF invoice based on the provided template. It is designed to be used in a Dart environment and can be run from the command line.
- 📝 Generate professional PDF invoices from YAML configuration files
- 🎨 Multiple templates available
- 🔤 Support for multiple fonts
- 🌍 Internationalization support with locale formatting
- 🔧 Cross-platform support (Windows, macOS, Linux)
- ⚡ Fast and lightweight command-line interface
- Dart SDK 3.7.0 or higher
git clone https://github.com/plugfox/invoices.git
cd invoices
dart pub getdart pub global activate --source path .dart run bin/main.dart -i config.yaml -o invoice.pdfdart run bin/main.dart [options]| Option | Short | Description | Default |
|---|---|---|---|
--help |
-h |
Print usage information | - |
--input |
-i |
Input YAML file containing invoice data | config.yaml |
--output |
-o |
Output PDF file where the generated invoice will be saved | output.pdf |
--template |
-t |
Template to use for generating the invoice | simple |
--font |
-f |
Font to use for the invoice text | openSans |
--locale |
-l |
Locale to use for formatting the invoice | ru-RU |
The input YAML file should contain all the necessary information to generate the invoice, such as organization details, counterparty information, services, and totals.
issuedAt: 2023-10-01T12:00:00Z
currency: "USD"
organization:
name: "My Organization"
address: "123 Main St, City, Country"
taxId: "123456789"
description: "A brief description of the organization."
counterparty:
name: "Client Name"
address: "456 Client St, City, Country"
taxId: "987654321"
description: |
Sample Client Company
789 Client Ave, City, Country
description: |
Frontend software development services according to _INDEPENDENT CONTRACTOR AGREEMENT
dated XXth day of Month, 2023_
#### Bank details for USD transfer
**Beneficiary's Bank:** Bank name, City, Country
**Beneficiary SWIFT:** BANKSWIFT
**Ben's IBAN:** US12BANK12345678901234
**Name of Beneficiary:** P/E Name Surname
services:
- name: "Service 1"
amount: 123.45
- name: "Service 2"
amount: 67.89All fields in the YAML configuration are optional.
- issuedAt - Invoice issue date in ISO 8601 format
- currency - Currency code (e.g., "USD", "EUR", "RUB")
- organization - Your organization details
- name - Organization name
- address - Organization address
- taxId - Tax identification number
- description - Additional organization description
- counterparty - Client/customer details
- name - Client name
- address - Client address
- taxId - Client tax identification number
- description - Additional client description
- description - Invoice description (supports Markdown formatting)
- services - List of services/items
- name - Service or item name
- amount - Service or item amount
dart run bin/main.dart -i my-invoice.yaml -o invoice-2023.pdf -t simple -f timesdart run bin/main.dart -i config.yaml -o output.pdf -l en_USdart run bin/main.dart -i config.yaml -o invoice.pdf -t simple -f openSans -l ru_RUdart testdart format --fix -l 120 bin lib testdart pub get- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
If you encounter any issues or have questions, please open an issue on GitHub.
See CHANGELOG.md for a list of changes and version history.
