Getting started

How to install and use Genji


Genji requires at least Go 1.18.


To install the Genji database, run this command:

go get

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

To open an in-memory database, simply type:


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.

Last modified November 15, 2023: update genji install cmd (9f3a55a)