Skip to main content

Getting started

Installation​

The CLI requires Node.js 24 or later. Install the @europeum-ebsi/cli package globally from the rc dist-tag:

npm install -g @europeum-ebsi/cli@rc

The latest tag does not point to a usable release yet, so always install @rc or an exact version, for example @europeum-ebsi/cli@1.0.0-rc.6.

To try it without installing:

npx @europeum-ebsi/cli@rc --help

Check the installation:

ebsi --version
ebsi --help

Every group and command also accepts --help, for example ebsi ledger write --help.

Quick start​

# Check API health (defaults to the test environment)
ebsi health

# List DIDs
ebsi did-registry identifiers list

# Get a DID document
ebsi did-registry identifiers get did:ebsi:ziDnioxYYLW1a3FDD

# Run against the pilot environment (the first time, pick one of its trusted nodes)
ebsi --env pilot did-registry identifiers list

# Output compact JSON, for example to pipe it to jq
ebsi --output json did-registry identifiers list | jq '.items[].did'

Interactive mode​

Run ebsi with no arguments, or with --interactive, to open the command palette:

  • Type to filter commands by name or description.
  • Use ↑ / ↓ (or j / k) to move in the list.
  • Press Enter to run the selected command.
  • Press Esc to clear the filter.
  • Press Ctrl-C to quit.