Skip to content

Build from source

The project recommends linuxbrew for setting up a Linux development environment. You need:

  • Rust 2024 stable, with the compiler and tooling
  • Git, to clone the repository
  • k6, for the newer benchmarks

No external dependencies:

Terminal window
make build

This gives you the command line interface for interactive local use.

Terminal window
make build-server

The first compile downloads and builds all dependencies. On a modern machine this is fast in absolute terms but still noticeable the first time; subsequent builds are much quicker.

Kallisto exposes two, and it is worth knowing which you are building:

  • CLI — interactive local usage.
  • Server — HTTP API for deployment, speaking the Vault KV-v2 contract.

If you are contributing and want to build the image locally rather than pulling it:

Terminal window
docker build . \
-t kallisto-server:latest \
-f Dockerfile

Or through the Makefile:

Terminal window
make docker-build
TargetPurpose
make buildCore CLI build
make build-serverHTTP server build
make testRun the test suite
make e2eEnd-to-end tests
make cleanRemove build artifacts
make docker-buildBuild the container image
make docker-runRun the container
make docker-testRun tests in a container
make docs-serveServe the project’s Hugo docs locally
make docs-buildBuild the project’s Hugo docs
make helpList available targets

Benchmark targets are covered separately in run the benchmarks.