Getting Started

Install

With PDM:

pdm install -G :all

With pip:

pip install "sqldbagent[cli,postgres,langchain,langgraph,mcp,dashboard,docs,test]"

Start Local Infra

make up
make demo-migrate

That raises the local integration stack declared in infra/compose.integration.yaml, including the demo Postgres database and Qdrant.

Common First Commands

pdm run sqldbagent config validate
pdm run sqldbagent inspect tables postgres_demo --schema public
pdm run sqldbagent snapshot create postgres_demo public
pdm run sqldbagent prompt export postgres_demo public
make dashboard-demo

What to Expect

  • Snapshots are stored under var/sqldbagent/snapshots/<datasource>/<schema>/.

  • Document bundles are stored under var/sqldbagent/documents/<datasource>/<schema>/.

  • Prompt bundles are stored under var/sqldbagent/prompts/<datasource>/<schema>/.

  • Retrieval manifests are stored under var/sqldbagent/vectorstores/<datasource>/<schema>/.