Getting started

Prerequisites

Genji requires at least Go 1.18.

Installation

To install the Genji database, run this command:

go get github.com/genjidb/genji

Golang API documentation

To learn how to embed Genji in your Go code, follow the instructions in the Go package documentation.

Try it out!

To try Genji without writing code, you can use the Genji command-line shell.

First, install it:

go install github.com/genjidb/genji/cmd/genji@latest

To open an in-memory database, simply type:

genji

You can then enter your SQL queries directly in the shell.

It is also possible to create an on-disk database by specifying a directory:

genji mydb

Next step

Once Genji is setup, follow the Genji SQL chapter to learn how to run queries.