cli-candlestick-chart

• Features
• API Usage
• Binary Usage
• Examples

Features

• Customizable
• Auto-fit to terminal size
• Shipped as library with simple API
• Shipped as binary for standalone usage

API Usage

Add this to your Cargo.toml

[dependencies]
cli-candlestick-chart = "0.3"

…

Binary Usage

Download the latest release for your platform here

…

When requesting the CSV file mode, the library expects a CSV file with open,high,low,close headers fields.

When requesting the JSON or stdin mode, the library expects a JSON with the following format :

[
  {
    "open": 28994.009766,
    "high": 29600.626953,
    "low": 28803.585938,
    "close": 29374.152344,
    "volume": 13456 // Optional 
  },
  ...
]

Examples

API

Basic example with CSV parsing : Run with cargo run --example basic-with-csv-parsing --features=serde,csv

Fetch candles from binance : Run with cargo run --example fetch-from-binance --features=serde,reqwest

Binary

• Read CSV from file :

./cli-candlestick-chart \
    --mode=csv-file \
    -f=./examples/BTC-USD.csv \
    --chart-name="My BTC Chart" \
    --bear-color="#b967ff" \
    --bull-color="ff6b99"

• Read from stdin :

echo '[
  {
    "open": 28994.009766,
    "high": 29600.626953,
    "low": 28803.585938,
    "close": 29374.152344
  },
  {
    "open": 29376.455078,
    "high": 33155.117188,
    "low": 29091.181641,
    "close": 32127.267578
  }
]' | ./cli-candlestick-chart \
    --mode=stdin \
    --chart-name="My BTC Chart" \
    --bear-color="#b967ff" \
    --bull-color="ff6b99"

Other versions

If you prefer Python, there is a port of the library, developed by BoboTiG, right there : https://github.com/BoboTiG/py-candlestick-chart