Agent index (llms.txt) — fetch this first, then the page it names.

orama network

Choose which network the CLI talks to: a cluster by its gateway, or a network of the registry by its manifest. Every command and flag below comes from the orama command tree, so it matches the binary.

Global conventions are on the CLI overview.

orama maint network

Maintain the published networks

text
orama maint network

Subcommands: announce, publish

orama maint network announce

Write networks/<name>/ for a network that does not exist yet

text
orama maint network announce [flags]
text
Write networks/<name>/ (release-root.json and, last, manifest.json) for a
network whose chain has not been created: its name, the chain id it will have, the
channel, the release repository and the release root its releases are verified
against, whether it has a faucet, and its seeds. The manifest pins no genesis, so
the network is listed but cannot be joined: 'orama setup --network <name>' says it
has not been created yet.

The person who creates the network then runs 'orama setup --create-network <name>'
with no --release-root: the chain id, the release repository, the channel and the
release root come from the announcement (a flag overrides). When the chain exists
the creation publishes the full manifest, with the genesis, over the announcement.

An announcement can be written again until the network is created. A network that
is already created is refused: a reset needs a new chain id from the creation.

Afterwards run 'make -C core sync-networks' so the binary embeds the manifest, and
commit networks/ and core/pkg/netregistry/embedded/ together.
FlagDefaultDescription
--chain-id—The chain id the network will have [required]
--channel—Release channel: nightly, main or dev/&lt;branch> [required]
--dirnetworksThe repository's networks directory
--faucetfalseThe network funds new operators from a faucet
--min-version0.3.0Oldest orama version that may join, X.Y.Z
--name—Network name, for example stagenet [required]
--release-repo—https base URL of the release repository [required]
--release-root—The release-root.json file its releases are verified against [required]
--seed—A seed DNS name (repeatable; default: the creator's ns&lt;N>.&lt;name>.orama.network)

orama maint network publish

Write networks/&lt;name>/ for a chain that was just deployed

text
orama maint network publish [flags]
text
Write networks/<name>/ (genesis.json, release-root.json, tor-network.json when the
network has one and, last, manifest.json) from the genesis a deploy built, for
the chain id it was built under. The manifest carries the SHA-256 of the genesis,
of the release root and of the Tor network file, so what a joining operator
fetches can be checked. --tor-network pins the network's Tor network file
(tor-network.json, the private Orama Tor network its relays join), which
'orama setup' then gives to every relay it installs; the Tor network is a
different thing from the chain, so a reset of the chain keeps the file.

An unset field keeps its value from the manifest already published; the first
publish of a network sets --seeds, --channel, --min-version, --release-repo and
--release-root. A chain id that is already published keeps its genesis: a reset
of the network needs a new chain id (orama-stagenet-5 becomes orama-stagenet-6),
and publishing the old id with another genesis is refused.

Afterwards run 'make -C core sync-networks' so the binary embeds the new manifest,
and commit networks/ and core/pkg/netregistry/embedded/ together.
FlagDefaultDescription
--chain-id—The chain id the genesis was built under [required]
--channel—Release channel: nightly, main or dev/&lt;branch> (default: the published one)
--dirnetworksThe repository's networks directory
--faucetfalseWhether the network funds new operators from a faucet (default: the published one)
--genesis—The genesis.json file [required]
--min-version—Oldest orama version that may join, X.Y.Z (default: the published one)
--name—Network name, for example stagenet [required]
--release-repo—https base URL of the release repository (default: the published one)
--release-root—The release-root.json file (default: the published one)
--seeds—Seed DNS names, comma-separated (default: the published ones)
--tor-network—The Tor network's tor-network.json (default: the published one, if any)

orama network

Choose the network the CLI talks to

text
orama network
text
List, choose, add and remove the networks the CLI knows.

A network is a name for something you can reach: a cluster, through its
gateway, and, for a network of the registry such as stagenet, the chain it runs,
the seeds to join through and the release root its software is verified against.
Every other command talks to the active network, or to the one --env names.

  orama network list                          every network and where it comes from
  orama network use <name>                    make one active
  orama network add <name> <gateway-url>      reach a cluster by its gateway
  orama network add <manifest-url>            trust a network that publishes a manifest
  orama network current                       the active network
  orama network remove <name>                 forget one

Subcommands: add, current, list, remove, use

orama network add

Add a network by its manifest, or a cluster by its gateway

text
orama network add <manifest-url> | <name> <gateway-url> [description] [flags]
text
Add a network, one of two ways.

With one argument, a manifest URL: https://<host>/<path>/manifest.json. The
manifest names the chain id, the genesis digest, the seeds, the release channel
and the digest of the release root the network's software is verified against.
The command fetches it (https only, size-bounded) and the release-root.json
beside it, checks the root against the digest, shows the chain id and the digest,
and asks you to type yes. Nothing is stored before that. --yes confirms for a
script; the digest is then the only thing you trust, so a script should pass the
URL of a manifest it already checked.

With a name and a gateway URL, a cluster you reach through that gateway (and an
optional description). The URL must be https:// with a host (http:// only for a
gateway on this machine: localhost or a loopback address), because every command
sends its credential there. --ca-file trusts a PEM bundle for this gateway's
domain and every name under it, in addition to the system roots: a cluster on
Let's Encrypt's staging CA, or on a private CA. It is not trusted for any other
host. --network records which registry network the cluster runs on.
FlagDefaultDescription
--ca-file—PEM CA bundle to trust for this gateway's domain only
--network—Registry network this cluster runs on
--yesfalseTrust the manifest's network without asking

orama network current

Show the active network

text
orama network current

orama network list

List every network and where it comes from

text
orama network list
text
List the networks of the registry (built into this binary or added by URL) and the
gateways you configured, one row each. A name that is both shows both. The active
network is marked with *.

orama network remove

Forget a network

text
orama network remove <name>
text
Forget the network of that name: the one you added by URL and the gateway you
configured, whichever exist. A network built into this binary stays in the list.
A name that is neither is not an error.

orama network use

Make a network the active one

text
orama network use <name>