Installation

Docker (no Rust required)

The quickest way to try sqltgen without installing anything. The sqltgen/sqltgen image on Docker Hub contains only the binary and its runtime — no shell, no package manager.

Run from your project root, mounting the current directory as /workspace:

docker run --rm -v $(pwd):/workspace sqltgen/sqltgen generate --config sqltgen.json

For convenience, wrap it in a shell script and put it on your $PATH:

#!/bin/sh
exec docker run --rm -v "$(pwd):/workspace" sqltgen/sqltgen "$@"

Tags: edge tracks the latest commit on main and is updated on every push. Versioned tags (v0.1.0, etc.) will be added with each stable release.

Build from source

The simplest install method. Requires a Rust stable toolchain.

git clone https://github.com/sqltgen/sqltgen.git
cd sqltgen
cargo build --release

The binary lands at target/release/sqltgen. Copy it anywhere on your PATH:

cp target/release/sqltgen ~/.local/bin/

cargo install

If you have Rust installed, cargo install fetches and compiles sqltgen from crates.io:

cargo install sqltgen

The binary is placed in ~/.cargo/bin/, which is on your PATH if you installed Rust via rustup.

Homebrew (macOS / Linux)

Distribution packages are planned for v0.1.0. This section will be updated when they are available.

brew install sqltgen/tap/sqltgen

curl / pre-built binaries

Pre-built binaries for Linux (x86_64, aarch64), macOS (x86_64, Apple Silicon), and Windows are available on the GitHub releases page.

# Linux x86_64 — replace VERSION with the latest release tag
curl -L https://github.com/sqltgen/sqltgen/releases/download/VERSION/sqltgen-x86_64-unknown-linux-musl.tar.gz \
  | tar xz
chmod +x sqltgen
sudo mv sqltgen /usr/local/bin/

.deb / .rpm packages

Planned for v0.1.0.

# Debian / Ubuntu
sudo dpkg -i sqltgen_VERSION_amd64.deb

# Fedora / RHEL
sudo rpm -i sqltgen-VERSION.x86_64.rpm

Verify the installation

sqltgen --version

Expected output: sqltgen VERSION