Installation · ZeeDB Docs

Requirements

ZeeDB requires Go 1.26 or later. The database engine uses the standard library and has no third-party runtime dependencies. You do not need Node.js to use the database; Node.js is only needed to develop this documentation website.

go version

The supported build targets are Windows, Linux, macOS, and FreeBSD. Local validation has covered Windows and Linux under WSL; macOS and FreeBSD have not been runtime-validated. See validation and testing.

Add the Go package

Run this inside your application’s Go module:

go get github.com/Berlindraft/ZeeDB

Import the package with its Go package name:

import zeedb "github.com/Berlindraft/ZeeDB"

The root package is the embedded SDK. For other languages, run the standalone HTTP server and connect over HTTP; no Go installation is required on client machines.

Install the CLI

go install github.com/Berlindraft/ZeeDB/cmd/zeedb@latest
zeedb put -h

Go places the executable in GOBIN, or the bin directory under GOPATH if GOBIN is unset. Add that directory to your PATH if your shell cannot find zeedb.

go env GOBIN GOPATH

Private repository access requires your usual Git and Go private-module configuration.

Build from source

git clone https://github.com/Berlindraft/ZeeDB.git
cd ZeeDB
go test ./...
go run ./examples/basic

Build on Linux, macOS, or FreeBSD:

go build -o zeedb ./cmd/zeedb

On Windows:

go build -o zeedb.exe ./cmd/zeedb
.\zeedb.exe put -h

You are ready to create your first database.