Kwil DB

The database for Web3.

Overview

Learn more about Kwil at kwil.com.

Build instructions

Prerequisites

To build Kwil, you will need to install:

1. Go

2. Protocol Buffers (optional), with the protoc executable binary on your PATH.

3. Taskfile

4. Protocol buffers go plugins and other command line tools. The tool task will install the required versions of the tools into your GOPATH, so be sure to include GOPATH/bin on your PATH.

   task tools

Build

Invoke task command to see all available tasks. The build task will compile kwild, kwil-cli, and kwil-admin. They will be generated in .build/:

task build

Local deployment

You can start a single node network using the kwild binary built in the step above:

.build/kwild --autogen

For more information on running nodes, and how to run a multi-node network, refer to the Kwil documentation.

Resetting local deployments

By default, kwild stores all data in ~/.kwild. To reset the data on a deployment, remove the data directory while the node is stopped:

rm -r ~/.kwild

License

The kwil-db repository (i.e. everything outside of the core directory) is licensed under the Apache License, Version 2.0. See LICENSE for more details.

The kwil golang SDK (i.e. everything inside of the core directory) is licensed under the MIT License. See core/LICENSE.md for more details.