My personal CLI (Command Line Interface) app to manage my invoices via Web Scraping.
WIP (Work in Progress): For now only the list command is fully implemented. The generate command will be finished in the next couple of weeks.
I'm using a SaaS (Software as a Service) to generate invoices in my own company however it doesn't provide/expose an API for developers like me that want to automate tedious tasks! Do I have a solution? Of course, as a developer nothing is impossible! Via Web Scrapping (with a headless browser to perform browser automation) I'm able to interact with the Web Application and perform all the operations.
- Typescript (selected ES2020 as target because I assume Node.js version 14 or higher is being used)
- Node.js
- Puppeteer (headless browser automation)
- ESLint + Prettier + Husky
- Yarn
- Pkg (create executable file)
- Meow (parse command line arguments + help functionalities) - I could use Yargs, OCLIF, Commander.js, or other CLI libraries for more complex CLI applications
- Inquirer.js (to ask questions to the user)
Btw, as I'm talking about CLI apps, there is another cool package that you can use to simplify shell commands executions if needed: Sheeljs.
As I'm not distributing the CLI to the public / NPM registry, you can install it globally in your machine via Yarn or NPM:
yarn global add .
# OR
npm install -g .Let’s say I want to distribute this for only certain persons that don't have a proper Node environment in their machine. For that, I package my CLI as a single executable, using the pkg module from Vercel. The binary is available in the bin/<os> folder (also available in compressed format). For now, only macOS is supported.
Requirements: Set up the following environment variables (please check .env.example): USER_INVOICE, INVOICE_URL and PWD_INVOICE in your system.
https://kirablog.hashnode.dev/build-a-cli-using-nodejs#heading-adding-logic
MIT License © alexmarqs