CLI | EBSI hub

In this section, you will find documentation about the EBSI Command Line Interface you can use to interact with the EBSI services.

Attention

For optimal stability, we highly recommend to use the Node.js version v22.

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 requires Node.js v18 or a 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.

Quick Start Guide

Start the CLI: Run npx @cef-ebsi/cli
Set environment: Use env test, env pilot, or env production
Load a user: Use using user ES256K did1 <private-key> <did>
Begin operations: Start with onboarding tutorials or CLI commands

Documentation Structure

CLI Commands: Complete reference for all available commands
Onboarding Tutorial: Step-by-step guide to become a trusted issuer
Document Tutorials: Learn document management and timestamping
Support Office Tutorials: Administrative operations and self-attestation
Hardware Wallet Setup: Secure key management

Clone the Repository (Optional)

Cloning the repository is not required to use the CLI, as npx @cef-ebsi/cli works without any local installation. However, cloning the code allows you to:

Customize the CLI to your specific needs
Integrate hardware wallets for enhanced security
Contribute to development or report issues
Access the latest features before they're published to npm

To clone the repository:

git clone https://code.europa.eu/ebsi/public/cli.git
cd cli

Installation from Source

After cloning the repository:

# Install dependencies
yarn install

# Build the project
yarn build

# Run the CLI locally
yarn start

Configuration for Administrators

If you're an administrator or need advanced configuration, check the .env.example file for available environment variables. This allows you to:

Set a Besu provider to bypass the APIs and connect directly to the blockchain
Configure different contract addresses for custom deployments
Customize other administrative settings as needed

Copy .env.example to .env and modify the values according to your requirements:

cp .env.example .env
# Edit .env with your preferred settings

Support Office Tutorials

Step-by-step tutorials for Support Office operations.

Browse tutorials

Onboarding Tutorial

Step-by-step guides for EBSI onboarding processes.

Browse tutorials

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 using the PKCS#11 standard for communication.

Read document