Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ceppelli/kraken-tui

A TUI (Terminal User Interface) client for Kraken Exchange implemented in Rust
https://github.com/ceppelli/kraken-tui

blockchain kraken rust rust-lang

Last synced: 19 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/ceppelli/kraken-tui
Owner: ceppelli
License: mit
Created: 2023-01-02T23:42:45.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-04-19T16:43:08.000Z (over 1 year ago)
Last Synced: 2024-11-05T19:58:47.976Z (2 months ago)
Topics: blockchain, kraken, rust, rust-lang
Language: Rust
Homepage:
Size: 825 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Kraken TUI

[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](#license)

[![rustc](https://img.shields.io/badge/rustc-1.65+-blue?style=flat-square&logo=rust)](https://www.rust-lang.org)

[![build status](https://github.com/ceppelli/kraken-tui/actions/workflows/rust.yml/badge.svg)](https://github.com/ceppelli/kraken-tui/actions/workflows/rust.yml)

[![codecov](https://codecov.io/gh/ceppelli/kraken-tui/branch/main/graph/badge.svg?token=YMVE0GDCNO)](https://codecov.io/gh/ceppelli/kraken-tui)

![Rust By Ceppelli Logo](assets/rust-by-ceppelli-128x128.png)

### 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](assets/kraken-tui.gif)

## 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](https://www.rust-lang.org/tools/install). It is basically doing

```

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

```

2) Get the source code. You can [download from the archives]() or use git clone:

```

git clone https://github.com/ceppelli/kraken-tui.git

```

3) `cd` into source root and do:

```

cargo build --all --release

```

4) 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`.

5) kraken-tui is now ready to fire. [Head over to usage](#usage)

---

## Usage

kraken-tui is single binary so it shouldn't be difficult to run. Just make sure you have [installed the required dependencies](#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

. Files in the project may not be

copied, modified, or distributed except according to those terms.