In this section, you will find documentation about the EBSI Command Line Interface you can use to interact with the EBSI services.
For optimal stability, we highly recommend to use the Node.js version 20.12.
To start the tool run:
npx @cef-ebsi/cli
When the CLI prompts ==> it will be ready to receive commands. There is no need to install the package. It needs NodeJS v18 or superior version as a prerequisite.
If you use hardware wallets to sign credentials, it's necessary to download the CLI from the repository and follow the instructions to connect your hardware wallet.
Onboard
This guide presents the steps to onboard a new legal entity in EBSI, which consists in the registration of the DID Document in the DID Registry.
Register a Trusted Issuer
Load the Legal Entity
Register a Proxy
This guide presents the steps to register a proxy of a Trusted Issuer. This proxy is used for the credential status retrieval through EBSI network. And as prerequisite the issuer must have an API to get the Verifiable Credential with StatusList2021. See an example of the verifiable credential.
Issue VC to Onboard
The verifiable authorisation to onboard is a verifiable credential that can be issued only by a Trusted Issuer registered in EBSI, and it allows the subject to register a DID Document in the DID Registry.
Issue VC for Trusted Issuer
The hierarchy to issue verifiable credentials is the following:
Issue VC/VP for TNL
The Trusted Nodes List is a list of the active node operators that have been onboarded by the Support Office. The list will be generated and signed by the Support Office before being reviewed and also signed by the Service Ops Manager. Once signed by both entities, it will be made available to the public on different channels. Here is a guide on how to issue the credential and the presentation.
Create a Document
Track and Trace API is used to timestamp documents and write events on top of it. The timestamp can be taken from the blockchain or can be linked to external sources with its corresponding proof. With this guide you will be able to create a document, grant access to other accounts, and write events.
Create a Timestamp
Timestamp API will help you to timestamp individual data, track document versions, and validate already existing timestamps.
Connect Hardware Wallet
It is recommended to store your keys in hardware wallets. It's one of the safest ways of creating signatures without exposing sensitive data. This guide will show you how to connect your hardware wallet in the CLI. It uses the PCKS11 standard for the communication.
Commands reference
This section describe the complete list of commands that can be called in the command line interface.
CLI guidelines
Explore our CLI guidelines.