1# Invoice
2
3Generate invoices from the command line.
4
5## Text-based User Interface
6
7```bash
8invoice
9```
10
11## Command Line Interface
12
13```bash
14# Generate an invoice from information.
15invoice generate --title "Invoice" \
16 --id 2 \
17 --logo ./images/logo.png \
18 --from "Dream, Inc." \
19 --to "Imagine, Inc." \
20 --date "June 10, 2023" \
21 --due "June 30, 2023" \
22 --tax 0.13 \
23 --discount 0.15 \
24 --currency USD \
25 --item "Rubber Duck" \
26 --quantity 2 \
27 --rate 25 \
28 --notes "For debugging purposes."
29```
30
31Save repeated information with environment variables:
32
33```bash
34export INVOICE_LOGO=/path/to/image.png
35export INVOICE_FROM="Dream, Inc."
36export INVOICE_TO="Imagine, Inc."
37export INVOICE_TAX=0.13
38export INVOICE_RATE=25
39```
40
41Generate new invoice:
42
43```bash
44invoice generate \
45 --item "Yellow Rubber Duck" --quantity 5 \
46 --item "Special Edition Plaid Rubber Duck" --quantity 1 \
47 --notes "For debugging purposes."
48```
49
50## Installation
51
52<!--
53
54Use a package manager:
55
56```bash
57# macOS
58brew install invoice
59
60# Arch
61yay -S invoice
62
63# Nix
64nix-env -iA nixpkgs.invoice
65```
66
67-->
68
69Install with Go:
70
71```sh
72go install github.com/maaslalani/invoice@main
73```
74
75Or download a binary from the [releases](https://github.com/maaslalani/invoice/releases).
76
77## License
78
79[MIT](https://github.com/maaslalani/invoice/blob/master/LICENSE)
80
81## Feedback
82
83I'd love to hear your feedback on improving `invoice`.
84
85Feel free to reach out via:
86* [Email](mailto:maas@lalani.dev)
87* [Twitter](https://twitter.com/maaslalani)
88* [GitHub issues](https://github.com/maaslalani/invoice/issues/new)
89
90---
91
92<sub><sub>z</sub></sub><sub>z</sub>z