https://elastos-docs.onrender.com/assets/js/68558e2a.23c6d1a8.js

1"use strict";(globalThis.webpackChunkelastos_docs=globalThis.webpackChunkelastos_docs||[]).push([[6149],{68476(e,s,r){r.r(s),r.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>n,toc:()=>a});const n=JSON.parse('{"id":"runtime/developers/command-reference","title":"Runtime CLI Reference","description":"All elastos CLI commands organized by runtime class: managed dashboard, managed user, direct, operator, and service.","source":"@site/docs/runtime/developers/command-reference.md","sourceDirName":"runtime/developers","slug":"/runtime/developers/command-reference","permalink":"/runtime/developers/command-reference","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":6,"frontMatter":{"type":"how-to","sidebar_position":6,"title":"Runtime CLI Reference","description":"All elastos CLI commands organized by runtime class: managed dashboard, managed user, direct, operator, and service.","keywords":["Elastos","World Computer","Runtime","CLI","command reference","tools"],"image":"/img/og-runtime.jpg"},"sidebar":"runtimeSidebar","previous":{"title":"Runtime Spaces & Namespaces","permalink":"/runtime/developers/spaces"},"next":{"title":"dDRM Integration","permalink":"/runtime/developers/ddrm-integration"}}');var t=r(74848),d=r(28453);const i={type:"how-to",sidebar_position:6,title:"Runtime CLI Reference",description:"All elastos CLI commands organized by runtime class: managed dashboard, managed user, direct, operator, and service.",keywords:["Elastos","World Computer","Runtime","CLI","command reference","tools"],image:"/img/og-runtime.jpg"},c="Runtime CLI Reference",l={},a=[{value:"Runtime Classes",id:"runtime-classes",level:2},{value:"Managed Dashboard",id:"managed-dashboard",level:2},{value:"Managed User",id:"managed-user",level:2},{value:"No Runtime (Direct Commands)",id:"no-runtime-direct-commands",level:2},{value:"Operator",id:"operator",level:2},{value:"Starts Own Service",id:"starts-own-service",level:2},{value:"General",id:"general",level:2}];function o(e){const s={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"runtime-cli-reference",children:"Runtime CLI Reference"})}),"\n",(0,t.jsxs)(s.p,{children:["Every ",(0,t.jsx)(s.code,{children:"elastos"})," command has one explicit runtime expectation. Commands are organized into five runtime classes."]}),"\n",(0,t.jsx)(s.h2,{id:"runtime-classes",children:"Runtime Classes"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Class"}),(0,t.jsx)(s.th,{children:"Contract"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Managed dashboard"}),(0,t.jsx)(s.td,{children:"Auto-starts loopback runtime, renders PC2"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Managed user"}),(0,t.jsx)(s.td,{children:"Auto-starts local runtime after setup"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"No runtime"}),(0,t.jsx)(s.td,{children:"Runs directly, no persistent runtime session"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Operator"}),(0,t.jsxs)(s.td,{children:["Requires explicit ",(0,t.jsx)(s.code,{children:"elastos serve"})," running"]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Starts own service"}),(0,t.jsx)(s.td,{children:"Starts its own daemon process"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"managed-dashboard",children:"Managed Dashboard"}),"\n",(0,t.jsx)(s.p,{children:"These commands automatically start a loopback runtime and render the PC2 home surface."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos"})}),(0,t.jsx)(s.td,{children:"Open the PC2 home surface (default command)"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos pc2"})}),(0,t.jsx)(s.td,{children:"Explicit PC2 home surface"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"managed-user",children:"Managed User"}),"\n",(0,t.jsx)(s.p,{children:"These commands automatically start a local runtime after setup."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos chat --nick <name>"})}),(0,t.jsx)(s.td,{children:"Start a P2P chat session with the given nickname"})]})})]}),"\n",(0,t.jsx)(s.h2,{id:"no-runtime-direct-commands",children:"No Runtime (Direct Commands)"}),"\n",(0,t.jsx)(s.p,{children:"These commands execute their task and exit. They do not require a persistent runtime session."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos share <file>"})}),(0,t.jsxs)(s.td,{children:["Share a file via IPFS, produce ",(0,t.jsx)(s.code,{children:"elastos://<cid>"})," link"]})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos open elastos://<cid>"})}),(0,t.jsx)(s.td,{children:"Open shared content by CID"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos attest"})}),(0,t.jsx)(s.td,{children:"Attest content provenance"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos update"})}),(0,t.jsx)(s.td,{children:"Pull latest signed release and update components"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos setup"})}),(0,t.jsx)(s.td,{children:"Initialize local environment (first run)"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos setup --with <component>"})}),(0,t.jsx)(s.td,{children:"Add optional component (kubo, ipfs-provider, md-viewer)"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos site stage <dir>"})}),(0,t.jsx)(s.td,{children:"Stage a local directory as a site"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos site publish"})}),(0,t.jsx)(s.td,{children:"Publish a staged site"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos site activate"})}),(0,t.jsx)(s.td,{children:"Activate a published site version"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos site rollback"})}),(0,t.jsx)(s.td,{children:"Roll back to a previous site version"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"operator",children:"Operator"}),"\n",(0,t.jsxs)(s.p,{children:["These commands require an explicit runtime to be running via ",(0,t.jsx)(s.code,{children:"elastos serve"}),"."]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos agent"})}),(0,t.jsx)(s.td,{children:"Launch an AI agent capsule"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos capsule"})}),(0,t.jsx)(s.td,{children:"Manage capsule lifecycle"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos run"})}),(0,t.jsx)(s.td,{children:"Run a capsule directly (requires explicit runtime and working directory)"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"starts-own-service",children:"Starts Own Service"}),"\n",(0,t.jsx)(s.p,{children:"These commands start their own daemon process."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos serve"})}),(0,t.jsx)(s.td,{children:"Start the runtime server (required for operator commands)"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos gateway"})}),(0,t.jsx)(s.td,{children:"Start a gateway server"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos site serve --mode <mode>"})}),(0,t.jsx)(s.td,{children:"Serve a staged site (local or ephemeral mode)"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"general",children:"General"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Command"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos --help"})}),(0,t.jsx)(s.td,{children:"Show all available commands"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"elastos --version"})}),(0,t.jsx)(s.td,{children:"Show runtime version"})]})]})]})]})}function h(e={}){const{wrapper:s}={...(0,d.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453(e,s,r){r.d(s,{R:()=>i,x:()=>c});var n=r(96540);const t={},d=n.createContext(t);function i(e){const s=n.useContext(d);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(d.Provider,{value:s},e.children)}}}]);