[{"data":1,"prerenderedAt":186},["ShallowReactive",2],{"page-\u002Finstances\u002Fcli-access":3,"surround-\u002Finstances\u002Fcli-access":177},{"id":4,"title":5,"body":6,"description":169,"extension":170,"meta":171,"navigation":172,"path":173,"seo":174,"stem":175,"__hash__":176},"docs\u002Finstances\u002Fcli-access.md","Use the CLI in an instance",{"type":7,"value":8,"toc":164},"minimark",[9,18,23,33,36,86,89,93,96,109,130,136,140,160],[10,11,12,13,17],"p",{},"The ",[14,15,16],"strong",{},"Install the featherless-cloud CLI"," setting installs the CLI in an instance and signs it in as the person who deployed it. Use it to launch Run Jobs, manage other instances, or move files between volumes from inside the instance.",[19,20,22],"h2",{"id":21},"turn-it-on","Turn it on",[10,24,25,26,28,29,32],{},"Switch on ",[14,27,16],{}," under ",[14,30,31],{},"Runtime configuration"," when you deploy or edit the instance. Changing it on a running instance restarts the instance.",[10,34,35],{},"Inside the instance, the CLI is ready to use:",[37,38,43],"pre",{"className":39,"code":40,"language":41,"meta":42,"style":42},"language-bash shiki shiki-themes github-dark-default","featherless-cloud instance list\nfeatherless-cloud exec --gpu-count 1 -- python train.py\n","bash","",[44,45,46,62],"code",{"__ignoreMap":42},[47,48,51,55,59],"span",{"class":49,"line":50},"line",1,[47,52,54],{"class":53},"sQhOw","featherless-cloud",[47,56,58],{"class":57},"s9uIt"," instance",[47,60,61],{"class":57}," list\n",[47,63,65,67,70,74,77,80,83],{"class":49,"line":64},2,[47,66,54],{"class":53},[47,68,69],{"class":57}," exec",[47,71,73],{"class":72},"sFSAA"," --gpu-count",[47,75,76],{"class":72}," 1",[47,78,79],{"class":72}," --",[47,81,82],{"class":57}," python",[47,84,85],{"class":57}," train.py\n",[10,87,88],{},"It works with custom images and most official templates. An instance whose template doesn't support it starts without the CLI.",[19,90,92],{"id":91},"what-the-instances-key-can-do","What the instance's key can do",[10,94,95],{},"The instance signs in with its own API key:",[97,98,99,103,106],"ul",{},[100,101,102],"li",{},"It acts as the person who deployed the instance, in the instance's organization.",[100,104,105],{},"It can manage instances, Run Jobs and network volumes, and read account details.",[100,107,108],{},"It's created when the instance starts and revoked when the instance stops, fails or is deleted.",[10,110,111,112,115,116,125,126,129],{},"The key appears in the ",[14,113,114],{},"API keys"," tab of the ",[117,118,124],"a",{"href":119,"rel":120,"target":123},"https:\u002F\u002Fconsole.cloud.featherless.ai\u002Fcredentials\u002Fapi-keys",[121,122],"noopener","noreferrer","_blank","Credentials page"," when you switch on ",[14,127,128],{},"Show instance keys",". You can't revoke it there; stop the instance instead.",[131,132,133],"warning",{},[10,134,135],{},"Any process in the instance can read the key and act as you across the organization. Turn this setting on only for instances where you trust everything that runs.",[19,137,139],{"id":138},"next-steps","Next steps",[141,142,143,152],"card-group",{},[144,145,149],"card",{"icon":146,"title":147,"to":148},"i-lucide-terminal","CLI overview","\u002Fcli",[10,150,151],{},"Every command the CLI offers.",[144,153,157],{"icon":154,"title":155,"to":156},"i-lucide-square-terminal","Submit a Run Job","\u002Frun-jobs\u002Fsubmit",[10,158,159],{},"Run work on temporary compute.",[161,162,163],"style",{},"html pre.shiki code .sQhOw, html code.shiki .sQhOw{--shiki-default:#FFA657}html pre.shiki code .s9uIt, html code.shiki .s9uIt{--shiki-default:#A5D6FF}html pre.shiki code .sFSAA, html code.shiki .sFSAA{--shiki-default:#79C0FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":42,"searchDepth":64,"depth":64,"links":165},[166,167,168],{"id":21,"depth":64,"text":22},{"id":91,"depth":64,"text":92},{"id":138,"depth":64,"text":139},"Script work across your organization from inside an instance, with the CLI already signed in.","md",{},true,"\u002Finstances\u002Fcli-access",{"title":5,"description":169},"instances\u002Fcli-access","C3HD-R-IYhaq_jCKsxg3qejV7SM1CBZEGNvij_YRYac",[178,182],{"title":179,"path":180,"description":181},"Logs and metrics","\u002Finstances\u002Flogs-and-metrics","See what your instance is doing, from its output and resource use to its history.",{"title":183,"path":184,"description":185},"Instances troubleshooting","\u002Finstances\u002Ftroubleshooting","Fix common instance problems, from SSH errors and unreachable ports to GPUs your code can't see.",1794932598296]