keplerKV

A key-value store.

Download

Each release comes with the compiled KeplerKV binary to download.

See the latest release!

Usage

See the manual for a comprehensive list of commands and see the examples page for example usage.

Developers

Working on KeplerKV requires a C++ compiler that is compatible with the C++17 standard.

Testing

A testing script is located in tests/ that takes an input and corresponding output files located in inputs/ and outputs/ respectively. To run all tests:

cd tests
bash execute_all.sh

Note: end any input file with \q as the program runs infinitely until this command is entered.

Building

Currently the project has two methods of building from scratch.

GNU Make

A Makefile is located at the root of the repository and is a quick way to build locally.

To install GNU Make with the apt package manger:

sudo apt-get install -y make

To build the KeplerKV binary from the root of the repository:

make

To clean your directory of object files and the binary:

make clean

CMake

A CMakeLists.txt is located at the root of the repository and is the preferred way to build locally.

To install CMake with the apt package manager:

sudo apt-get install -y cmake

To build the KeplerKV binary from the root of the repository:

mkdir build
cd build
cmake ..
make