CLI | Command Line Interface

The IDP Kit provides a simple command line interface, to run and/or configure the service.

In the following sections I will show examples using the command line interface of the IDP Kit.

For the sake of readability, I will shortcut the executable command as:

waltid-idpkit

Installation & Running the Project

Make sure you have Docker or a JDK 16 build environment including Gradle installed on your machine

Docker Build

1. Cloning the project

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

2. Changing directory

cd waltid-idpkit

3. Building the project

docker build --rm -t waltid/idpkit .

4. Creating an alias (optional)

alias waltid-idpkit="docker run -p 8080:8080 -e WALTID_DATA_ROOT=/data -v $PWD:/data waltid/idpkit"

5. Running the project (with alias)

waltid-idpkit run

6. Running the project (without alias)

docker run -p 8080:8080 -e WALTID_DATA_ROOT

7. Configure the IDP Kit to your needs

IDP Kit configuration and setup

Local Build

1. Cloning the project

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

2. Changing directory

cd waltid-idpkit

3. Building the project

./gradlew build install

4. Creating an alias (optional)

alias waltid-idpkit="build/install/waltid-idpkit/bin/waltid-idpkit"

5. Running the project (with alias)

waltid-idpkit run

6. Running the project (without alias)

build/install/waltid-idpkit/bin/waltid-idpkit run

7. Configure the IDP Kit to your needs

IDP Kit configuration and setup

To get info about available options of the run command, use:

waltid-idpkit run --help

For more build options, please refer to the build section

Configuration

For configuring keys and managing verification policies, the IDP Kit integrates some commands from the SSI Kit for key and policy management.

The config command lets you define the context in which you want to execute the command, by specifying the arguments --oidc, --siop, before the respective subcommand.

E.g.

waltid-idpkit config --oidc key list

This command lists the keys available in the context of the OIDC manager.

waltid-idpkit config --siop vc policies list

This command lists the verification policies available in the context of the SIOP manager.

To get info about available options of the config command, use:

waltid-idpkit config --help

For more details about the integrated commands, you may want to refer to the documentation of the SSI Kit command line interface.