CLI / oroc update info

oroc update info

Query update servers or static manifests over HTTP/TCP/UDP.

Usage#

oroc update info [--transport=<http|tcp|udp>] [options]

Options#

Option Description
--config=<path> use an explicit oro.toml/oro.ini file for local CHECK request defaults
--transport=<http|tcp|udp> transport to use (default: http)
--http shorthand for --transport=http
--tcp shorthand for --transport=tcp
--udp shorthand for --transport=udp
--follow-manifest when contacting servers, follow 'manifestUrl' in the RESPONSE and fetch/validate that manifest over HTTP(S)
--timeout-ms=<ms> optional timeout for TCP/UDP CHECK requests (0 = no timeout)
--manifest-url=<url> HTTP(S) URL of a manifest.json hosted statically
--signature-url=<url> optional HTTP(S) URL of the corresponding signature JSON (default: derived from --manifest-url)
--keys=<file> JSON file containing a public key ("publicKey" or "key" field) for manifest verification
--public-key=<hex> Ed25519 public key as a hex string for manifest verification
--host=<host> host for HTTP/TCP/UDP update servers (default: 127.0.0.1)
--port=<port> port for HTTP/TCP/UDP update servers (default: 8080)
--app-id=<id> application identifier to send in CHECK messages (default: active config meta.bundle_identifier when available)
--channel=<name> update channel hint (default: active config update_channel or "stable")
--current-version=<version> current application version hint (default: active config meta.version when available)
--runtime-version=<version> runtime version hint advertised in CHECK (optional)
--platform=<id> platform hint advertised in CHECK (optional)
--arch=<id> architecture hint advertised in CHECK (optional)
--log-file=<path> mirror logs to a JSON file
-h, --help show help

Notes#

  • With '--manifest-url', this command fetches and pretty-prints a manifest JSON and reports whether a signature file is reachable. When '--keys' or '--public-key' is provided and libsodium is available, it also verifies the manifest signature before printing.
  • With HTTP/TCP/UDP transports and no '--manifest-url', it sends a CHECK message to an update server and pretty-prints the RESPONSE JSON. With '--follow-manifest', if the RESPONSE includes a 'manifestUrl', it will fetch, validate, and optionally verify that manifest as well. When '--app-id' is provided, the fetched manifest must have a matching 'appId' or the command exits with an error.
  • When building a CHECK request and '--config' is omitted, this command looks for oro.toml first and falls back to oro.ini in the current workspace to derive app-id, channel, and current-version defaults. Outside a project workspace, pass those values explicitly.
  • When using TCP/UDP, '--timeout-ms' can be used to bound how long the client waits for a response.
  • The flags '--http', '--tcp', and '--udp' are shorthands for '--transport=http', '--transport=tcp', and '--transport=udp' respectively.

Examples#

oroc update info --manifest-url https://cdn.example.com/app/manifest.json

inspect a statically hosted manifest

oroc update info --manifest-url https://cdn.example.com/app/manifest.json --keys app-pubkey.json

fetch and verify a statically hosted manifest + signature

oroc update info --http --host 127.0.0.1 --port 8080 --app-id com.example.app --follow-manifest

query an HTTP update server and then fetch the referenced manifest

oroc update info --tcp --host 127.0.0.1 --port 9000 --app-id com.example.app --follow-manifest

query a TCP update server using the binary OUP protocol

Source repository · Edit this page · View Markdown

Quick links

Type to search across the site. Use the up and down arrow keys to choose a result, Enter to open it, and Escape to close.