Skip to content

๐Ÿ“ˆ Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.

Notifications You must be signed in to change notification settings

si-mikey/crypticker

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

68 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

crypticker

npm npm npm David

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

screenshot

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
--nohistory Disable history display
--interval Integer Poll interval in milliseconds
--markets String Comma separated list of markets

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
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:ethbtc']

Powered by the Cryptowatch public API. A listing of supported markets can be found here.

About

๐Ÿ“ˆ Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%