[{"data":1,"prerenderedAt":505},["ShallowReactive",2],{"docs:\u002Fdocs\u002Freference\u002Fcli":3,"docs:nav":288,"docs:surround:\u002Fdocs\u002Freference\u002Fcli":500},{"id":4,"title":5,"body":6,"description":276,"extension":277,"launchGate":278,"meta":279,"navigation":280,"path":281,"seo":282,"stem":285,"stub":286,"__hash__":287},"docs_en\u002Fdocs\u002F5.reference\u002F2.cli.md","The velrix command",{"type":7,"value":8,"toc":270},"minimark",[9,21,54,59],[10,11,12,13,17,18,20],"p",{},"On a Velrix OS server, ",[14,15,16],"code",{},"velrix"," runs as the ",[14,19,16],{}," user. Most of what it does also has a place in the Manager; the command is for the console, scripts and recovery.",[10,22,23,26,27,30,31,30,34,30,37,30,40,30,43,30,46,49,50,53],{},[14,24,25],{},"--instance \u003Cname>"," picks one instance of the realm for ",[14,28,29],{},"issue",", ",[14,32,33],{},"render",[14,35,36],{},"up",[14,38,39],{},"down",[14,41,42],{},"status",[14,44,45],{},"stop",[14,47,48],{},"start"," and ",[14,51,52],{},"client",". The default is this server’s own.",[55,56,58],"h2",{"id":57},"commands","Commands",[60,61,62,75],"table",{},[63,64,65],"thead",{},[66,67,68,72],"tr",{},[69,70,71],"th",{},"Command",[69,73,74],{},"What it does",[76,77,78,89,99,109,118,128,138,148,158,175,185,195,205,215,225,234,243,252,261],"tbody",{},[66,79,80,86],{},[81,82,83],"td",{},[14,84,85],{},"velrix issue init | all | \u003Cid>... [--days N]",[81,87,88],{},"issuer key, per-module identity + attestation",[66,90,91,96],{},[81,92,93],{},[14,94,95],{},"velrix render [\u003Cid>...]",[81,97,98],{},"deploy\u002Fgenerated\u002F\u003Cid>\u002F{config,pod.yaml} (every module, or these)",[66,100,101,106],{},[81,102,103],{},[14,104,105],{},"velrix build [--images]",[81,107,108],{},"cargo build --release; then one image per module",[66,110,111,116],{},[81,112,113],{},[14,114,115],{},"velrix up | down | status | stop \u003Cid> | start \u003Cid>",[81,117],{},[66,119,120,125],{},[81,121,122],{},[14,123,124],{},"velrix client",[81,126,127],{},"the edge’s URL and certificate hash, as env for the web client",[66,129,130,135],{},[81,131,132],{},[14,133,134],{},"velrix docs",[81,136,137],{},"docs\u002Fgenerated\u002F\u003Cid>.md from manifests and capability specs",[66,139,140,145],{},[81,141,142],{},[14,143,144],{},"velrix setup-token",[81,146,147],{},"the token that claims a fresh instance in its setup wizard",[66,149,150,155],{},[81,151,152],{},[14,153,154],{},"velrix instance export \u003Cname>",[81,156,157],{},"velrix-instance-\u003Cname>.tar: what another host needs to run it",[66,159,160,165],{},[81,161,162],{},[14,163,164],{},"velrix images push [--via \u003Caddr>]",[81,166,167,168,171,172],{},"every localhost\u002Fvelrix-module-\u003Cid>:\u003Cver> (+ local ",[14,169,170],{},"deploy.images",") into deploy.json ",[14,173,174],{},"images",[66,176,177,182],{},[81,178,179],{},[14,180,181],{},"velrix images pull [--for \u003Csecs>]",[81,183,184],{},"this instance’s module images from there, retagged localhost\u002F…",[66,186,187,192],{},[81,188,189],{},[14,190,191],{},"velrix instance import \u003Ctar>",[81,193,194],{},"unpack an export into this workspace (a Velrix OS host’s bundle)",[66,196,197,202],{},[81,198,199],{},[14,200,201],{},"velrix release build | verify | apply | os | rollback | write-stick",[81,203,204],{},"signed releases",[66,206,207,212],{},[81,208,209],{},[14,210,211],{},"velrix replicas add | remove \u003Cid> | request",[81,213,214],{},"where a module’s copies run",[66,216,217,222],{},[81,218,219],{},[14,220,221],{},"velrix specs diff \u003Cold capabilities dir>",[81,223,224],{},"change kinds since those specs, and versions that do not say them",[66,226,227,232],{},[81,228,229],{},[14,230,231],{},"velrix extension pack \u003Ckind> \u003Cbuilt dir> [--signer \u003Cidentity.json>] [--issuer \u003Cpem file>] [--out \u003Cdir>]",[81,233],{},[66,235,236,241],{},[81,237,238],{},[14,239,240],{},"velrix installer serve | tui [\u003Curl>] | check",[81,242],{},[66,244,245,250],{},[81,246,247],{},[14,248,249],{},"velrix provider pack \u003Cid>… [--signer \u003Cidentity.json>] [--issuer \u003Cpem file>] [--out \u003Cdir>]",[81,251],{},[66,253,254,259],{},[81,255,256],{},[14,257,258],{},"velrix realmkey console issue|renew|release \u003Cinstance> [--key \u003Cbackup file>]",[81,260],{},[66,262,263,268],{},[81,264,265],{},[14,266,267],{},"velrix vendor key \u003Cout> [--plain] [--piv [--generate]] | set create|propose \u003Cdir> --need \u003Cn> --member \u003Cname>:\u003Crole>:\u003Cpub.pem>… | set adopt \u003Cdir> | sign \u003Cfile> --member \u003Cname> --key \u003Cfile> [--keyset \u003Cdir>] | combine \u003Cout> \u003Cfile>… | verify \u003Cfile> [--keyset \u003Cdir>|--set \u003Cfile>]",[81,269],{},{"title":271,"searchDepth":272,"depth":273,"links":274},"",2,3,[275],{"id":57,"depth":272,"text":58},"[object Object]","md",null,{},true,"\u002Fdocs\u002Freference\u002Fcli",{"title":5,"description":283},{"The operator's command line on a Velrix server":284},"identities, start and stop, releases, setup token.","docs\u002F5.reference\u002F2.cli",false,"7u-mkOeezIIv178Wl3ptcCxgMRKniX_N77_E8s3krEI",[289],{"title":290,"path":291,"stem":292,"children":293},"Docs","\u002Fdocs","docs",[294,298,328,355,389,460,471,493],{"title":295,"path":291,"stem":296,"stub":286,"launchGate":278,"icon":297},"Overview","docs\u002Findex","i-lucide-house",{"title":299,"stub":286,"launchGate":278,"icon":300,"path":301,"stem":302,"children":303,"page":286},"Get started","i-lucide-rocket","\u002Fdocs\u002Fget-started","docs\u002F1.get-started",[304,308,312,316,320,324],{"title":305,"path":306,"stem":307,"stub":286,"launchGate":278},"What Velrix is","\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix","docs\u002F1.get-started\u002F1.what-is-velrix",{"title":309,"path":310,"stem":311,"stub":286,"launchGate":278},"Ways to run Velrix","\u002Fdocs\u002Fget-started\u002Fways-to-run","docs\u002F1.get-started\u002F2.ways-to-run",{"title":313,"path":314,"stem":315,"stub":286,"launchGate":278},"Install from USB","\u002Fdocs\u002Fget-started\u002Finstall","docs\u002F1.get-started\u002F3.install",{"title":317,"path":318,"stem":319,"stub":286,"launchGate":278},"The setup wizard","\u002Fdocs\u002Fget-started\u002Fsetup-wizard","docs\u002F1.get-started\u002F4.setup-wizard",{"title":321,"path":322,"stem":323,"stub":286,"launchGate":278},"Your first app","\u002Fdocs\u002Fget-started\u002Ffirst-app","docs\u002F1.get-started\u002F5.first-app",{"title":325,"path":326,"stem":327,"stub":286,"launchGate":278},"Your first VM","\u002Fdocs\u002Fget-started\u002Ffirst-vm","docs\u002F1.get-started\u002F6.first-vm",{"title":329,"stub":286,"launchGate":278,"icon":330,"path":331,"stem":332,"children":333,"page":286},"Concepts","i-lucide-lightbulb","\u002Fdocs\u002Fconcepts","docs\u002F2.concepts",[334,338,342,346,350],{"title":335,"path":336,"stem":337,"stub":280,"launchGate":278},"Realms","\u002Fdocs\u002Fconcepts\u002Frealms","docs\u002F2.concepts\u002F1.realms",{"title":339,"path":340,"stem":341,"stub":280,"launchGate":278},"Instances and hosts","\u002Fdocs\u002Fconcepts\u002Finstances-and-hosts","docs\u002F2.concepts\u002F2.instances-and-hosts",{"title":343,"path":344,"stem":345,"stub":280,"launchGate":278},"Modules and the mesh","\u002Fdocs\u002Fconcepts\u002Fmodules-and-the-mesh","docs\u002F2.concepts\u002F3.modules-and-the-mesh",{"title":347,"path":348,"stem":349,"stub":280,"launchGate":278},"Organisations, projects and permissions","\u002Fdocs\u002Fconcepts\u002Forgs-projects-permissions","docs\u002F2.concepts\u002F4.orgs-projects-permissions",{"title":351,"path":352,"stem":353,"stub":280,"launchGate":354},"Host pools","\u002Fdocs\u002Fconcepts\u002Fhost-pools","docs\u002F2.concepts\u002F5.host-pools","A1",{"title":356,"stub":286,"launchGate":278,"icon":357,"path":358,"stem":359,"children":360,"page":286},"Guides for users","i-lucide-book-open","\u002Fdocs\u002Fguides","docs\u002F3.guides",[361,365,369,373,377,381,385],{"title":362,"path":363,"stem":364,"stub":280,"launchGate":278},"Apps","\u002Fdocs\u002Fguides\u002Fapps","docs\u002F3.guides\u002F1.apps",{"title":366,"path":367,"stem":368,"stub":280,"launchGate":278},"Machines","\u002Fdocs\u002Fguides\u002Fmachines","docs\u002F3.guides\u002F2.machines",{"title":370,"path":371,"stem":372,"stub":280,"launchGate":278},"Volumes","\u002Fdocs\u002Fguides\u002Fvolumes","docs\u002F3.guides\u002F3.volumes",{"title":374,"path":375,"stem":376,"stub":286,"launchGate":278},"Stacks","\u002Fdocs\u002Fguides\u002Fstacks","docs\u002F3.guides\u002F4.stacks",{"title":378,"path":379,"stem":380,"stub":280,"launchGate":278},"Terminal and cloud shells","\u002Fdocs\u002Fguides\u002Fterminal","docs\u002F3.guides\u002F5.terminal",{"title":382,"path":383,"stem":384,"stub":286,"launchGate":278},"Registry","\u002Fdocs\u002Fguides\u002Fregistry","docs\u002F3.guides\u002F6.registry",{"title":386,"path":387,"stem":388,"stub":280,"launchGate":278},"Kubernetes","\u002Fdocs\u002Fguides\u002Fkubernetes","docs\u002F3.guides\u002F7.kubernetes",{"title":390,"stub":286,"launchGate":278,"icon":391,"path":392,"stem":393,"children":394,"page":286},"Guides for operators","i-lucide-server-cog","\u002Fdocs\u002Foperators","docs\u002F4.operators",[395,399,403,407,411,415,419,423,427,431,436,440,444,448,452,456],{"title":396,"path":397,"stem":398,"stub":286,"launchGate":278},"Updates and maintenance windows","\u002Fdocs\u002Foperators\u002Fupdates","docs\u002F4.operators\u002F1.updates",{"title":400,"path":401,"stem":402,"stub":286,"launchGate":278},"Migrate: moving VMs from VMware","\u002Fdocs\u002Foperators\u002Fmigrate","docs\u002F4.operators\u002F10.migrate",{"title":404,"path":405,"stem":406,"stub":286,"launchGate":278},"Hardware","\u002Fdocs\u002Foperators\u002Fhardware","docs\u002F4.operators\u002F11.hardware",{"title":408,"path":409,"stem":410,"stub":286,"launchGate":278},"Billing","\u002Fdocs\u002Foperators\u002Fbilling","docs\u002F4.operators\u002F12.billing",{"title":412,"path":413,"stem":414,"stub":286,"launchGate":278},"Policies","\u002Fdocs\u002Foperators\u002Fpolicies","docs\u002F4.operators\u002F13.policies",{"title":416,"path":417,"stem":418,"stub":286,"launchGate":278},"Running the realm","\u002Fdocs\u002Foperators\u002Frealm-ops","docs\u002F4.operators\u002F14.realm-ops",{"title":420,"path":421,"stem":422,"stub":286,"launchGate":278},"Public address and app hostnames","\u002Fdocs\u002Foperators\u002Fpublic-address","docs\u002F4.operators\u002F15.public-address",{"title":424,"path":425,"stem":426,"stub":286,"launchGate":278},"Library","\u002Fdocs\u002Foperators\u002Flibrary","docs\u002F4.operators\u002F16.library",{"title":428,"path":429,"stem":430,"stub":286,"launchGate":278},"Backups","\u002Fdocs\u002Foperators\u002Fbackups","docs\u002F4.operators\u002F2.backups",{"title":432,"path":433,"stem":434,"stub":280,"launchGate":435},"Availability and drain","\u002Fdocs\u002Foperators\u002Favailability","docs\u002F4.operators\u002F3.availability","A1, A2, A3",{"title":437,"path":438,"stem":439,"stub":280,"launchGate":278},"Federation","\u002Fdocs\u002Foperators\u002Ffederation","docs\u002F4.operators\u002F4.federation",{"title":441,"path":442,"stem":443,"stub":280,"launchGate":278},"Licensing","\u002Fdocs\u002Foperators\u002Flicensing","docs\u002F4.operators\u002F5.licensing",{"title":445,"path":446,"stem":447,"stub":280,"launchGate":278},"Branding: look and design","\u002Fdocs\u002Foperators\u002Fbranding","docs\u002F4.operators\u002F6.branding",{"title":449,"path":450,"stem":451,"stub":280,"launchGate":278},"Connectivity","\u002Fdocs\u002Foperators\u002Fconnectivity","docs\u002F4.operators\u002F7.connectivity",{"title":453,"path":454,"stem":455,"stub":280,"launchGate":278},"Logs","\u002Fdocs\u002Foperators\u002Flogs","docs\u002F4.operators\u002F8.logs",{"title":457,"path":458,"stem":459,"stub":286,"launchGate":278},"Directory sync: Entra ID and Okta","\u002Fdocs\u002Foperators\u002Fdirectory-sync","docs\u002F4.operators\u002F9.directory-sync",{"title":461,"stub":286,"launchGate":278,"icon":462,"path":463,"stem":464,"children":465,"page":286},"Reference","i-lucide-library","\u002Fdocs\u002Freference","docs\u002F5.reference",[466,470],{"title":467,"path":468,"stem":469,"stub":286,"launchGate":278},"The API reference in your realm","\u002Fdocs\u002Freference\u002Fin-your-realm","docs\u002F5.reference\u002F1.in-your-realm",{"title":5,"path":281,"stem":285,"stub":286,"launchGate":278},{"title":472,"stub":286,"launchGate":278,"icon":473,"path":474,"stem":475,"children":476,"page":286},"Security and compliance","i-lucide-shield-check","\u002Fdocs\u002Fsecurity","docs\u002F6.security",[477,481,485,489],{"title":478,"path":479,"stem":480,"stub":280,"launchGate":278},"Post-quantum","\u002Fdocs\u002Fsecurity\u002Fpost-quantum","docs\u002F6.security\u002F1.post-quantum",{"title":482,"path":483,"stem":484,"stub":280,"launchGate":278},"GDPR","\u002Fdocs\u002Fsecurity\u002Fgdpr","docs\u002F6.security\u002F2.gdpr",{"title":486,"path":487,"stem":488,"stub":280,"launchGate":278},"NIS2 support","\u002Fdocs\u002Fsecurity\u002Fnis2","docs\u002F6.security\u002F3.nis2",{"title":490,"path":491,"stem":492,"stub":280,"launchGate":278},"Data residency","\u002Fdocs\u002Fsecurity\u002Fdata-residency","docs\u002F6.security\u002F4.data-residency",{"title":494,"path":495,"stem":496,"children":497,"stub":286,"launchGate":278,"icon":499},"Release notes","\u002Fdocs\u002Frelease-notes","docs\u002F7.release-notes\u002Findex",[498],{"title":494,"path":495,"stem":496,"stub":286,"launchGate":278},"i-lucide-scroll-text",[501,503],{"title":467,"path":468,"stem":469,"description":502,"children":-1},"The HTTP API, Terraform, Ansible and MCP are documented in your realm's Docs window, at the versions it runs.",{"title":478,"path":479,"stem":480,"description":504,"children":-1},"Which keys and signatures in Velrix are post-quantum, how they pair with classical ones, and what is not yet.",1791248837795]