[{"data":1,"prerenderedAt":744},["ShallowReactive",2],{"page-\u002Fcli":3,"surround-\u002Fcli":738},{"id":4,"title":5,"body":6,"description":731,"extension":732,"meta":733,"navigation":67,"path":734,"seo":735,"stem":736,"__hash__":737},"docs\u002Fcli\u002Findex.md","Overview",{"type":7,"value":8,"toc":720},"minimark",[9,17,22,136,140,217,220,232,236,244,255,266,291,297,302,305,335,345,349,519,526,530,579,606,613,617,687,694,698,704,716],[10,11,12,16],"p",{},[13,14,15],"code",{},"featherless-cloud"," is the command-line client for Featherless GPU Cloud. It runs on macOS, Linux and Windows.",[18,19,21],"h2",{"id":20},"quick-start","Quick start",[23,24,29],"pre",{"className":25,"code":26,"language":27,"meta":28,"style":28},"language-bash shiki shiki-themes github-dark-default","# Install\ncurl -fsSL https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstall.sh | sh\n\n# Sign in with an API key\nfeatherless-cloud login\n\n# Deploy an instance and connect to it\nfeatherless-cloud instance create --name dev --template featherless\u002Frocm-pytorch --gpu-count 1\nfeatherless-cloud instance ssh dev\n","bash","",[13,30,31,40,62,69,75,83,88,94,123],{"__ignoreMap":28},[32,33,36],"span",{"class":34,"line":35},"line",1,[32,37,39],{"class":38},"sH3jZ","# Install\n",[32,41,43,47,51,55,59],{"class":34,"line":42},2,[32,44,46],{"class":45},"sQhOw","curl",[32,48,50],{"class":49},"sFSAA"," -fsSL",[32,52,54],{"class":53},"s9uIt"," https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstall.sh",[32,56,58],{"class":57},"suJrU"," |",[32,60,61],{"class":45}," sh\n",[32,63,65],{"class":34,"line":64},3,[32,66,68],{"emptyLinePlaceholder":67},true,"\n",[32,70,72],{"class":34,"line":71},4,[32,73,74],{"class":38},"# Sign in with an API key\n",[32,76,78,80],{"class":34,"line":77},5,[32,79,15],{"class":45},[32,81,82],{"class":53}," login\n",[32,84,86],{"class":34,"line":85},6,[32,87,68],{"emptyLinePlaceholder":67},[32,89,91],{"class":34,"line":90},7,[32,92,93],{"class":38},"# Deploy an instance and connect to it\n",[32,95,97,99,102,105,108,111,114,117,120],{"class":34,"line":96},8,[32,98,15],{"class":45},[32,100,101],{"class":53}," instance",[32,103,104],{"class":53}," create",[32,106,107],{"class":49}," --name",[32,109,110],{"class":53}," dev",[32,112,113],{"class":49}," --template",[32,115,116],{"class":53}," featherless\u002Frocm-pytorch",[32,118,119],{"class":49}," --gpu-count",[32,121,122],{"class":49}," 1\n",[32,124,126,128,130,133],{"class":34,"line":125},9,[32,127,15],{"class":45},[32,129,101],{"class":53},[32,131,132],{"class":53}," ssh",[32,134,135],{"class":53}," dev\n",[18,137,139],{"id":138},"install","Install",[141,142,143,186],"tabs",{},[144,145,147,150,167],"tabs-item",{"label":146},"Install script",[10,148,149],{},"For macOS and Linux:",[23,151,153],{"className":25,"code":152,"language":27,"meta":28,"style":28},"curl -fsSL https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstall.sh | sh\n",[13,154,155],{"__ignoreMap":28},[32,156,157,159,161,163,165],{"class":34,"line":35},[32,158,46],{"class":45},[32,160,50],{"class":49},[32,162,54],{"class":53},[32,164,58],{"class":57},[32,166,61],{"class":45},[10,168,169,170,173,174,177,178,181,182,185],{},"The script installs the binary to ",[13,171,172],{},"~\u002F.local\u002Fbin"," after checking its integrity. Set ",[13,175,176],{},"FEATHERLESS_CLOUD_INSTALL_DIR"," to install elsewhere, or ",[13,179,180],{},"FEATHERLESS_CLOUD_VERSION"," to pin a version. Add the folder to your ",[13,183,184],{},"PATH"," if the script asks.",[144,187,189,192,210],{"label":188},"npm",[10,190,191],{},"On any platform with Node.js:",[23,193,195],{"className":25,"code":194,"language":27,"meta":28,"style":28},"npm install --global @featherlessai\u002Fgpu-cloud-cli\n",[13,196,197],{"__ignoreMap":28},[32,198,199,201,204,207],{"class":34,"line":35},[32,200,188],{"class":45},[32,202,203],{"class":53}," install",[32,205,206],{"class":49}," --global",[32,208,209],{"class":53}," @featherlessai\u002Fgpu-cloud-cli\n",[10,211,212,213,216],{},"To try a command without installing, use ",[13,214,215],{},"npx @featherlessai\u002Fgpu-cloud-cli \u003Ccommand>",".",[10,218,219],{},"Check the installation:",[23,221,223],{"className":25,"code":222,"language":27,"meta":28,"style":28},"featherless-cloud --version\n",[13,224,225],{"__ignoreMap":28},[32,226,227,229],{"class":34,"line":35},[32,228,15],{"class":45},[32,230,231],{"class":49}," --version\n",[18,233,235],{"id":234},"sign-in","Sign in",[10,237,238,239,216],{},"The CLI signs in with an ",[240,241,243],"a",{"href":242},"\u002Fget-started\u002Fcredentials#create-an-api-key","API key",[23,245,247],{"className":25,"code":246,"language":27,"meta":28,"style":28},"featherless-cloud login\n",[13,248,249],{"__ignoreMap":28},[32,250,251,253],{"class":34,"line":35},[32,252,15],{"class":45},[32,254,82],{"class":53},[10,256,257,260,261,265],{},[13,258,259],{},"login"," opens the console's ",[262,263,264],"strong",{},"API keys"," page in your browser. Create a key there and paste it into the terminal. In scripts and CI, pass the key directly:",[23,267,269],{"className":25,"code":268,"language":27,"meta":28,"style":28},"featherless-cloud login --key \"$FEATHERLESS_API_KEY\"\n",[13,270,271],{"__ignoreMap":28},[32,272,273,275,278,281,284,288],{"class":34,"line":35},[32,274,15],{"class":45},[32,276,277],{"class":53}," login",[32,279,280],{"class":49}," --key",[32,282,283],{"class":53}," \"",[32,285,287],{"class":286},"sZEs4","$FEATHERLESS_API_KEY",[32,289,290],{"class":53},"\"\n",[10,292,293,296],{},[13,294,295],{},"featherless-cloud logout"," signs you out. Revoke the key in the console too if you no longer need it.",[298,299,301],"h3",{"id":300},"profiles","Profiles",[10,303,304],{},"Store several keys, for example one per organization, under named profiles:",[23,306,308],{"className":25,"code":307,"language":27,"meta":28,"style":28},"featherless-cloud login --profile research\nfeatherless-cloud instance list --profile research\n",[13,309,310,322],{"__ignoreMap":28},[32,311,312,314,316,319],{"class":34,"line":35},[32,313,15],{"class":45},[32,315,277],{"class":53},[32,317,318],{"class":49}," --profile",[32,320,321],{"class":53}," research\n",[32,323,324,326,328,331,333],{"class":34,"line":42},[32,325,15],{"class":45},[32,327,101],{"class":53},[32,329,330],{"class":53}," list",[32,332,318],{"class":49},[32,334,321],{"class":53},[10,336,337,338,341,342,216],{},"Commands use the ",[13,339,340],{},"default"," profile unless you pass ",[13,343,344],{},"--profile",[18,346,348],{"id":347},"commands","Commands",[350,351,352,365],"table",{},[353,354,355],"thead",{},[356,357,358,362],"tr",{},[359,360,361],"th",{},"Command",[359,363,364],{},"What it does",[366,367,368,382,395,408,421,434,447,460,473,486,499,509],"tbody",{},[356,369,370,379],{},[371,372,373],"td",{},[240,374,376],{"href":375},"\u002Fcli\u002Finstance",[13,377,378],{},"instance",[371,380,381],{},"Create, list, start, stop, connect to and delete instances.",[356,383,384,392],{},[371,385,386],{},[240,387,389],{"href":388},"\u002Fcli\u002Fexec",[13,390,391],{},"exec",[371,393,394],{},"Run a command as a Run Job and stream its output.",[356,396,397,405],{},[371,398,399],{},[240,400,402],{"href":401},"\u002Fcli\u002Frunjob",[13,403,404],{},"runjob",[371,406,407],{},"List, follow, cancel and delete Run Jobs.",[356,409,410,418],{},[371,411,412],{},[240,413,415],{"href":414},"\u002Fcli\u002Fvolume",[13,416,417],{},"volume",[371,419,420],{},"Manage network volumes and the files in them.",[356,422,423,431],{},[371,424,425],{},[240,426,428],{"href":427},"\u002Fcli\u002Ftemplates",[13,429,430],{},"templates",[371,432,433],{},"Save, list and change templates.",[356,435,436,444],{},[371,437,438],{},[240,439,441],{"href":440},"\u002Fcli\u002Fssh-keys",[13,442,443],{},"ssh-keys",[371,445,446],{},"Manage your SSH public keys.",[356,448,449,457],{},[371,450,451],{},[240,452,454],{"href":453},"\u002Fcli\u002Fregistry-keys",[13,455,456],{},"registry-keys",[371,458,459],{},"Manage registry credentials for private images.",[356,461,462,470],{},[371,463,464],{},[240,465,467],{"href":466},"\u002Fcli\u002Fpricing",[13,468,469],{},"pricing",[371,471,472],{},"List current prices.",[356,474,475,483],{},[371,476,477],{},[240,478,480],{"href":479},"\u002Fcli\u002Fbilling",[13,481,482],{},"billing",[371,484,485],{},"Show your balance and billing history.",[356,487,488,496],{},[371,489,490,492,493],{},[13,491,259],{},", ",[13,494,495],{},"logout",[371,497,498],{},"Store or remove an API key.",[356,500,501,506],{},[371,502,503],{},[13,504,505],{},"upgrade",[371,507,508],{},"Install the latest version.",[356,510,511,516],{},[371,512,513],{},[13,514,515],{},"completion",[371,517,518],{},"Print a shell completion script.",[10,520,521,522,525],{},"Run any command with ",[13,523,524],{},"--help"," for its options. Commands accept a resource's name or its ID.",[18,527,529],{"id":528},"global-options","Global options",[350,531,532,541],{},[353,533,534],{},[356,535,536,539],{},[359,537,538],{},"Option",[359,540,364],{},[366,542,543,556,566],{},[356,544,545,550],{},[371,546,547],{},[13,548,549],{},"--json",[371,551,552,553,216],{},"Print JSON, including errors. Use it in scripts and with ",[13,554,555],{},"jq",[356,557,558,563],{},[371,559,560],{},[13,561,562],{},"--non-interactive",[371,564,565],{},"No prompts or spinners.",[356,567,568,576],{},[371,569,570,492,573],{},[13,571,572],{},"-V",[13,574,575],{},"--version",[371,577,578],{},"Print the version.",[23,580,582],{"className":25,"code":581,"language":27,"meta":28,"style":28},"featherless-cloud instance list --json | jq -r '.items[].name'\n",[13,583,584],{"__ignoreMap":28},[32,585,586,588,590,592,595,597,600,603],{"class":34,"line":35},[32,587,15],{"class":45},[32,589,101],{"class":53},[32,591,330],{"class":53},[32,593,594],{"class":49}," --json",[32,596,58],{"class":57},[32,598,599],{"class":45}," jq",[32,601,602],{"class":49}," -r",[32,604,605],{"class":53}," '.items[].name'\n",[10,607,608,609,612],{},"Commands that delete something ask for confirmation. Pass ",[13,610,611],{},"--yes"," when the command can't prompt.",[18,614,616],{"id":615},"shell-completion","Shell completion",[141,618,619,668],{},[144,620,622],{"label":621},"zsh",[23,623,625],{"className":25,"code":624,"language":27,"meta":28,"style":28},"mkdir -p ~\u002F.zsh\u002Fcompletions\nfeatherless-cloud completion zsh > ~\u002F.zsh\u002Fcompletions\u002F_featherless-cloud\necho 'fpath=(~\u002F.zsh\u002Fcompletions $fpath)' >> ~\u002F.zshrc\n",[13,626,627,638,654],{"__ignoreMap":28},[32,628,629,632,635],{"class":34,"line":35},[32,630,631],{"class":45},"mkdir",[32,633,634],{"class":49}," -p",[32,636,637],{"class":53}," ~\u002F.zsh\u002Fcompletions\n",[32,639,640,642,645,648,651],{"class":34,"line":42},[32,641,15],{"class":45},[32,643,644],{"class":53}," completion",[32,646,647],{"class":53}," zsh",[32,649,650],{"class":57}," >",[32,652,653],{"class":53}," ~\u002F.zsh\u002Fcompletions\u002F_featherless-cloud\n",[32,655,656,659,662,665],{"class":34,"line":64},[32,657,658],{"class":49},"echo",[32,660,661],{"class":53}," 'fpath=(~\u002F.zsh\u002Fcompletions $fpath)'",[32,663,664],{"class":57}," >>",[32,666,667],{"class":53}," ~\u002F.zshrc\n",[144,669,670],{"label":27},[23,671,673],{"className":25,"code":672,"language":27,"meta":28,"style":28},"echo 'eval \"$(featherless-cloud completion bash)\"' >> ~\u002F.bashrc\n",[13,674,675],{"__ignoreMap":28},[32,676,677,679,682,684],{"class":34,"line":35},[32,678,658],{"class":49},[32,680,681],{"class":53}," 'eval \"$(featherless-cloud completion bash)\"'",[32,683,664],{"class":57},[32,685,686],{"class":53}," ~\u002F.bashrc\n",[10,688,689,690,693],{},"Open a new shell. Tab then completes commands, options, and the names of your instances, Run Jobs, volumes, templates and folders in ",[13,691,692],{},"vol:\u002F\u002F"," paths.",[18,695,697],{"id":696},"update","Update",[10,699,700,701,703],{},"The CLI tells you when a new version is out. ",[13,702,505],{}," updates either kind of install:",[23,705,707],{"className":25,"code":706,"language":27,"meta":28,"style":28},"featherless-cloud upgrade\n",[13,708,709],{"__ignoreMap":28},[32,710,711,713],{"class":34,"line":35},[32,712,15],{"class":45},[32,714,715],{"class":53}," upgrade\n",[717,718,719],"style",{},"html pre.shiki code .sH3jZ, html code.shiki .sH3jZ{--shiki-default:#8B949E}html pre.shiki code .sQhOw, html code.shiki .sQhOw{--shiki-default:#FFA657}html pre.shiki code .sFSAA, html code.shiki .sFSAA{--shiki-default:#79C0FF}html pre.shiki code .s9uIt, html code.shiki .s9uIt{--shiki-default:#A5D6FF}html pre.shiki code .suJrU, html code.shiki .suJrU{--shiki-default:#FF7B72}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);}html pre.shiki code .sZEs4, html code.shiki .sZEs4{--shiki-default:#E6EDF3}",{"title":28,"searchDepth":42,"depth":42,"links":721},[722,723,724,727,728,729,730],{"id":20,"depth":42,"text":21},{"id":138,"depth":42,"text":139},{"id":234,"depth":42,"text":235,"children":725},[726],{"id":300,"depth":64,"text":301},{"id":347,"depth":42,"text":348},{"id":528,"depth":42,"text":529},{"id":615,"depth":42,"text":616},{"id":696,"depth":42,"text":697},"Manage GPU instances, Run Jobs and files from your terminal or your scripts.","md",{},"\u002Fcli",{"title":5,"description":731},"cli\u002Findex","uw1Dd-CLJ10l3YTnzJjtoZ_YHfjcbTdIEJXUvj0VLFo",[739,740],null,{"title":741,"path":742,"description":743},"CLI troubleshooting","\u002Fcli\u002Ftroubleshooting","Fix common CLI errors, from sign-in and permission errors to commands in the wrong organization.",1794932598271]