Skip to content

A TUI (Terminal User Interface) client for Kraken Exchange implemented in Rust

License

Notifications You must be signed in to change notification settings

ceppelli/kraken-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kraken TUI

License: MIT rustc build status codecov

Rust By Ceppelli Logo

CLI client for the Kraken Crypto Exchange implemented in Rust

This project aim to create a simple but fast and usefull client for connecting to the Kraken Exchange API binary endpoint.

⚠️ This project is still under fluid development and must be considered as alpha version ⚠️

Rust By Ceppelli Logo

Features

Feature Status
list assets
list asset pairs
ticket info 📐
multi threaded 📐
user auth 🔮
user ballance 🔮
user open order 🔬
user cloded order 🔬
user trade history 🔮
order book 🔬
recent trades 🔬
recent spreeds 🔬
  • ✅ - completed
  • 📐 - design
  • 🔮 - planed
  • 🔬 - investigation

Building from Source

kraken-tui is written entirely in Rust and building it from source is dead simple. All you have to do is download source, install rust and build with cargo.

  1. Installing rust. Head to Rust installation. It is basically doing
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Get the source code. You can download from the archives or use git clone:
git clone https://github.com/ceppelli/kraken-tui.git
  1. cd into source root and do:
cargo build --all --release
  1. The compiled binary is located in target/release/ directory. Copy the kraken_tui binary and place it somewhere where it is easy to run. Preferrably under $PATH.

  2. kraken-tui is now ready to fire. Head over to usage


Usage

kraken-tui is single binary so it shouldn't be difficult to run. Just make sure you have installed the required dependencies.

Run kraken-tui

kraken_tui

Show help message

At any time inside the running binary press the key ? and a contextual help view will be displayed.

License

Copyright 2022-2023 Luca Ceppelli

Licensed under the MIT license <LICENSE-MIT or https://opensource.org/licenses/MIT>. Files in the project may not be copied, modified, or distributed except according to those terms.

About

A TUI (Terminal User Interface) client for Kraken Exchange implemented in Rust

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages