sblaurock / crypticker Goto Github PK

View Code? Open in Web Editor NEW

65.0 5.0 8.0 480 KB

📈 Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.

Home Page: https://www.npmjs.com/package/crypticker

License: MIT License

JavaScript 100.00%

bitcoin ethereum cryptowatch command-line coin ticker cryptocurrency cryptocurrency-price-ticker btc eth

crypticker's Introduction

crypticker

Command line cryptocurrency price ticker for Bitcoin, Ethereum, and more.

Installation / Update

Installation or update can be done via npm as a global package

npm i -g crypticker

Usage

Once installed globally, crypticker can be run as a binary

crypticker

Flag	Type	Description
`--no-history`		Disable history display
`--interval`	Integer	Poll interval in milliseconds
`--markets`	String	Comma separated list of markets
`--api-key`	String	Cryptowat.ch API key (optional)

Options

Markets and application preferences can be managed within options.json. If the package was installed globally, the installation directory (and corresponding options.json) file may be found with npm root -g. Application will prefer an options file named .crypticker located in the home directory (~) if one exists - this can be used to preserve options between updates.

cp $(npm root -g)/crypticker/options.json ~/.crypticker may be used to create a local copy of the options file.

Parameter	Type	Description	Example
apiKey	String	Cryptowat.ch API key (optional)	`BYKU2QBYIQUE386W37BO`
pollInterval	Integer	Interval at which to poll API (in milliseconds)	`30000`
padding	Integer	Number of spaces to use between display sections	`8`
history	Object	Parameters around ticker history display
history.enabled	Boolean	Toggles history display on and off	`true`
history.length	Integer	Number of ticks to display within readout	`16`
history.hideAmount	Boolean	Toggles display of price changes on and off	`false`
history.minorThreshold	Float	Change percentage that must be exceeded to display a minor symbol	`0.00`
history.majorThreshold	Float	Change percentage that must be exceeded to display a major symbol	`0.20`
history.positiveMajorSymbol	String	Symbol to use for positive major trend	`"∙"`
history.positiveMinorSymbol	String	Symbol to use for positive minor trend	`"⋅"`
history.neutralSymbol	String	Symbol to use for no trend	`"⋅"`
history.negativeMinorSymbol	String	Symbol to use for negative minor trend	`"⋅"`
history.negativeMajorSymbol	String	Symbol to use for negative major trend	`"∙"`
markets	Array	List of markets to monitor	`['coinbase-pro:eth/btc']`

Powered by the Cryptowatch public API. A listing of supported markets can be found here. A forward slash (/) should be used to split pairs within markets list (for example: coinbase-pro:link/eth in favor of coinbase-pro:linketh).

crypticker's People

Contributors

Stargazers

Watchers

Forkers

scryptolabs si-mikey strong-roots-capital briansorahan markdenardo coinarcade jbx6 eddyxhse

crypticker's Issues

Data retrieval error

Hi,

I run:

$ crypticker
⚠ Data retrieval error / Last updated a few seconds ago

My system is:

$ node -v
v8.11.1

$ npm -v
6.4.1

$ uname -a
Linux raspberrypi 4.14.70-v7+ #1144 SMP Tue Sep 18 17:34:46 BST 2018 armv7l GNU/Linux

Any help? Thanks.

Alts to BTC price decimal spaces

Hi Steve,
I just stumbled upon crypticker, nice && simple, that's how is should be.

There is a problem with a price display from ALTS to BTC, it is only four decimal spaces after Zero. That's not enough for 'smaller' ALTS like XRP or GNT etc.

Could not find the way how to change it?

Attached are screenshots

Cheers,
T

Does not work for coinbase-pro:zecusd

When I add this option to my configuration it does not show the prices for ZEC

"markets": [
        "coinbase-pro:btcusd",
        "coinbase-pro:xtzusd",
        "coinbase-pro:zecusd"
    ]

The only two that appear are XTZ and BTC.

Error: Cannot find module 'colors'

I updated nodejs and now can't use crypticker anymore... Tried to remove and install a few times, but I also get this error:

PS C:\Users\rokt> crypticker
node:internal/modules/cjs/loader:927
 throw err;
 ^

Error: Cannot find module 'colors'
Require stack:

- C:\Users\rokt\AppData\Roaming\npm\node_modules\crypticker\index.js
- C:\Users\rokt\AppData\Roaming\npm\node_modules\crypticker\bin\crypticker.js
   at Function.Module._resolveFilename (node:internal/modules/cjs/loader:924:15)
   at Function.Module._load (node:internal/modules/cjs/loader:769:27)
   at Module.require (node:internal/modules/cjs/loader:996:19)
   at require (node:internal/modules/cjs/helpers:92:18)
   at Object.<anonymous> (C:\Users\rokt\AppData\Roaming\npm\node_modules\crypticker\index.js:1:16)
   at Module._compile (node:internal/modules/cjs/loader:1092:14)
   at Object.Module._extensions..js (node:internal/modules/cjs/loader:1121:10)
   at Module.load (node:internal/modules/cjs/loader:972:32)
   at Function.Module._load (node:internal/modules/cjs/loader:813:14)
   at Module.require (node:internal/modules/cjs/loader:996:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
   'C:\\Users\\rokt\\AppData\\Roaming\\npm\\node_modules\\crypticker\\index.js',
   'C:\\Users\\rokt\\AppData\\Roaming\\npm\\node_modules\\crypticker\\bin\\crypticker.js'
  ]
  }

Any ideas how to fix this?

EISDIR: illegal operation on a directory, read

Hello :)

Thank you for crypticker. I like the idea.

However I'm facing a weird problem. I've created ~/.crypticker/options.json with the exact JSON you provide in this repo.

Unfortunately I have this :

npm ls crypticker
/Users/spyesx
└── (empty)

But! If this folder and files are created I have an error like :

$ crypticker 
fs.js:656
  var r = binding.read(fd, buffer, offset, length, position);
                  ^

Error: EISDIR: illegal operation on a directory, read
    at Object.fs.readSync (fs.js:656:19)
    at tryReadSync (fs.js:457:20)
    at Object.fs.readFileSync (fs.js:494:19)
    at Object.<anonymous> (/usr/local/lib/node_modules/crypticker/index.js:16:27)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.require (module.js:498:17)

I might have missed something. Any idea?

sblaurock / crypticker Goto Github PK

crypticker's Introduction

crypticker

Installation / Update

Usage

Options

crypticker's People

Contributors

Stargazers

Watchers

Forkers

crypticker's Issues

Data retrieval error

Alts to BTC price decimal spaces

Does not work for coinbase-pro:zecusd

Error: Cannot find module 'colors'

EISDIR: illegal operation on a directory, read

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent