Giter Club home page Giter Club logo

cli-crypto-charts's Introduction

Terminal crypto charts

View cryptocurrency charts in your terminal.

This app allows you to monitor 3 crypto trading pairs in your terminal.

Each trading pair has a corresponding line chart, price information, percentage change over time and live trading data.

Currently only supports GDAX exchange.

screenshot

Requirements

Node.js

Look up how to install Node.js on your system here: https://nodejs.org/en/download/package-manager/

Screen >= 22" recommended

Installation

git clone https://github.com/smoove/cli-crypto-charts.git
cd cli-crypto-charts
npm install

Configuration

Edit the file config.ini in the application's directory.

Explanations can be found inside the file.

Running

./cryptocharts.js or node cryptocharts.js

Interface

Charts

The line charts display the trading pairs you specified in the configuration. The timeframe/scale of each chart depends on the granularity setting of the corresponding pair

By default, the last candle in the chart is updated/animated using live trading data, if you don't like this behaviour, you can disable it in the configuration.

Table 'Chart stats'

  • current: Current exchange rate of the pair (rate of the last candle).
  • low: Lowest exchange rate in the chart's timeframe.
  • high: Highest exchange rate in the chart's timeframe.
  • average: Average exchange rate in the chart's timeframe.
  • % of average: Current exchange rate in relation to average exchange rate.

Table 'Change'

Displays percentage change in multiple timeframes. The timeframes shown depend on the granularity setting of each chart/pair.

Table 'Live trades & running totals'

Displays the latest trade for each pair and keeps track of running totals.

  • last: Price of latest trade.
  • side: Whether the latest trade was a buy order or sell.
  • size: Amount of coins exchanged in latest trade.
  • coins bought: The running total of coins bought during the app's runtime.
  • coins sold: The running total of coins sold during the app's runtime.
  • buys: The running total of buy side trades during the app's runtime.
  • sells: The running total of sell side trades during the app's runtime.

Known issues

  • The main chart line's color bleeds into the average line when they get close or cross due to the way blessed renders charts. Ignore the colored parts of the average lines.
  • Resizing the terminal window messes up chart rendering. Please resize the terminal window before starting the application.
  • If either your internet connection drops, or GDAX's websocket goes down, the app currently does not reconnect, thus stopping the live trade updates until the app is restarted.

License

This application is licensed under the MIT License

cli-crypto-charts's People

Contributors

james-c avatar smoove avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.