Crypto-Cli 😎

A simple cryptocurrency price checker in your terminal. Build with ❤ using Nomics API.

Demo

Summary

Getting Started
Prerequisites
Checking CLI Version
Commands
Built With
Contributing
Authors
License
Acknowledgments

Getting Started

Getting started with the Crypto-Cli is easy.

First install the Nodejs via site or NVM.
Install the Cryto-cli package gloabally.

npm i -g @devdhera/crypto-cli

Get your free API key from Nomics.
Configure Crypto-cli with the API key you recieved.

crypto-cli key set

Now check the prices.

crypto-cli check price

Prerequisites

Crypto-Cli uses Nomics to as the cryptocurrency API.

In order to successfully run the cli get an API key.

Checking CLI Version

Run cryoto-cli --version or cryoto-cli -V to determine what version you are currently working with.

Commands

The commands listed below are derived from the latest version of Crypto CLI. You can view the list of commands available with your version in your terminal using crypto-cli --help. To learn more about a specific command and its options use crypto-cli [command] --help.

Usage

crypto-cli [command] [options]

Set API Key

crypto-cli key set

Show API Key

crypto-cli key show

Remove API Key

crypto-cli key remove

Check Price

GENERAL

crypto-cli check price

COIN FLAG

crypto-cli check price --coin=BTC

CURRENCY FLAG

crypto-cli check price --cur=LKR

Built With

Commander - CLI framework
Inquirer - Interactive CLI user interfaces
Configstore - Config storage lib
Colors - To beautify output
Axios - HTTP Client

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

Devin Herath - Initial work - DevDHera

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Brad Traversy for this being the guiding light 😇
PurpleBooth for this awesome README template ❤

DevDHera/Crypto-Cli