CLI tooling

Explicit compile and format commands for local scripts, CI checks, and editor-independent workflows.

Use the BtrQL CLI when you want reproducible commands outside an editor. The CLI is build-time tooling only: production runs generated SQL through your normal database path.

Download a demo package

Download a PostgreSQL or ClickHouse demo package from the download page, then choose the archive matching your operating system and CPU architecture. Download the curated examples for source-only PostgreSQL and ClickHouse projects.

The demo package includes command-line compilation, formatting, and local language support binaries.

Verify the CLI

After extracting a package, verify the launcher:

./tools/btrql-postgresql/bin/btrql --help

Common workflow commands compile a file or project, format BtrQL source, and report diagnostics before SQL is written.