Litestream Files

Platform Support

⚠️ Windows Notice: Windows binaries are provided for convenience but Windows is NOT an officially supported platform. Use at your own risk. Community contributions for Windows improvements are welcome.

✅ Supported Platforms: Linux (amd64, arm64, armv6, armv7), macOS (amd64, arm64)

Installation

Homebrew (macOS and Linux)

:::bash
brew tap benbjohnson/litestream
brew install litestream

Debian/Ubuntu

Download the .deb file for your architecture and install:

:::bash
sudo dpkg -i litestream-*.deb

RPM-based systems

Download the .rpm file for your architecture and install:

:::bash
sudo rpm -i litestream-*.rpm

Binary installation

Download the appropriate archive for your platform, extract, and move to your PATH.

VFS Extension (Experimental)

SQLite loadable extensions for read-only access to Litestream replicas are available for supported platforms:

Install via package managers:

:::bash
pip install litestream-vfs    # Python
npm install litestream-vfs    # Node.js
gem install litestream-vfs    # Ruby

Changelog

• [817ebb] docs(cli): add databases help examples (#1243)
• [e26616] docs(cli): add info help examples (#1242)
• [265be7] docs(cli): add list help examples (#1241)
• [3a9df4] docs(cli): add register help examples (#1237)
• [739312] docs(cli): add start stop help examples (#1239)
• [5bd5ca] docs(cli): add status help examples (#1246)
• [72d753] docs(cli): add sync help examples (#1240)
• [7c6395] docs(cli): add unregister help examples (#1238)
• [d932bc] docs(cli): document json output schemas (#1250)
• [2e8c73] feat(cli): add databases json output (#1247)
• [eeb380] feat(cli): add ltx json output (#1248)
• [2d38d2] feat(cli): add register success payload (#1255)
• [8aa794] feat(cli): add reset dry run (#1252)
• [fbe173] feat(cli): add restore dry run (#1251)
• [30c039] feat(cli): add restore json output (#1249)
• [64e875] feat(cli): add start stop success payload (#1256)
• [19d606] feat(cli): add status json output (#1245)
• [a08a5e] feat(cli): add sync success payload (#1257)
• [fd4b60] feat(cli): add unregister dry run (#1253)
• [dd5901] feat(cli): add unregister success payload (#1258)
• [552672] feat(cli): guard restore overwrites (#1254)
• [0de07a] feat(db): expose sync diagnostics (#1287)
• [9cc2f2] fix(build): bump Go toolchain to 1.25.9 for stdlib vulns (#1235)
• [6ebcac] fix(cli): add try hints for required flags (#1236)
• [dbcd1a] fix(cli): clarify register idempotency (#1259)
• [8e9b90] fix(cli): clarify unregister idempotency (#1261)
• [fc050c] fix(cli): exit 0 for explicit help (#1233)
• [853cbf] fix(cli): make start stop idempotent (#1260)
• [4784cc] fix(cli): polish agent-facing errors (#1297)
• [edc432] fix(compactor): close pipe on upload failure (#1286)
• [c32f63] fix(config): honor database snapshot settings (#1285)
• [4cb2d7] fix(deps): bump x/crypto and x/net to clear govulncheck (#1294)
• [a590e0] fix(restore): check for wal segment gaps in v3 restore (#1230)
• [c28a31] fix(restore): clean failed restore temp file (#1282)
• [d4c00e] fix(restore): retry initial ltx opens (#1284)
• [a25a11] fix(security): bump Go 1.25.10 + deps to clear govulncheck (#1283)
• [6b8bb0] refactor(db): return sync results explicitly (#1224)
• [0c670d] test(cli): drop static-string usage tests, restore captureStdout helper (#1295)