Quick Install

DIDKit CLI and HTTP Server Installation

You can build DIDKit's command-line interface and HTTP server in just a few minutes from your command line.

Prerequisites:

  • Any major GNU/Linux distribution, including MacOS or Microsoft's WSL2

Building didkit :

git clone https://github.com/spruceid/ssi --recurse-submodules
git clone https://github.com/spruceid/didkit
cd didkit/
cargo build

That's it-- you're now ready to use didkit's CLI. For comprehensive documentation of CLI commands, see GitHub, and for a more skimmable overview, see the Core Functions (CLI)) here. For example, these basic commands should confirm the installation was succesful:

./target/debug/didkit -h
./target/debug/didkit generate-ed25519-key > key.jwk

You're also ready to spin up a didkit-powered HTTP server for internal or external use, depending on your context. For comprehensive documentation of the HTTP commands, see GitHub, and for a more skimmable overview, see the HTTP Server. The HTTP server can be spun up with a single command if passed a key and some flags, and will respond with the port on which it will listen for valid calls:

./target/debug/didkit-http -k key.jwk
Listening on http://127.0.0.1:51467/

More detailed installation instructions and variants, including Docker instructions, can be found on the next page.

Last updated