Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zidious/crypto-cli
Cryptocurrency CLI price tool
https://github.com/zidious/crypto-cli
bitcoin cli crypto cryptocurrency
Last synced: 21 days ago
JSON representation
Cryptocurrency CLI price tool
- Host: GitHub
- URL: https://github.com/zidious/crypto-cli
- Owner: Zidious
- License: mit
- Created: 2022-07-09T04:30:28.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-06T04:37:53.000Z (10 months ago)
- Last Synced: 2024-10-06T15:41:47.081Z (about 1 month ago)
- Topics: bitcoin, cli, crypto, cryptocurrency
- Language: TypeScript
- Homepage:
- Size: 251 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# crypto-cli
[](https://github.com/zidious/crypto-cli/graphs/contributors)
[](https://www.npmjs.com/package/coffee-crypto-cli)
> Cryptocurrency CLI price tool
## Table of Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Flags](#flags)
4. [Local Development](#local-development)
5. [Contributing](#contributing)
## Installation
You can install the crypto-cli tool via npm and yarn:
```sh
npm install -g coffee-crypto-cli
```
## Usage
```sh
$ 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.
```sh
git clone https://github.com/Zidious/crypto-cli.git
```
```sh
yarn install --frozen-lockfile && yarn build
```
To run the CLI locally:
```sh
node dist/index.js bitcoin
```
## Contributing
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
## Shoutouts
Cryptocurrency coin statistics are gathered from the [CoinGecko API](https://www.coingecko.com/en/api/documentation).