Install and build

Requirements

• Go 1.25 or newer when installing or building with Go
• Git
• A supported database only when you plan to import and query one

Install a published CLI

Install the latest published command without cloning the repository:

go install github.com/adamraziv/dataporch/cmd/dataporch@latest

For a reproducible installation, pin an exact release:

go install github.com/adamraziv/dataporch/cmd/[email protected]

Go installs the executable in GOBIN when it is set, or in the default Go bin directory otherwise. Make sure that directory is on PATH:

go env GOBIN
go env GOPATH

Installation only places the executable on your machine. It does not initialize state, create keys, register a service, or start DataPorch.

Build from source

Clone the repository and build the binary:

git clone https://github.com/adamraziv/dataporch.git
cd dataporch
make build

The output is bin/dataporch. To put the command on PATH, use:

make install
make install-check

Both installation paths produce one deployable dataporch binary and do not require sudo.

Checks before you run it

Run the full local check when you are validating a checkout or preparing a change:

make check

That target formats, checks module tidiness, vets, runs the race-enabled test suite, lints, and builds. For a shorter feedback loop, use go test ./... or make test-race.

The binary can also be compiled with CGO disabled:

make build-cgo-disabled

SQLite integration tests use a temporary database and do not need an external service. PostgreSQL and MySQL integration tests require configured DSNs for their services.