Package Exports

usdbrl-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (usdbrl-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

USD-BRL CLI

USD-BRL CLI is a tool that allows developers to fetch the exchange rate of USD/BRL on the 15th workday of the previous month.

To file taxes in Brazil for foreign earnings, one needs to convert that income to USD using the closed exchange rate of the payment date and then convert to BRL using the exchange rate on the 15th workday of the previous month.

The data comes from the oficial website for the Brazilian Central Bank

Prerequisites

Before you begin, ensure you have met the following requirements:

You have Node.js installed in your machine.
You have an internet connection.

Installing usdbrl-cli

To install usdbrl-cli, follow these steps:

using npm:

npm install -g usdbrl-cli

Using usdbrl-cli

To use usdbrl-cli, follow these steps:

Get the exchange rate on the 15th workday of the past month

> usdbrl
Exchange rate on 15/06/2020: R$ 5,1877

Get the exchange rate on a specific date

> usdbrl -d 10/06/2020
Exchange rate on 10/06/2020: R$ 4,8888

Get the exchange rate for a period

> usdbrl -r -p 05/07/2020 10/07/2020
[
  { date: '30/06/2020', rate: '5,4754' },
  { date: '01/07/2020', rate: '5,3646' },
  { date: '02/07/2020', rate: '5,3022' },
  { date: '03/07/2020', rate: '5,3368' }
]

Contributing to usdbrl-cli

To contribute to usdbrl-cli, follow these steps:

Fork this repository.
Create a branch: git checkout -b <branch_name>.
Make your changes and commit them: git commit -m '<commit_message>'
Push to the original branch: git push origin usdbrl-cli/<location>
Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contact

If you want to contact me you can reach me at dwbwill@gmail.com.

License

This project uses the following license: MIT.