Installation
APT (Debian/Ubuntu)
Section titled “APT (Debian/Ubuntu)”# Import the signing keycurl -fsSL https://saxy.github.io/tellstone-apt/key.gpg \ | sudo gpg --dearmor -o /usr/share/keyrings/tellstone.gpg
# Add the repositoryecho "deb [signed-by=/usr/share/keyrings/tellstone.gpg] https://saxy.github.io/tellstone-apt stable main" \ | sudo tee /etc/apt/sources.list.d/tellstone.list
# Installsudo apt update && sudo apt install tellstoneHomebrew (macOS/Linux)
Section titled “Homebrew (macOS/Linux)”brew tap Saxy/tellstone-tapbrew install --cask Saxy/tellstone-tap/tellstoneBinary downloads
Section titled “Binary downloads”Pre-built binaries for Linux, macOS, and Windows (amd64/arm64) are available on the GitHub Releases page.
# Example: Linux amd64curl -fsSL https://github.com/Saxy/Tellstone/releases/latest/download/tellstone_1.0.0_linux_amd64.tar.gz \ | tar xzsudo mv tellstone /usr/local/bin/Verify the installation:
tellstone --versionBuild from source
Section titled “Build from source”Prerequisites
Section titled “Prerequisites”- Go 1.26+
- Optional:
task(go-task) for the shortcuts below - Optional, for RESP benchmarking:
redis-cli,memtier_benchmark, orredis-tools
git clone https://github.com/Saxy/Tellstonecd Tellstonetask build # -> ./bin/tellstoneWithout task, build directly with Go:
go build -o bin/tellstone ./cmd/tellstonetask run # binary protocol on 127.0.0.1:9988task run:resp # binary on :9988 + Redis-compatible RESP on :6379Or run the binary directly with flags or environment variables:
./bin/tellstone --addr 127.0.0.1:9988 --enable-resp --resp-addr 127.0.0.1:6379TSD_ADDR=127.0.0.1:9988 TSD_ENABLE_RESP=true ./bin/tellstoneSee Configuration for the full list of flags and environment variables.
Advanced Configuration
Section titled “Advanced Configuration”For production deployments, consider setting additional environment variables:
TSD_GC_PERCENT=-1to disable Go’s garbage collector for maximum performanceTSD_MEM_LIMIT_BYTESto set a memory ceiling for the Go runtimeTSD_ENABLE_PROFILING=1to enable pprof profiling on 127.0.0.1:6060TSD_ENABLE_PERSISTENCE=trueto enable WAL persistence for crash recovery
Next: run through the quickstart to store and read your first key.