Repository: benbjohnson/litestream

Stars: 13459

.cursorrules Copy Chapter

AGENTS.md

CLAUDE.md Copy Chapter

CLAUDE.md - Claude Code Configuration

Claude-specific optimizations for Litestream. See AGENTS.md for project documentation.

Critical Coding Rules Copy Chapter

- Always return errors, never log and continue. The only exception is DEBUG logging for best-effort operations that don't affect correctness. This is the #1 cause of PR review feedback. See docs/PATTERNS.md for the full decision framework.

Context Window Copy Chapter

With Claude's large context window, load documentation as needed:

- Start with AGENTS.md for overview and checklist
- Load docs/PATTERNS.md when writing code
- Load docs/SQLITE_INTERNALS.md for WAL/page work
- Load docs/PROVIDER_COMPATIBILITY.md for storage backend configs

Claude-Specific Resources Copy Chapter

Specialized Agents (.claude/agents/) Copy Section

- sqlite-expert.md - SQLite WAL and page management
- replica-client-developer.md - Storage backend implementation
- ltx-compaction-specialist.md - LTX format and compaction
- test-engineer.md - Testing strategies
- performance-optimizer.md - Performance optimization

Commands (.claude/commands/) Copy Section

- /analyze-ltx - Analyze LTX file structure
- /debug-ipc - Debug IPC Unix socket issues
- /debug-wal - Debug WAL replication issues
- /test-compaction - Test compaction scenarios
- /trace-replication - Trace replication flow
- /validate-replica - Validate replica client
- /add-storage-backend - Create new storage backend
- /fix-common-issues - Diagnose common problems
- /run-comprehensive-tests - Execute full test suite

Quick Commands Copy Chapter

go build -o bin/litestream ./cmd/litestream
go test -race -v ./...
pre-commit run --all-files

README.md Copy Chapter

Litestream
!GitHub release (latest by date)
!Status
!GitHub
==========

Litestream is a standalone disaster recovery tool for SQLite. It runs as a
background process and safely replicates changes incrementally to another file
or S3. Litestream only communicates with SQLite through the SQLite API so it
will not corrupt your database.

If you need support or have ideas for improving Litestream, please visit
GitHub Issues.
Please visit the Litestream web site for installation
instructions and documentation.

If you find this project interesting, please consider starring the project on
GitHub.

Contributing
------------

We welcome bug reports, fixes, and patches! Please see our Contributing Guide for details on how to contribute.

Acknowledgements
----------------

I want to give special thanks to individuals who invest much of their time and
energy into the project to help make it better:

- Thanks to Cory LaNou for giving early feedback and testing when Litestream was still pre-release.
- Thanks to Michael Lynch for digging into issues and contributing to the documentation.
- Thanks to Kurt Mackey for feedback and testing.
- Thanks to Sam Weston for figuring out how to run Litestream on Kubernetes and writing up the docs for it.
- Thanks to Rafael & Jungle Boogie for helping to get OpenBSD release builds working.
- Thanks to Simon Gottschlag, Marin,Victor Björklund, Jonathan Beri Yuri, Nathan Probst, Yann Coleu, and Nicholas Grilly for frequent feedback, testing, & support.

Huge thanks to fly.io for their support and for contributing credits for testing and development!