https://cua.ai/assets/config-B6rr7Voc.js

1!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._posthogChunkIds=e._posthogChunkIds||{},e._posthogChunkIds[n]="01a102ca-23db-7722-b7a3-4f757b59f423")}catch(e){}}();import{j as e}from"./jsx-runtime-u17CrQMm.js";import{u as t}from"./index-DPhldNWm.js";import"./chunk-4N6VE7H7-DExpvS7J.js";const i={title:"cua config",description:"User defaults: where sandboxes run (`default.on`), the default kind and runtime, cloud defaults."};function s(a){const n={a:"a",code:"code",figure:"figure",h2:"h2",p:"p",pre:"pre",span:"span",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...t(),...a.components};return e.jsxs(e.Fragment,{children:[`
2`,e.jsxs(n.table,{children:[e.jsx(n.thead,{children:e.jsxs(n.tr,{children:[e.jsx(n.th,{children:"Command"}),e.jsx(n.th,{children:"Description"})]})}),e.jsxs(n.tbody,{children:[e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.a,{href:"#cua-config-list",children:e.jsx(n.code,{children:"cua config list"})})}),e.jsx(n.td,{children:"Every setting: its effective value and where it comes from (env, config or default)."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.a,{href:"#cua-config-get",children:e.jsx(n.code,{children:"cua config get"})})}),e.jsx(n.td,{children:"One setting's effective value."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.a,{href:"#cua-config-set",children:e.jsx(n.code,{children:"cua config set"})})}),e.jsx(n.td,{children:"Write a setting to the config file."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.a,{href:"#cua-config-unset",children:e.jsx(n.code,{children:"cua config unset"})})}),e.jsx(n.td,{children:"Remove a setting from the config file (the environment variable or the built-in default applies again)."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.a,{href:"#cua-config-path",children:e.jsx(n.code,{children:"cua config path"})})}),e.jsx(n.td,{children:"The config file's path."})]})]})]}),`
3`,e.jsxs(n.p,{children:["Every command also accepts the ",e.jsx(n.a,{href:"/cua-cli/reference/cli#global-options",children:"global options"}),"."]}),`
4`,e.jsx("span",{id:"cua-config"}),`
5`,e.jsx(n.p,{children:"User defaults (~/.cua/config.toml): where sandboxes run when --on is not given (default.on), the default kind and runtime, cloud defaults."}),`
6`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config [OPTIONS] &#x3C;COMMAND></span></span>'}})})})}),`
7`,e.jsx(n.h2,{id:"cua-config-list",children:e.jsx(n.code,{children:"cua config list"})}),`
8`,e.jsx(n.p,{children:"Every setting: its effective value and where it comes from (env, config or default)."}),`
9`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config list [OPTIONS]</span></span>'}})})})}),`
10`,e.jsxs(n.p,{children:["Alias: ",e.jsx(n.code,{children:"cua config ls"}),"."]}),`
11`,e.jsx(n.p,{children:e.jsx(n.strong,{children:"Examples"})}),`
12`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"bash","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"bash","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:`<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> list</span></span>
13<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> list</span><span style="color:#79C0FF"> --json</span></span>`}})})})}),`

14`,e.jsx(n.h2,{id:"cua-config-get",children:e.jsx(n.code,{children:"cua config get"})}),`
15`,e.jsx(n.p,{children:"One setting's effective value."}),`
16`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config get [OPTIONS] &#x3C;KEY></span></span>'}})})})}),`
17`,e.jsxs(n.table,{children:[e.jsx(n.thead,{children:e.jsxs(n.tr,{children:[e.jsx(n.th,{children:"Argument"}),e.jsx(n.th,{children:"Type"}),e.jsx(n.th,{children:"Default"}),e.jsx(n.th,{children:"Description"})]})}),e.jsx(n.tbody,{children:e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"<KEY>"})}),e.jsx(n.td,{children:"string"}),e.jsx(n.td,{children:"required"}),e.jsxs(n.td,{children:["Setting (",e.jsx(n.code,{children:"default.on"}),", ",e.jsx(n.code,{children:"default.kind"}),", ",e.jsx(n.code,{children:"default.runtime"}),", ",e.jsx(n.code,{children:"cloud.warm"}),", ",e.jsx(n.code,{children:"cloud.max_pool_size"}),", ",e.jsx(n.code,{children:"cloud.claim_ttl"}),")."]})]})})]}),`
18`,e.jsx(n.p,{children:e.jsx(n.strong,{children:"Examples"})}),`
19`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"bash","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"bash","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> get</span><span style="color:#A5D6FF"> default.on</span></span>'}})})})}),`
20`,e.jsx(n.h2,{id:"cua-config-set",children:e.jsx(n.code,{children:"cua config set"})}),`
21`,e.jsx(n.p,{children:"Write a setting to the config file."}),`
22`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config set [OPTIONS] &#x3C;KEY> &#x3C;VALUE></span></span>'}})})})}),`
23`,e.jsxs(n.table,{children:[e.jsx(n.thead,{children:e.jsxs(n.tr,{children:[e.jsx(n.th,{children:"Argument"}),e.jsx(n.th,{children:"Type"}),e.jsx(n.th,{children:"Default"}),e.jsx(n.th,{children:"Description"})]})}),e.jsxs(n.tbody,{children:[e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"<KEY>"})}),e.jsx(n.td,{children:"string"}),e.jsx(n.td,{children:"required"}),e.jsx(n.td,{children:"Setting."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"<VALUE>"})}),e.jsx(n.td,{children:"string"}),e.jsx(n.td,{children:"required"}),e.jsxs(n.td,{children:["Value (checked: ",e.jsx(n.code,{children:"default.on"})," takes local, cloud or a provider)."]})]})]})]}),`
24`,e.jsx(n.p,{children:e.jsx(n.strong,{children:"Examples"})}),`
25`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"bash","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"bash","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:`<span data-line=""><span style="color:#8B949E"># Create sandboxes in the cloud unless --on says otherwise</span></span>
26<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> set</span><span style="color:#A5D6FF"> default.on</span><span style="color:#A5D6FF"> cloud</span></span>
27<span data-line=""> </span>
28<span data-line=""><span style="color:#8B949E"># Back to this machine</span></span>
29<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> set</span><span style="color:#A5D6FF"> default.on</span><span style="color:#A5D6FF"> local</span></span>
30<span data-line=""> </span>
31<span data-line=""><span style="color:#8B949E"># Prefer VMs when the image offers both</span></span>
32<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> set</span><span style="color:#A5D6FF"> default.kind</span><span style="color:#A5D6FF"> vm</span></span>`}})})})}),`

33`,e.jsx(n.h2,{id:"cua-config-unset",children:e.jsx(n.code,{children:"cua config unset"})}),`
34`,e.jsx(n.p,{children:"Remove a setting from the config file (the environment variable or the built-in default applies again)."}),`
35`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config unset [OPTIONS] &#x3C;KEY></span></span>'}})})})}),`
36`,e.jsxs(n.table,{children:[e.jsx(n.thead,{children:e.jsxs(n.tr,{children:[e.jsx(n.th,{children:"Argument"}),e.jsx(n.th,{children:"Type"}),e.jsx(n.th,{children:"Default"}),e.jsx(n.th,{children:"Description"})]})}),e.jsx(n.tbody,{children:e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"<KEY>"})}),e.jsx(n.td,{children:"string"}),e.jsx(n.td,{children:"required"}),e.jsx(n.td,{children:"Setting."})]})})]}),`
37`,e.jsx(n.p,{children:e.jsx(n.strong,{children:"Examples"})}),`
38`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"bash","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"bash","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> unset</span><span style="color:#A5D6FF"> default.on</span></span>'}})})})}),`
39`,e.jsx(n.h2,{id:"cua-config-path",children:e.jsx(n.code,{children:"cua config path"})}),`
40`,e.jsx(n.p,{children:"The config file's path."}),`
41`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"text","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"text","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span>cua config path [OPTIONS]</span></span>'}})})})}),`
42`,e.jsx(n.p,{children:e.jsx(n.strong,{children:"Examples"})}),`
43`,e.jsx(n.figure,{"data-rehype-pretty-code-figure":"",children:e.jsx(n.pre,{tabIndex:"0","data-language":"bash","data-theme":"github-dark-default",children:e.jsx(n.code,{"data-language":"bash","data-theme":"github-dark-default",style:{display:"grid"},children:e.jsx(n.span,{dangerouslySetInnerHTML:{__html:'<span data-line=""><span style="color:#FFA657">cua</span><span style="color:#A5D6FF"> config</span><span style="color:#A5D6FF"> path</span></span>'}})})})}),`
44`,e.jsx(n.h2,{id:"exit-codes",children:"Exit codes"}),`
45`,e.jsxs(n.table,{children:[e.jsx(n.thead,{children:e.jsxs(n.tr,{children:[e.jsx(n.th,{children:"Code"}),e.jsx(n.th,{children:"Meaning"})]})}),e.jsxs(n.tbody,{children:[e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"0"})}),e.jsx(n.td,{children:"Success."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"1"})}),e.jsxs(n.td,{children:["Failure, or ",e.jsx(n.code,{children:"cua do"})," reported an error."]})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"2"})}),e.jsxs(n.td,{children:["Invalid argument, or an ambiguous sandbox name (qualify it: ",e.jsx(n.code,{children:"local:NAME"}),", ",e.jsx(n.code,{children:"cloud:NAME"}),")."]})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"3"})}),e.jsx(n.td,{children:"Not found: sandbox, window, skill or image (or an image not published yet)."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"4"})}),e.jsx(n.td,{children:"Not supported, or not configured (for example no Fleet credentials)."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"5"})}),e.jsx(n.td,{children:"No cua-spacesd answered, or a transport failure."})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"6"})}),e.jsx(n.td,{children:"Unauthenticated or permission denied (by Cua, Fleet or your cloud account)."})]}

45),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"7"})}),e.jsxs(n.td,{children:["Not enough free disk space (see ",e.jsx(n.code,{children:"cua cache"}),")."]})]}),e.jsxs(n.tr,{children:[e.jsx(n.td,{children:e.jsx(n.code,{children:"130"})}),e.jsx(n.td,{children:"Cancelled (Ctrl-C during a create): what it made was removed."})]})]})]})]})}function c(a={}){const{wrapper:n}={...t(),...a.components};return n?e.jsx(n,{...a,children:e.jsx(s,{...a})}):s(a)}export{c as default,i as frontmatter};
46//# sourceMappingURL=config-B6rr7Voc.js.map
47
48//# chunkId=01a102ca-23db-7722-b7a3-4f757b59f423