A terminal-like interface for efficiently trading the market.
Planned Exchanges termcrypt currently supports:
- Bybit
- FTX (Priority)
- Binance
Right now the project is in very early development, so to test it you will most likely have to clone the source and will have to follow the steps on the build section below.
We hope you enjoy termcrypt :)
Our plans for features and fixes.
termcrypt has many utilities that are growing day by day that help interact with the market. Some of the features include:
- Multiple exchange support (in future)
- Fast Speed (Only delays are API requests)
- Order with risk-ordersize calculations
- Subaccounts
For a more comprehensive list, run help
inside of termcrypt.
Installing termcrypt is simple and it uses ~<500MB of space because it requires dependencies to compile.
-
Install rustup from https://rustup.rs/ or by using another method if your platform is not supported.
-
Run the command:
cargo install termcrypt
in a terminal. For terminal, we recommend alacritty for linux, mac and windows. We also recommend termux for android and newterm for ios (untested). -
In the terminal, run
termcrypt
. You should see it asking for API keys, followed by ascii art. If you have any troubles, make an issue.
For more information on what termcrypt can do and commands, visit termcrypt.github.io
If you would like to contribute to documentation, visit our docs repo.
As developers, we believe that accountability leads to credibility and without the codebase being open, others cannot gain full trust. In addition, proprietary software does not allow external creativity and contribution which stunts unfunded smaller projects. We also believe that there should be no barrier to to market and it should be free for everybody no matter their current financial circumstances.
Because of this, we chose the AGPL-3.0-or-later license because it is one of the strongest copyleft licenses available.
The APGL-3+ requires that termcrypt can not be used in any proprietary solution.
If you want to open a pull request, you need to follow the instructions in CONTRIBUTING.md
The Following commands require git
, rustc
and cargo
.
rustc
and cargo
are installed by default with rustup.
Make sure you have the latest rustc version by running rustup -V
.
Clone the repo and open the directory:
git clone [repo url] termcrypt
cd termcrypt
Run / Build (for your os) with cargo:
cargo run
cargo build
or, use cargo watch -q -x run
Build files will be located in target/debug
cargo install cargo-ndk
rustup target add \
aarch64-linux-android \
armv7-linux-androideabi \
x86_64-linux-android \
i686-linux-android
You also need the android sdk and ndk. You can install them by first installing android studio, and then through the sdk manager. Install the oldest sdk version, and ndk version 20.1.x. After that, run export ANDROID_NDK_HOME=~/Android/Sdk/ndk/20.1.5948944
or if ~/Android/Sdk/ndk/20.1.5948944
does not exist, find the correct directory. Then install cargo-ndk:
cargo install cargo-ndk
rustup target install aarch64-linux-android
Then you can run the following to build for android aarch64:
cargo ndk -t aarch64-linux-android build --release
Here is a one-liner: export ANDROID_NDK_HOME=~/Android/Sdk/ndk/20.1.5948944&&rustup target install aarch64-linux-android&&cargo ndk -t aarch64-linux-android build --release
This section gives credit to people that have helped substantially in the development of this project.
- fabianboesiger
- conan ⚡️
- babdou