coffee-crypto-cli

crypto-cli

Cryptocurrency CLI price tool

Table of Contents

1. Installation
2. Usage
3. Flags
4. Local Development
5. Contributing

Installation

You can install the crypto-cli tool via npm and yarn:

npm install -g coffee-crypto-cli

yarn add global coffee-crypto-cli

Usage

$ crypto --price bitcoin --volume --ath
>> Bitcoin: $20,000 - volume: $13,337 - ATH: $68,000

Flags

Note: --price, --p is required for any of the subsequent flags.

--price, --p - coin name

Coin price change (%) in the past 24 hours.

--priceChange, --pc

Coin volume in the past 24 hours.

--volume, --v

Highest price sold in the past 24 hours.

--high

Lowest price sold in the past 24 hours.

--low

Coin all time high price.

--ath

Percent price change from the all time high.

--athChange, --athc

Save coin data via JSON and/or CSV

--save json
--save json,csv

CLI help message.

--help

Current version.

--version

Local Development

First things first, we'll need to clone the repo, install the dependencies, and, build the project.

git clone https://github.com/Zidious/crypto-cli.git

yarn install && yarn build

To run the CLI locally, use the below command followed by the flag you want to run.

node dist/index.js --price bitcoin

Contributing

We use Conventional Commits for commit messages.

Shoutouts

Cryptocurrency coin statistics are gathered from the CoinGecko API.