Skip to content

Installation

Prerequisites

  • Nim compiler (>= 1.6.0)
  • libpg_query (for SQL parsing)

From Source

1. Install Nim

Follow the official Nim installation guide.

2. Clone the Repository

git clone https://github.com/sphildreth/decentdb.git
cd decentdb

3. Build DecentDb

nimble build

This creates the decentdb executable in the project root.

4. Run Tests

nimble test

Docker (Optional)

A Docker image is available for containerized usage:

docker build -t decentdb .
docker run -v $(pwd):/data decentdb exec --db=/data/mydb.ddb --sql="SELECT 1"

System Installation

To install system-wide:

nimble install

Or copy the binary manually:

cp decentdb /usr/local/bin/

Verify Installation

decentdb --help

You should see the help output with available commands.