Skip to content
Odal Node
Alpha — Odal Node is in active development. APIs, schemas, and docs may and will change before 1.0.

The CLI

odal is the command-line tool for operating a node. It is how you set a node up, work with passports, and keep an eye on it — interactively for a person, or scripted for CI. Running odal with no arguments starts a guided session; every step also has a direct command.

What you can do with it

  • Set up a node — connect, build and start the services, and onboard your operator identity, which mints your first API key.
  • Work with passports — import product data, validate drafts against the sector rules, publish (which signs and makes them resolvable), and move a passport through its lifecycle when something changes.
  • Manage access — create and revoke API keys, and view or update your operator details.
  • Work across nodes — keep named profiles for more than one node (for example a local one and a production one) and switch between them.
  • Check health — see at a glance whether the node and its services are up.

Discoverability

The CLI is self-describing: odal --help, and --help on any command, lists what’s available in your version. The commands are the authoritative reference; this page is the map.