Skip to content

CLI Installation

Quick install

bash
curl -fsSL https://tradectl.com/install.sh | sh

This detects your platform and installs the tradectl binary to ~/.tradectl/bin/.

Manual download

Download the binary for your platform from GitHub Releases:

PlatformArchitectureBinary
Linuxx86_64tradectl-linux-x86_64
Linuxaarch64tradectl-linux-aarch64
macOSIntel (x86_64)tradectl-darwin-x86_64
macOSApple Silicontradectl-darwin-aarch64
bash
chmod +x tradectl-*
mv tradectl-* ~/.tradectl/bin/tradectl

PATH setup

Add ~/.tradectl/bin to your PATH:

bash
echo 'export PATH="$HOME/.tradectl/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
bash
echo 'export PATH="$HOME/.tradectl/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Prerequisites for building strategies

Strategies are Rust crates compiled to dynamic libraries. You need the Rust toolchain (edition 2021):

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

The CLI itself is a standalone binary — no Rust required to use it.

Verify

bash
tradectl --version

Update

bash
tradectl update

The CLI checks GitHub Releases and replaces itself in place. Re-running the install script also works.

Directory layout

~/.tradectl/
├── bin/             # tradectl binary
├── lib/             # installed strategy plugins (.so / .dylib)
├── config/          # cached license token, exchange credentials (encrypted)
├── data/            # raw + prepared market data
├── logs/            # default log directory for `tradectl run`
└── lab.db           # shared SQLite for backtests / sweeps (lab + CLI)

Environment variables

VariableDefaultDescription
TRADECTL_API_URLhttps://tradectl.comPlatform API base URL
TRADECTL_DOWNLOAD_URLGitHub ReleasesOverride binary download location
LAB_PORT9200Lab dashboard port (when running tradectl-lab)

Override the API base for local development:

bash
export TRADECTL_API_URL=http://localhost:3001

tradectl — Automate Crypto Trading