1"use strict";(globalThis.webpackChunkbacalhau_website||=[]).push([[7219],{9560(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"cli/agent/version","title":"Version","description":"The bacalhau agent version command is used to obtain the version of the bacalhau agent.","source":"@site/docs/cli/agent/version.md","sourceDirName":"cli/agent","slug":"/cli/agent/version","permalink":"/docs/cli/agent/version","draft":false,"unlisted":false,"editUrl":"https://github.com/bacalhau-project/docs/tree/main/docs/cli/agent/version.md","tags":[],"version":"current","lastUpdatedAt":1747132912000,"frontMatter":{},"sidebar":"cliApi","previous":{"title":"Agent Node Command","permalink":"/docs/cli/agent/node"},"next":{"title":"Config","permalink":"/docs/cli/config/"}}');var l=s(4848),r=s(8453);const t={},a="Version",c={},o=[{value:"Description:",id:"description",level:2},{value:"Usage:",id:"usage",level:2},{value:"Flags:",id:"flags",level:2},{value:"Global Flags:",id:"global-flags",level:2},{value:"Examples",id:"examples",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"version",children:"Version"})}),"\n",(0,l.jsxs)(n.p,{children:["The ",(0,l.jsx)(n.code,{children:"bacalhau agent version"})," command is used to obtain the version of the bacalhau agent."]}),"\n",(0,l.jsx)(n.h2,{id:"description",children:"Description:"}),"\n",(0,l.jsx)(n.p,{children:"Using this command, users can quickly retrieve the version of the agent, allowing them to confirm the specific release of the software they are using."}),"\n",(0,l.jsx)(n.h2,{id:"usage",children:"Usage:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"bacalhau agent version [flags]\n"})}),"\n",(0,l.jsx)(n.h2,{id:"flags",children:"Flags:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsxs)(n.strong,{children:[(0,l.jsx)(n.code,{children:"-h"}),", ",(0,l.jsx)(n.code,{children:"--help"})]}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Show help for the ",(0,l.jsx)(n.code,{children:"version"})," command."]}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--output format"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:'Defines the output format of the command\'s results. Accepted formats include "json" and "yaml".'}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--pretty"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:'Used for pretty printing the output, enhancing readability. This flag is applicable only for the "json" and "yaml" output formats.'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"global-flags",children:"Global Flags:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--api-host string"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Designates the host for client-server communication via REST. If the ",(0,l.jsx)(n.code,{children:"BACALHAU_API_HOST"})," environment variable is present, this flag will be disregarded."]}),"\n",(0,l.jsxs)(n.li,{children:["Default: ",(0,l.jsx)(n.code,{children:'"bootstrap.production.bacalhau.org"'})]}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--api-port int"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Defines the port for client-server communication through REST. This flag becomes irrelevant if the ",(0,l.jsx)(n.code,{children:"BACALHAU_API_PORT"})," environment variable is specified."]}),"\n",(0,l.jsxs)(n.li,{children:["Default: ",(0,l.jsx)(n.code,{children:"1234"})]}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--log-mode logging-mode"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Specifies the desired logging format."}),"\n",(0,l.jsxs)(n.li,{children:["Options: ",(0,l.jsx)(n.code,{children:"'default','station','json','combined','event'"})]}),"\n",(0,l.jsxs)(n.li,{children:["Default: ",(0,l.jsx)(n.code,{children:"'default'"})]}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"--repo string"})}),":\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Indicates the path to the bacalhau repository."}),"\n",(0,l.jsxs)(n.li,{children:["Default: ",(0,l.jsx)(n.code,{children:'"'}),'$HOME/.bacalhau"`']}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:["\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.strong,{children:"Retrieve the agent version"}),":"]}),"\n",(0,l.jsx)(n.p,{children:"Execute the command to get the agent version:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"bacalhau agent version\n"})}),"\n",(0,l.jsx)(n.p,{children:"Expected output:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"Bacalhau v0.0.0-xxxxxxx\nBuildDate 2023-09-22 16:03:44 +0000 UTC\nGitC
1ommit 0fe81cb488f666845ac72c73a4b804aaa658e511\n"})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:["\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.strong,{children:"Retrieve the agent version in JSON format"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"bacalhau agent version --output json\n"})}),"\n",(0,l.jsx)(n.p,{children:"Expected output:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:'{"major":"0","minor":"0","gitversion":"v0.0.0-xxxxxxx","gitcommit":"0fe81cb488f666845ac72c73a4b804aaa658e511","builddate":"2023-09-22T16:03:44Z","goos":"linux","goarch":"amd64"}\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:["\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.strong,{children:"Retrieve the agent version in Pretty-printed JSON format"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"bacalhau agent version --output json --pretty\n"})}),"\n",(0,l.jsx)(n.p,{children:"Expected output:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:'{\n "major": "0",\n "minor": "0",\n "gitversion": "v0.0.0-xxxxxxx",\n "gitcommit": "0fe81cb488f666845ac72c73a4b804aaa658e511",\n "builddate": "2023-09-22T16:03:44Z",\n "goos": "linux",\n "goarch": "amd64"\n}\n'})}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},8453(e,n,s){s.d(n,{R:()=>t,x:()=>a});var i=s(6540);const l={},r=i.createContext(l);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.