Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.17 KB

README.md

File metadata and controls

74 lines (49 loc) · 2.17 KB

Codex Logo

Invoice Generator CLI Tool

This tool was built to help developers quickly write up their invoices straight from the terminal. Why go about the hasle of writing a document yourself?

With automatic PDF conversion, this is the tool for your invoices!

Installation

Firstly, install the CLI using brew

  npm install -g invoice-cli

Simply run the invoice-cli command in your terminal, and configure your generator.

  invoice-cli

FAQ

Can I change the default template?

Yes, if you need to change the template of the invoice, then simply do so by running the invoice-cli config command, and drag and drop your HTML files in this directory. You need to make sure however that you specify elements with the ids. This is so that the CLI tool can update these fields to produce the PDF file.

NOTE: If you want to run the generator tool without using any of the options specified in the config, run the command using the --no-config flag

  invoice-cli --explicit 

Debugging

If you think you have found a bug within the tool, feel free to open an issue against it.

Use the --debug flag to show extra information when submitting an issue!

  invoice-cli --debug ...rest

Feedback

If you have any feedback, please react out to me on my portfolio website

Contributing

Contributions are always welcome! Please get in touch if you are interested.

License

MIT