CLI | Command Line Interface

Manage keys, DIDs, issue Verifiable Credentials, and verify them using the SSI-Kit command line tool.

Installation & Running the Project

Choose between a Docker or a JVM-based runtime.

Docker

Make sure you have Docker build environment installed on your machine.

1. Pulling the project directly from DockerHub

docker pull waltid/ssikit

2. Setting and alias for convenience

alias ssikit="docker container run -p 7000-7004:7000-7004 -itv $(pwd)/data:/app/data docker.io/waltid/ssikit"

3. Getting an overview of the commands and options available

ssikit -h

Local

Make sure you have a JDK 16+ build environment including Gradle installed on your machine.

1. Clone the project

git clone https://github.com/walt-id/waltid-ssikit.git

2. Change the folder

cd waltid-ssikit/

3. Run the project

The first time you run the command you will be asked to built the project. You can confirm the prompt.

./ssikit.sh -h

You will now see an overview of all the different commands and options available.

4. Set an alias

To make it more convient to use, you can also set an alias as follows for the wrapper script:

alias ssikit="./ssikit.sh"

5. Get the overview again

ssikit -h

If you want to get a more detailed overview of the options provided for building the project on your machine, please refer to building the project.

Response configuration

For debug infos add "-v" e.g.:

ssikit -v

ssikit -v did create

Getting Started

Explore the components of the SSI Kit and their functionality:

• Key Management
• Decentralized Identifiers
• Verifiable Credentials
• OpenID Connect (OIDC)