ditto provisions isolated Postgres and MySQL copies from a scheduled source dump. It is built for teams that want production-faithful database behavior in CI, migration dry-runs, and local development without sharing a mutable staging database.
- One clean copy per run, job, or developer
- PII scrubbed once during
ditto reseed, then baked into every restored copy - Works as a local CLI or as a shared HTTP service for remote runners
ditto is a good fit when:
- you already have a Postgres or MySQL source database that the Docker runtime can reach
- your tests or migrations need real constraints, triggers, and data shape
- shared staging state is making CI or local development unreliable
- you want to keep real production data out of developer laptops and CI logs
ditto is not a good fit when:
- you only need synthetic fixtures or an in-memory test database
- you cannot expose a network-reachable source host to the machine running ditto
- you want a hosted service instead of operating a local or shared ditto host
ditto reseedwrites a compressed dump from the configured source database.ditto copy createorditto copy runrestores that dump into an ephemeral database container.ditto daemonkeeps the dump fresh and deletes expired copies.
See Architecture for the full lifecycle and trade-offs.
| Mode | Use it when | Main commands |
|---|---|---|
| Local host | The same machine can run Docker and owns the dump file | reseed, copy create, copy run, daemon |
| Shared server | CI runners or developers should request copies from a central host | serve, copy create --server=..., copy run --server=... |
brew tap attaradev/ditto
brew install --cask dittoDownload the archive for your platform from
GitHub Releases, extract it, and move the
ditto binary onto your PATH.
.deb, .rpm, and .apk packages are published on
GitHub Releases.
Requires Go 1.26+.
go install github.com/attaradev/ditto/cmd/ditto@latestgit clone https://github.com/attaradev/ditto
cd ditto
go build -o ./ditto ./cmd/ditto| Language | Install |
|---|---|
| Python 3.11+ | pip install ditto-sdk |
| Node.js 18+ | npm install @attaradev/ditto-sdk |
| Go | import "github.com/attaradev/ditto/pkg/ditto" |
Prerequisites:
- a Docker-compatible runtime on the same host as ditto
- a Postgres or MySQL source host reachable from that runtime
- a read-only dump user on that source database
If your source host is localhost, 127.0.0.1, or ::1, this quickstart will fail. Dump helpers
run inside containers, so the source must be reachable from the Docker runtime by hostname or
network address.
After installation, the shortest working path is four commands:
export DITTO_SOURCE_URL='postgres://ditto_dump:secret@db.example.com:5432/myapp'
export DITTO_DUMP_PATH="$PWD/.ditto/latest.gz"
ditto reseed
ditto copy run -- env | grep '^DATABASE_URL='What you should see:
ditto reseedcompletes without replacing the previous dump on failureditto copy runprints aDATABASE_URL=...line, proving the copy was created and injected- the copy is destroyed automatically when the command exits
Useful next commands:
ditto status
ditto erd --output schema.mmd
ditto copy run -- go test ./...For a repeatable file-based setup, move the environment variables into ditto.yaml. See
Run Your First Copy and
Configuration Reference.
| Task | Command |
|---|---|
| Run one command against a throwaway copy | ditto copy run -- go test ./... |
| Start a shell session with a persistent copy | eval "$(ditto env export)" |
| Generate an ERD from a copy | ditto erd --output schema.mmd |
| Hold a copy across CI steps | ditto copy create --format=json and later ditto copy delete <id> |
| Serve copies to remote runners | ditto serve |
| Section | Start here |
|---|---|
| Tutorials | Run your first copy |
| How-to guides | Local development, CI, Operate a host, Troubleshooting |
| Reference | Configuration, CLI |
| Explanation | Architecture |
The docs landing page is at docs/README.md.
- CI, build, integration, and markdown checks run on every push and pull request
- Security reports are handled privately; see SECURITY.md
- Release history is tracked in CHANGELOG.md
- Community expectations are in CODE_OF_CONDUCT.md
- Contributor workflow is documented in CONTRIBUTING.md