Skip to content

Zidious/crypto-cli

Repository files navigation

crypto-cli

GitHub contributors npm

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

Usage

$ crypto bitcoin
>> Bitcoin: $20,000

Flags

Name Description
--price-change, --pc Coin price change (%) in the past 24 hours
--volume, --v Coin volume in the past 24 hours
--ath-change, --athc Percent price change from the all time high
--high, --h Highest price sold in the past 24 hours
--low, --l Lowest price sold in the past 24 hours
--ath Coin all time high price
--save json,csv Save coin data via JSON and/or CSV
--help Flag description and usage examples
--version Current version

Local Development

Clone the repo, install the dependencies, and, build the project.

git clone https://github.com/Zidious/crypto-cli.git
yarn install --frozen-lockfile && yarn build

To run the CLI locally:

node dist/index.js bitcoin

Contributing

We use Conventional Commits for commit messages.

Shoutouts

Cryptocurrency coin statistics are gathered from the CoinGecko API.