The CLI

odal is the command-line tool for operating a node: setting it up, working with passports, and keeping an eye on it. Run it with no arguments for the interactive console, where every task is a menu entry; every entry is also a direct command, so the same work scripts cleanly in CI.

The CLI is the reference

odal --help, and --help on any command, lists exactly what your version supports. Where this page and --help differ, --help is right.

Setting up and running a node

Command	What it does
odal init	Save connection settings and scaffold the compose file (for scripting; people can just run odal)
odal up · down	Start or stop the services. Inside a clone it builds from source. Outside one it pulls the ready-made images, which are not public yet
odal status	Health of every service, and the node’s trust posture: which services are real and which are stand-ins
odal update	Rebuild the node and resolver from the source in your clone and restart them
odal bootstrap	Onboard the operator and mint the first API key
odal whoami	What the configured API key actually is: its identity and scope
odal profile	Named connection profiles for more than one node (list, show, use, create, remove, rename)
odal key	API keys (create, list, revoke, use); a new key’s secret is shown once

Your operator identity

Command	What it does
odal operator	Show or set the operator configuration
odal operator-id	Economic-operator identifiers; the primary one is stamped on new passports
odal facility	Facilities, such as a GLN; the default one is stamped on new passports

See Your operator identity.

Passports

Command	What it does
odal template <group>	The CSV header row an import expects
odal passport import	Import CSV, TSV or JSON; every row becomes a draft
odal passport validate	Check drafts, or dry-run a passport body from a file
odal passport publish	Sign and publish drafts
odal passport list · find	List or search passports; find one by its business identity
odal passport lint	Re-run the plausibility checks; advisory, never blocks publishing
odal passport amend · supersede	Correct a published passport with a successor, or supersede it with one that exists
odal passport suspend · retire · eol	Suspend, retire, or declare end of life
odal passport transfer	Hand responsibility to another operator (initiate, accept, reject, cancel)
odal passport tree	Walk and verify a product’s component tree
odal passport history	A passport’s audit trail
odal passport evidence	Generate a signed evidence dossier
odal passport export	Export passports as JSON or CSV
odal passport stats	One passport’s scan counts

See Importing product data, A passport’s lifecycle and Handing over responsibility.

Proof and trust

Command	What it does
odal verify <id|file>	Check an evidence dossier against the node
odal snapshot verify	Check a continuity snapshot’s signed time bound, when the node itself is unreachable
odal seal status · repair	Sealing state, and a replacement seal for one that no longer verifies
odal registry	EU registry sync status, operator-wide or per passport
odal credential issue	Issue an access credential to a repairer, recycler or other holder of a legitimate interest

See Proof files and verification, Electronic seals and Access credentials.

Rules, integrations and reports

Command	What it does
odal product-group	Which product groups need a passport, from when, and under which acts (list, show)
odal schema	Schema versions this node serves (check, list, show)
odal plugin install	Install a signed product-group plugin, hot-swapped with no restart
odal ruleset reload	Take the latest signed ruleset bundle now
odal webhook	Signed outbound event deliveries (list, add, test, remove)
odal stats	Operator-wide scan counts
odal unsold-goods	Record and list lines of the unsold-goods disclosure

See Product groups & plugins, Integrations and statistics and The unsold-goods disclosure.

Read next

• Quick Start: the fastest path from clone to first passport.
• Self-Hosting: the setup flow in context.