1<img width="1200" alt="Invoice" src="https://github.com/maaslalani/nap/assets/42545625/16dae9d9-390c-49b6-aedd-3f882b17f57b">
2
3# Invoice
4
5Generate invoices from the command line.
6
7## Command Line Interface
8
9```bash
10invoice generate --from "Dream, Inc." --to "Imagine, Inc." \
11 --item "Rubber Duck" --quantity 2 --rate 25 \
12 --tax 0.13 --discount 0.15 \
13 --note "For debugging purposes."
14```
15
16<img src="https://vhs.charm.sh/vhs-66CMd4UQuXkuxX9djHUnGX.gif" width="600" />
17
18View the generated PDF at `invoice.pdf`, you can customize the output location
19with `--output`.
20
21```bash
22open invoice.pdf
23```
24
25<img width="574" alt="Example invoice" src="https://github.com/maaslalani/nap/assets/42545625/13153de2-dfa1-41e6-a18e-4d3a5cea5b74">
26
27Save repeated information with environment variables:
28
29```bash
30export INVOICE_LOGO=/path/to/image.png
31export INVOICE_FROM="Dream, Inc."
32export INVOICE_TO="Imagine, Inc."
33export INVOICE_TAX=0.13
34export INVOICE_RATE=25
35```
36
37Generate new invoice:
38
39```bash
40invoice generate \
41 --item "Yellow Rubber Duck" --quantity 5 \
42 --item "Special Edition Plaid Rubber Duck" --quantity 1 \
43 --notes "For debugging purposes."
44 --output duck-invoice.pdf
45```
46
47### Custom Templates
48
49If you would like a custom invoice template for your business or company, please
50reach out via:
51
52* [Email](mailto:maas@lalani.dev)
53* [Twitter](https://twitter.com/maaslalani)
54
55## Installation
56
57<!--
58
59Use a package manager:
60
61```bash
62# macOS
63brew install invoice
64
65# Arch
66yay -S invoice
67
68# Nix
69nix-env -iA nixpkgs.invoice
70```
71
72-->
73
74Install with Go:
75
76```sh
77go install github.com/maaslalani/invoice@main
78```
79
80Or download a binary from the [releases](https://github.com/maaslalani/invoice/releases).
81
82## License
83
84[MIT](https://github.com/maaslalani/invoice/blob/master/LICENSE)
85
86## Feedback
87
88I'd love to hear your feedback on improving `invoice`.
89
90Feel free to reach out via:
91* [Email](mailto:maas@lalani.dev)
92* [Twitter](https://twitter.com/maaslalani)
93* [GitHub issues](https://github.com/maaslalani/invoice/issues/new)
94
95---
96
97<sub><sub>z</sub></sub><sub>z</sub>z