Reference
The velrix command
[object Object]
On a Velrix OS server, velrix runs as the velrix user. Most of what it does also has a place in the Manager; the command is for the console, scripts and recovery.
--instance <name> picks one instance of the realm for issue, render, up, down, status, stop, start and client. The default is this server’s own.
Commands
| Command | What it does |
|---|---|
velrix issue init | all | <id>... [--days N] | issuer key, per-module identity + attestation |
velrix render [<id>...] | deploy/generated/<id>/{config,pod.yaml} (every module, or these) |
velrix build [--images] | cargo build --release; then one image per module |
velrix up | down | status | stop <id> | start <id> | |
velrix client | the edge’s URL and certificate hash, as env for the web client |
velrix docs | docs/generated/<id>.md from manifests and capability specs |
velrix setup-token | the token that claims a fresh instance in its setup wizard |
velrix instance export <name> | velrix-instance-<name>.tar: what another host needs to run it |
velrix images push [--via <addr>] | every localhost/velrix-module-<id>:<ver> (+ local deploy.images) into deploy.json images |
velrix images pull [--for <secs>] | this instance’s module images from there, retagged localhost/… |
velrix instance import <tar> | unpack an export into this workspace (a Velrix OS host’s bundle) |
velrix release build | verify | apply | os | rollback | write-stick | signed releases |
velrix replicas add | remove <id> | request | where a module’s copies run |
velrix specs diff <old capabilities dir> | change kinds since those specs, and versions that do not say them |
velrix extension pack <kind> <built dir> [--signer <identity.json>] [--issuer <pem file>] [--out <dir>] | |
velrix installer serve | tui [<url>] | check | |
velrix provider pack <id>… [--signer <identity.json>] [--issuer <pem file>] [--out <dir>] | |
velrix realmkey console issue|renew|release <instance> [--key <backup file>] | |
velrix vendor key <out> [--plain] [--piv [--generate]] | set create|propose <dir> --need <n> --member <name>:<role>:<pub.pem>… | set adopt <dir> | sign <file> --member <name> --key <file> [--keyset <dir>] | combine <out> <file>… | verify <file> [--keyset <dir>|--set <file>] |