https://github.com/raj-kashyap001/currencli
https://github.com/raj-kashyap001/currencli
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/raj-kashyap001/currencli
- Owner: Raj-Kashyap001
- Created: 2024-05-22T11:44:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-23T10:57:11.000Z (about 1 year ago)
- Last Synced: 2025-02-21T18:14:42.142Z (3 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CurrenCLI: Currency Converter CLI
A command-line interface (CLI) tool for converting amounts between different currencies using the ExchangeRate-API.
## Features
- Convert an amount from one currency to another
- List current exchange rates for a specified currency
- Save favorite currency pairs for quick access
## Installation
Ensure you have Node.js installed on your system.
Install the CLI tool globally using npm:
```bash
npm install -g currencli
```
Usage
Getting Started
To get started, you'll need to obtain an API key from ExchangeRate-API. Follow these steps:
- Sign up on the ExchangeRate-API website to get your API key.
- Once you have your API key, proceed with the following steps.
If you haven't saved your API key yet, the CLI tool will prompt you to enter it. Once entered, the API key will be saved locally for future use.
## Usage
```bash
currencli convert
```
Follow the prompts to enter the amount, source currency, and target currency. The CLI will then convert the amount to the target currency using the latest exchange rates.
Listing Exchange Rates
```bash
currencli list
```
Follow the prompt to enter the base currency. The CLI will then list the current exchange rates for the specified base currency.
Saving Favorite Currency Pair
```bash
currencli save
```
Follow the prompts to enter the source and target currencies. The CLI will save the pair for quick access in the future.
Showing Favorite Currency Pairs
```bash
currencli favorites
```
Displays the saved favorite currency pairs.
API Key
This tool uses the ExchangeRate-API. You need to sign up on the ExchangeRate-API website to get an API key. You'll be prompted to enter your API key when you first run the tool.
License
This project is licensed under the MIT License - see the LICENSE file for details.
© 2024 Raj Kashyap. All Rights Reserved.