Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting started

Use one crate

Add it as a git dependency:

[dependencies]
libkeri = { git = "https://gitlab.vroblok.io/libkeri/libkeri.git", branch = "main" }

Work across the crates

Clone the suite and run its bootstrap script. It clones every repo next to the suite and writes a .cargo/config.toml there, so each crate builds against your local checkouts instead of what’s on GitLab:

git clone https://gitlab.vroblok.io/libkeri/libkeri-suite.git
libkeri-suite/scripts/bootstrap.sh          # or: scripts/bootstrap.sh ~/src/libkeri

Use LIBKERI_GIT=ssh to clone over SSH if you’ll push. The script leaves existing checkouts alone and never overwrites an existing .cargo/config.toml; if yours differs it writes the suggested one beside it.

A change in libkeri is then picked up by libkeri-cli, libkeri-witness and the rest on their next build, without pushing.

Build and try it

cd libkeri && cargo test                    # core tests and the keripy golden vectors
cd ../libkeri-cli && cargo install --path . # installs `krust`
krust init --name demo --nopasscode
krust incept --name demo --alias me --nopasscode
krust status --name demo --alias me

Run the interop scenarios

The scenarios need keripy’s kli on your PATH (keripy 1.2.x, for example through pyenv) and ports 5642–5644 free:

cd libkeri-interop
make           # every scenario
make 08        # one scenario
make matrix    # the delegation scenarios against keripy 1.1, 1.2 and main

make matrix also needs a keripy checkout at ../keripy; it exports each version from it without touching the checkout. See the libkeri-interop README for details.