LogoLogo
ProductsCommunityGitHubShare Feedback
IDP Kit
IDP Kit
  • What is the IDP Kit?
    • Introduction
    • IDP Kit
      • IDP Kit | Basics
        • Overview
        • Functionality
      • Architecture
  • Getting started
    • Quick Start
    • CLI | Command Line Interface
    • REST APIs
    • Dependency (JVM)
    • Public deployments
    • Build
      • Docker
  • Demos
    • Try Login With NFT
  • Tutorials
    • Login with NFTs | Next.js
      • IDP Kit Setup
      • Client Registration
      • NFT Collection Configuration
      • Next.js
    • Login with NFTs | Keycloak
      • IDP Kit Setup
      • Client Registration
      • NFT Collection Configuration
      • Keycloak (18.0.2)
      • Keycloak (>19.0.1)
      • Frontend - Next.js
    • Login with SSI | Next.js
      • IDP Kit Setup
      • Client Registration
      • Verifiable Credential Config
      • Next.js
  • Configuration and Setup
    • IDP Kit configuration and setup
    • OIDC Manager configuration
      • Keys and signatures
      • Client registration
      • Client authentication
      • Claim configuration
    • SIOP Manager configuration
    • NFT Manager configuration
  • Concepts
    • OIDC Authentication - Recap
    • Identity provision via SSI
    • Identity provision via NFTs
      • EVM | Identity Provision
        • Sign in With Ethereum (SIWE)
      • Tezos | Identity provision via NFTs
        • Sign-In with Tezos (SIWT)
      • Near | Identity provision via NFTs
        • Sign-in with Near Protocol (SIWN)
      • Polkadot | Identity provision via NFTs
        • Sign-in with Polkadot (SIWP)
      • Flow | Identity provision via NFTs
        • Sign-in with Flow (SIWF)
      • Algorand | Identity provision via NFTs
        • Sign-in with Algorand (SIWA)
    • IAM / KeyCloak integration
  • Community
    • Discord
    • Twitter
    • Newsletter
    • GitHub Discussions
  • DEVELOPER RELATIONS
    • Contribute
    • Roadmap
    • Share Feedback
    • Contact
  • Product Editions
    • Open Source | Always Free
    • Enterprise
    • Cloud Platform
Powered by GitBook
On this page
  • Installation & Running the Project
  • Configuration

Was this helpful?

Export as PDF
  1. Getting started

CLI | Command Line Interface

PreviousQuick StartNextREST APIs

Last updated 2 months ago

Was this helpful?

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

  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

  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

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

waltid-idpkit run --help

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 build options, please refer to the

For more details about the integrated commands, you may want to refer to the documentation of the .

IDP Kit configuration and setup
IDP Kit configuration and setup
build section
SSI Kit command line interface