Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knutkirkhorn/btc-value-cli
💸💻 Get the current Bitcoin value CLI
https://github.com/knutkirkhorn/btc-value-cli
bitcoin btc cli cli-app command-line cryptocurrency nodejs terminal value
Last synced: 2 months ago
JSON representation
💸💻 Get the current Bitcoin value CLI
- Host: GitHub
- URL: https://github.com/knutkirkhorn/btc-value-cli
- Owner: knutkirkhorn
- License: mit
- Created: 2017-12-08T19:46:34.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T17:11:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T02:36:06.603Z (4 months ago)
- Topics: bitcoin, btc, cli, cli-app, command-line, cryptocurrency, nodejs, terminal, value
- Language: JavaScript
- Homepage:
- Size: 469 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Get the current Bitcoin value in command line
[](https://www.npmjs.com/package/btc-value-cli)
## Installation
```
npm install --global btc-value-cli
```
## Usage
```
$ btc-value --help
Usage
$ btc-value
Options
--key -k Set the API key (Obtain key at: https://coinmarketcap.com/api/)
--decimal -d Print value as decimal
--save -s [code] Set the currency that will be used by default
--currency -c [code] Print the value in another currency
--list -l Print a list of all supported currencies
--quantity -q [number] Print the value of the given quantity
--autorefresh -a [seconds] Automatic refresh printing every x seconds
--percentage -p [h|d|w] Print the percentage change (h = hour, d = day, w = week)
--reset -r Reset the configuration to the default
--provider [cmc|coingecko] Set the currency provider to retrieve Bitcoin values from
Examples
$ btc-value
$ btc-value -k
$ btc-value -d
$ btc-value -s NOK
$ btc-value -c NOK
$ btc-value -q 2.2
$ btc-value -p h
$ btc-value --provider coingecko
```
## Options
### `--decimal`, `-d`
Print the value as a decimal number.
### `--save`, `-s [code]`
Set the currency that will be used by default. It will save the new default currency code and symbol in the [config.json](config.json) file. Next time ```btc-value``` is run in command line it will print the value of the new default currency.
### `--currency`, `-c [code]`
Print the value in another currency. It will print out the value of the currency code. A list of all currency codes can be shown with the use of the `-l` flag.
### `--list`, `-l`
Print a list of all supported currencies for the selected currency provider.
### `--quantity`, `-q [number]`
Print the value of the given quantity. Input quantity can be either ```decimal``` or ```integer```.
If the input quantity is set to a number, the given quantity is saved locally in the [config.json](config.json) file.
The `-q` flag can be used with and without a number input.
### `--autorefresh`, `-a [seconds]`
Set a timeout that print the value every `seconds` seconds. The timeout restarts after every use. If `seconds` is not set, the default timeout is used (15 seconds). This is stored in the [config.json](config.json) file. The reason a timeout is used instead of a interval, is that it might not finish before the next starts (if bad network connection) and this can use more memory than needed.
### `--percentage`, `-p [h|d|w]`
Print the percentage change the last hour, day and week. If the flag is set to `h` then percentage change last hour is printed. It is the same for `d` and days, and `w` and week.
If the percentage is negative it is printed in bright red otherwise it is printed in green.
### `--reset`, `-r`
Reset the configuration to the default:
```js
{
default: 'USD',
quantity: 1,
autorefresh: 15,
apiKey: '',
provider: 'coingecko'
}
```
### `--provider [cmc|coingecko]`
Set the currency provider to retrieve Bitcoin values from. By default it uses the data from CoinGecko.
### `--key`, `-k`
Set the API key. This key is optional and only required if using data from the CoinMarketCap API. To obtain an API key go to the [Cryptocurrency Market Capitalizations API](https://coinmarketcap.com/api/).
## Related
- [btc-value](https://github.com/knutkirkhorn/btc-value) - API for this module