Quickstart guide
Get up and running with Xata's open source tools. Each project can be installed independently — pick what you need.
Xata Core
Full Postgres branching platform
- 1Prerequisites: Kubernetes cluster, Helm 3, kubectl
- 2Add the Xata Helm repo: helm repo add xata https://charts.xata.io
- 3Install the control plane: helm install xata xata/xata
- 4Configure your Postgres connection in values.yaml
- 5Create your first branch: xata branch create my-feature
pgroll
Zero-downtime schema migrations
- 1Install: brew install xataio/pgroll/pgroll
- 2Initialize: pgroll init --postgres-url postgres://...
- 3Create a migration file (JSON format)
- 4Start migration: pgroll start migration.json
- 5Complete: pgroll complete or rollback: pgroll rollback
pgstream
CDC with DDL tracking
- 1Install: go install github.com/xataio/pgstream@latest
- 2Configure source Postgres and target in config.yaml
- 3Optional: add column transformers for anonymization
- 4Run: pgstream run --config config.yaml
- 5Monitor replication lag and DDL events in logs
Xata Agent
AI-powered Postgres monitoring
- 1Clone: git clone https://github.com/xataio/agent
- 2Copy .env.example to .env and configure LLM API key
- 3Set your Postgres connection string
- 4Run: docker-compose up
- 5Optional: configure Slack webhook for notifications
Need help?
Check the documentation for each project, browse the GitHub issues, or join the conversation in the xataio GitHub org.Give every agent its own Postgres branch.
Run tens of thousands of databases at a fraction of the usual cost.