This section provides a comprehensive reference for all available CLI commands organized by functionality. The EBSI CLI offers powerful tools for interacting with various EBSI services, managing credentials, and performing cryptographic operations.
Getting Started
Before using the CLI commands, make sure you have:
- Node.js v22 installed (recommended for optimal stability)
- Basic understanding of EBSI concepts and services
- Access credentials for the EBSI environment you want to use
Quick Start
# Start the CLI
npx @cef-ebsi/cli
# Set your environment
env test
# Load a user
using user ES256K did1
Command Categories
The CLI commands are organized into the following categories:
- Configuration: Environment setup and session management
- Wallet: User authentication and token management
- Variables: Data storage and retrieval
- Load/Export: File system operations
- Scripts: Batch command execution
- Compute: Cryptographic and utility operations
- Hardware Wallet: Hardware security module integration
- API Commands: Direct interaction with EBSI services
- Trusted Nodes List: Tool for Trusted Nodes List
Related Documentation
- Onboarding Tutorial: Complete step-by-step guide to become a trusted issuer
- Document Tutorials: Learn document management and timestamping
- Support Office Tutorials: Administrative operations
- Hardware Wallet Setup: Secure key management with hardware wallets
Configuration
Commands for configuring the CLI environment and managing sessions.
Wallet
Commands for managing user authentication and tokens in the CLI. The wallet contains your cryptographic keys and DID (Decentralized Identifier) that are used throughout EBSI operations.
Hardware Wallet
You can use hardware wallets in EBSI to sign ES256 credentials and presentation. For the installation of your hardware wallet in the CLI, follow the Instruction to install OpenSC and OpenPGP app.
Variables
Commands for managing variables and viewing stored data.
Scripts
Commands for running script files with multiple commands.
Load and Export
Set of functions to read and write data in the file system.
Compute Commands
Cryptographic operations and utility functions.
Authorisation API
OpenAPI documentation
Ledger API
OpenAPI documentation
DID Registry API
OpenAPI documentation
Timestamp API
OpenAPI documentation
Track and Trace API
OpenAPI documentation
Trusted Issuers Registry API
OpenAPI documentation
Trusted Schemas Registry API
OpenAPI documentation
Trusted Policies Registry API
OpenAPI documentation
Conformance Commands
Set of instructions to interact with the conformance service. Check also the scripts located in scripts/wctv3 with complete flows.
Trusted Nodes List
This tool is used by Support Office and the Service Ops Manager to check the status of the nodes in the network.