- To install the DIDKit command line program on GNU/Linux, MacOS, or Windows+WSL, first install cargo.
libssl-dev, as well as
build-essential, or equivalent core toolsets if they aren't already installed.
- Then simply run
cargo installfor the given target package:
didkit-cli | didkit-http.
For example, for DIDKit CLI, run:
This will add the binary didkit to your Cargo installation (typically ~/.cargo/bin), which can be added to your system's PATH for ease of use.
We do not depend on any Rust nightly features, so our installation instructions
assume the most recent
stable version; be sure to switch the installation
nightly if the calling application or forked
source-code does depend on them.
Spruce's ssi library must be cloned alongside the
didkit repository in a
parallel directory between downloading didkit and building it.
Build DIDKit using Cargo, from root directory of DIDKit project:
This will give you the DIDKit CLI and HTTP server executables located at
target/debug/didkit-http, respectively. You can also
build and install DIDKit's components separately. Building the FFI libraries
will require additional dependencies. See the corresponding readmes linked below
for more info.
Both the CLI and HTTP server are containerised and available under
The image is private for now, so a Personal Access Token is required. Once created you can login like so:
You can use the images like CLIs:
Note: You can pass JWKs either by sharing a volume with
docker run --volume, or by passing the JWK directly with
docker run -e JWK=$MY_JWKor
docker run didkit-http --jwk $MY_JWK.
The Dockerfiles rely on having ssi in the root of
didkit (a symbolic link
will not work, unfortunately).
Then the images can be built with:
And to use them, replace
While many of the DIDKit interfaces can be installed as libraries via each language's dedicated package manager, they can also be built manually. For instructions, see the "Installation" section of each interface's dedicated page in the section to the left.