[{"data":1,"prerenderedAt":978},["ShallowReactive",2],{"page-\u002Fcli\u002Finstance":3,"surround-\u002Fcli\u002Finstance":969},{"id":4,"title":5,"body":6,"description":961,"extension":962,"meta":963,"navigation":964,"path":965,"seo":966,"stem":967,"__hash__":968},"docs\u002Fcli\u002Finstance.md","instance",{"type":7,"value":8,"toc":951},"minimark",[9,17,56,59,64,166,370,374,408,440,444,461,464,468,516,601,604,608,646,654,658,687,709,713,759,801,807,811,863,892,924,947],[10,11,12,13,16],"p",{},"The ",[14,15,5],"code",{}," commands create, list, change, start, stop and delete instances, read their logs, and open terminals on them.",[18,19,24],"pre",{"className":20,"code":21,"language":22,"meta":23,"style":23},"language-bash shiki shiki-themes github-dark-default","featherless-cloud instance \u003Csubcommand> [options]\n","bash","",[14,25,26],{"__ignoreMap":23},[27,28,31,35,39,43,46,50,53],"span",{"class":29,"line":30},"line",1,[27,32,34],{"class":33},"sQhOw","featherless-cloud",[27,36,38],{"class":37},"s9uIt"," instance",[27,40,42],{"class":41},"suJrU"," \u003C",[27,44,45],{"class":37},"subcomman",[27,47,49],{"class":48},"sZEs4","d",[27,51,52],{"class":41},">",[27,54,55],{"class":48}," [options]\n",[10,57,58],{},"Subcommands that act on one instance take its name or its ID.",[60,61,63],"h2",{"id":62},"create-an-instance","Create an instance",[18,65,67],{"className":20,"code":66,"language":22,"meta":23,"style":23},"featherless-cloud instance create --name dev --template featherless\u002Frocm-pytorch --gpu-count 1\nfeatherless-cloud instance create --name api --image ghcr.io\u002Facme\u002Fapi:3 --registry ghcr --gpu-count 2 --port 8000\nfeatherless-cloud instance create --name prep --compute-type cpu --cpu-cores 8 --volume data:\u002Fworkspace\n",[14,68,69,97,134],{"__ignoreMap":23},[27,70,71,73,75,78,82,85,88,91,94],{"class":29,"line":30},[27,72,34],{"class":33},[27,74,38],{"class":37},[27,76,77],{"class":37}," create",[27,79,81],{"class":80},"sFSAA"," --name",[27,83,84],{"class":37}," dev",[27,86,87],{"class":80}," --template",[27,89,90],{"class":37}," featherless\u002Frocm-pytorch",[27,92,93],{"class":80}," --gpu-count",[27,95,96],{"class":80}," 1\n",[27,98,100,102,104,106,108,111,114,117,120,123,125,128,131],{"class":29,"line":99},2,[27,101,34],{"class":33},[27,103,38],{"class":37},[27,105,77],{"class":37},[27,107,81],{"class":80},[27,109,110],{"class":37}," api",[27,112,113],{"class":80}," --image",[27,115,116],{"class":37}," ghcr.io\u002Facme\u002Fapi:3",[27,118,119],{"class":80}," --registry",[27,121,122],{"class":37}," ghcr",[27,124,93],{"class":80},[27,126,127],{"class":80}," 2",[27,129,130],{"class":80}," --port",[27,132,133],{"class":80}," 8000\n",[27,135,137,139,141,143,145,148,151,154,157,160,163],{"class":29,"line":136},3,[27,138,34],{"class":33},[27,140,38],{"class":37},[27,142,77],{"class":37},[27,144,81],{"class":80},[27,146,147],{"class":37}," prep",[27,149,150],{"class":80}," --compute-type",[27,152,153],{"class":37}," cpu",[27,155,156],{"class":80}," --cpu-cores",[27,158,159],{"class":80}," 8",[27,161,162],{"class":80}," --volume",[27,164,165],{"class":37}," data:\u002Fworkspace\n",[167,168,169,182],"table",{},[170,171,172],"thead",{},[173,174,175,179],"tr",{},[176,177,178],"th",{},"Option",[176,180,181],{},"Description",[183,184,185,196,218,228,242,252,262,272,282,292,306,316,326,336,346,360],"tbody",{},[173,186,187,193],{},[188,189,190],"td",{},[14,191,192],{},"--name \u003Cname>",[188,194,195],{},"Instance name. Random when omitted.",[173,197,198,203],{},[188,199,200],{},[14,201,202],{},"--template \u003Cname>",[188,204,205,206,209,210,213,214,217],{},"Template to deploy: your template's name, ",[14,207,208],{},"org\u002F\u003Cname>"," for one shared in your organization, ",[14,211,212],{},"featherless\u002F\u003Cname>"," for an official one, or an ID. Add ",[14,215,216],{},":\u003Cversion>"," for an official template's older version. Other options override the template.",[173,219,220,225],{},[188,221,222],{},[14,223,224],{},"--template-id \u003Cid>",[188,226,227],{},"Template to deploy, by ID.",[173,229,230,235],{},[188,231,232],{},[14,233,234],{},"--template-version \u003Cversion>",[188,236,237,238,241],{},"Version of an official template, such as ",[14,239,240],{},"2.12.0",". Newest by default.",[173,243,244,249],{},[188,245,246],{},[14,247,248],{},"--image \u003Creference>",[188,250,251],{},"Container image to run, or to replace the template's.",[173,253,254,259],{},[188,255,256],{},[14,257,258],{},"--registry \u003Cname|id>",[188,260,261],{},"Registry credential for a private image.",[173,263,264,269],{},[188,265,266],{},[14,267,268],{},"--compute-type \u003Cgpu|cpu>",[188,270,271],{},"GPU (default) or CPU compute.",[173,273,274,279],{},[188,275,276],{},[14,277,278],{},"--gpu-type \u003Ctext>",[188,280,281],{},"GPU model, matched on part of its name.",[173,283,284,289],{},[188,285,286],{},[14,287,288],{},"--gpu-count \u003Cn>",[188,290,291],{},"GPUs: 1, 2, 4 or 8.",[173,293,294,299],{},[188,295,296],{},[14,297,298],{},"--cpu-cores \u003Cn>",[188,300,301,302,305],{},"vCPUs, with ",[14,303,304],{},"--compute-type cpu",".",[173,307,308,313],{},[188,309,310],{},[14,311,312],{},"--disk \u003Cgb>",[188,314,315],{},"Container disk, 20–2,000. Default 20.",[173,317,318,323],{},[188,319,320],{},[14,321,322],{},"--volume \u003Cname>:\u003Cpath>",[188,324,325],{},"Mount a network volume. Repeatable.",[173,327,328,333],{},[188,329,330],{},[14,331,332],{},"--command \u003Cstring>",[188,334,335],{},"Start command, split on spaces, without shell quoting.",[173,337,338,343],{},[188,339,340],{},[14,341,342],{},"--env \u003CK=V>",[188,344,345],{},"Environment variable. Repeatable.",[173,347,348,353],{},[188,349,350],{},[14,351,352],{},"--secret \u003CK=V>",[188,354,355,356,359],{},"Secret variable, available as a file under ",[14,357,358],{},"$FEATHERLESS_SECRETS_PATH",". Repeatable.",[173,361,362,367],{},[188,363,364],{},[14,365,366],{},"--port \u003Cport>",[188,368,369],{},"Serve a port at a public HTTPS address. Repeatable.",[60,371,373],{"id":372},"list-instances","List instances",[18,375,377],{"className":20,"code":376,"language":22,"meta":23,"style":23},"featherless-cloud instance list\nfeatherless-cloud instance list --page 2 --limit 50\n",[14,378,379,388],{"__ignoreMap":23},[27,380,381,383,385],{"class":29,"line":30},[27,382,34],{"class":33},[27,384,38],{"class":37},[27,386,387],{"class":37}," list\n",[27,389,390,392,394,397,400,402,405],{"class":29,"line":99},[27,391,34],{"class":33},[27,393,38],{"class":37},[27,395,396],{"class":37}," list",[27,398,399],{"class":80}," --page",[27,401,127],{"class":80},[27,403,404],{"class":80}," --limit",[27,406,407],{"class":80}," 50\n",[167,409,410,418],{},[170,411,412],{},[173,413,414,416],{},[176,415,178],{},[176,417,181],{},[183,419,420,430],{},[173,421,422,427],{},[188,423,424],{},[14,425,426],{},"--page \u003Cn>",[188,428,429],{},"Page number. Default 1.",[173,431,432,437],{},[188,433,434],{},[14,435,436],{},"--limit \u003Cn>",[188,438,439],{},"Instances per page, 1–100. Default 20.",[60,441,443],{"id":442},"show-an-instance","Show an instance",[18,445,447],{"className":20,"code":446,"language":22,"meta":23,"style":23},"featherless-cloud instance get dev\n",[14,448,449],{"__ignoreMap":23},[27,450,451,453,455,458],{"class":29,"line":30},[27,452,34],{"class":33},[27,454,38],{"class":37},[27,456,457],{"class":37}," get",[27,459,460],{"class":37}," dev\n",[10,462,463],{},"Prints its status, compute, image, volumes, SSH command and public addresses.",[60,465,467],{"id":466},"change-an-instance","Change an instance",[18,469,471],{"className":20,"code":470,"language":22,"meta":23,"style":23},"featherless-cloud instance update dev --port 8000 --port 8888\nfeatherless-cloud instance update dev --disk 200 --env HF_HOME=\u002Fworkspace\u002Fhf\n",[14,472,473,494],{"__ignoreMap":23},[27,474,475,477,479,482,484,486,489,491],{"class":29,"line":30},[27,476,34],{"class":33},[27,478,38],{"class":37},[27,480,481],{"class":37}," update",[27,483,84],{"class":37},[27,485,130],{"class":80},[27,487,488],{"class":80}," 8000",[27,490,130],{"class":80},[27,492,493],{"class":80}," 8888\n",[27,495,496,498,500,502,504,507,510,513],{"class":29,"line":99},[27,497,34],{"class":33},[27,499,38],{"class":37},[27,501,481],{"class":37},[27,503,84],{"class":37},[27,505,506],{"class":80}," --disk",[27,508,509],{"class":80}," 200",[27,511,512],{"class":80}," --env",[27,514,515],{"class":37}," HF_HOME=\u002Fworkspace\u002Fhf\n",[167,517,518,526],{},[170,519,520],{},[173,521,522,524],{},[176,523,178],{},[176,525,181],{},[183,527,528,537,546,560,569,578,587],{},[173,529,530,534],{},[188,531,532],{},[14,533,192],{},[188,535,536],{},"Rename the instance.",[173,538,539,543],{},[188,540,541],{},[14,542,248],{},[188,544,545],{},"Container image.",[173,547,548,553],{},[188,549,550],{},[14,551,552],{},"--registry \u003Cname|id|null>",[188,554,555,556,559],{},"Registry credential, or ",[14,557,558],{},"null"," to pull without one.",[173,561,562,566],{},[188,563,564],{},[14,565,312],{},[188,567,568],{},"Container disk, 20–2,000.",[173,570,571,575],{},[188,572,573],{},[14,574,332],{},[188,576,577],{},"Start command.",[173,579,580,584],{},[188,581,582],{},[14,583,342],{},[188,585,586],{},"Environment variable. Repeatable. Replaces the whole list.",[173,588,589,594],{},[188,590,591],{},[14,592,593],{},"--port \u003Cport|none>",[188,595,596,597,600],{},"Public port. Repeatable. Replaces the whole list; ",[14,598,599],{},"none"," removes them all.",[10,602,603],{},"Port and name changes apply at once. Other changes restart a running instance, which erases its container disk.",[60,605,607],{"id":606},"start-stop-and-restart","Start, stop and restart",[18,609,611],{"className":20,"code":610,"language":22,"meta":23,"style":23},"featherless-cloud instance start dev\nfeatherless-cloud instance stop dev\nfeatherless-cloud instance restart dev\n",[14,612,613,624,635],{"__ignoreMap":23},[27,614,615,617,619,622],{"class":29,"line":30},[27,616,34],{"class":33},[27,618,38],{"class":37},[27,620,621],{"class":37}," start",[27,623,460],{"class":37},[27,625,626,628,630,633],{"class":29,"line":99},[27,627,34],{"class":33},[27,629,38],{"class":37},[27,631,632],{"class":37}," stop",[27,634,460],{"class":37},[27,636,637,639,641,644],{"class":29,"line":136},[27,638,34],{"class":33},[27,640,38],{"class":37},[27,642,643],{"class":37}," restart",[27,645,460],{"class":37},[10,647,648,649,305],{},"Stopping and restarting erase the container disk. See ",[650,651,653],"a",{"href":652},"\u002Finstances\u002Fmanage","Manage instances",[60,655,657],{"id":656},"delete-an-instance","Delete an instance",[18,659,661],{"className":20,"code":660,"language":22,"meta":23,"style":23},"featherless-cloud instance delete dev\nfeatherless-cloud instance delete dev --yes\n",[14,662,663,674],{"__ignoreMap":23},[27,664,665,667,669,672],{"class":29,"line":30},[27,666,34],{"class":33},[27,668,38],{"class":37},[27,670,671],{"class":37}," delete",[27,673,460],{"class":37},[27,675,676,678,680,682,684],{"class":29,"line":99},[27,677,34],{"class":33},[27,679,38],{"class":37},[27,681,671],{"class":37},[27,683,84],{"class":37},[27,685,686],{"class":80}," --yes\n",[167,688,689,697],{},[170,690,691],{},[173,692,693,695],{},[176,694,178],{},[176,696,181],{},[183,698,699],{},[173,700,701,706],{},[188,702,703],{},[14,704,705],{},"--yes",[188,707,708],{},"Skip the confirmation.",[60,710,712],{"id":711},"read-logs-and-history","Read logs and history",[18,714,716],{"className":20,"code":715,"language":22,"meta":23,"style":23},"featherless-cloud instance logs dev --follow\nfeatherless-cloud instance logs dev --tail 2000\nfeatherless-cloud instance history dev\n",[14,717,718,732,748],{"__ignoreMap":23},[27,719,720,722,724,727,729],{"class":29,"line":30},[27,721,34],{"class":33},[27,723,38],{"class":37},[27,725,726],{"class":37}," logs",[27,728,84],{"class":37},[27,730,731],{"class":80}," --follow\n",[27,733,734,736,738,740,742,745],{"class":29,"line":99},[27,735,34],{"class":33},[27,737,38],{"class":37},[27,739,726],{"class":37},[27,741,84],{"class":37},[27,743,744],{"class":80}," --tail",[27,746,747],{"class":80}," 2000\n",[27,749,750,752,754,757],{"class":29,"line":136},[27,751,34],{"class":33},[27,753,38],{"class":37},[27,755,756],{"class":37}," history",[27,758,460],{"class":37},[167,760,761,769],{},[170,762,763],{},[173,764,765,767],{},[176,766,178],{},[176,768,181],{},[183,770,771,781,791],{},[173,772,773,778],{},[188,774,775],{},[14,776,777],{},"--tail \u003Cn>",[188,779,780],{},"Recent lines to show, 1–5,000. Default 500.",[173,782,783,788],{},[188,784,785],{},[14,786,787],{},"--head",[188,789,790],{},"Show the beginning of the output instead.",[173,792,793,798],{},[188,794,795],{},[14,796,797],{},"--follow",[188,799,800],{},"Keep printing new lines.",[10,802,803,806],{},[14,804,805],{},"history"," lists lifecycle events such as starts, stops and failures.",[60,808,810],{"id":809},"open-a-terminal","Open a terminal",[18,812,814],{"className":20,"code":813,"language":22,"meta":23,"style":23},"featherless-cloud instance shell dev\nfeatherless-cloud instance ssh dev\nfeatherless-cloud instance tmux dev\nfeatherless-cloud instance tmux dev training\n",[14,815,816,827,838,849],{"__ignoreMap":23},[27,817,818,820,822,825],{"class":29,"line":30},[27,819,34],{"class":33},[27,821,38],{"class":37},[27,823,824],{"class":37}," shell",[27,826,460],{"class":37},[27,828,829,831,833,836],{"class":29,"line":99},[27,830,34],{"class":33},[27,832,38],{"class":37},[27,834,835],{"class":37}," ssh",[27,837,460],{"class":37},[27,839,840,842,844,847],{"class":29,"line":136},[27,841,34],{"class":33},[27,843,38],{"class":37},[27,845,846],{"class":37}," tmux",[27,848,460],{"class":37},[27,850,852,854,856,858,860],{"class":29,"line":851},4,[27,853,34],{"class":33},[27,855,38],{"class":37},[27,857,846],{"class":37},[27,859,84],{"class":37},[27,861,862],{"class":37}," training\n",[864,865,866,877,883],"ul",{},[867,868,869,872,873,876],"li",{},[14,870,871],{},"shell"," opens the browser terminal's shell, in the tmux session ",[14,874,875],{},"default",". It needs no SSH key.",[867,878,879,882],{},[14,880,881],{},"ssh"," connects with your OpenSSH client, SSH config and agent.",[867,884,885,888,889,891],{},[14,886,887],{},"tmux"," attaches to the tmux session ",[14,890,875],{},", or to the named session, creating it if needed. Names have 1–64 letters, numbers, underscores or hyphens.",[167,893,894,902],{},[170,895,896],{},[173,897,898,900],{},[176,899,178],{},[176,901,181],{},[183,903,904],{},[173,905,906,915],{},[188,907,908,911,912],{},[14,909,910],{},"-i",", ",[14,913,914],{},"--identity \u003Cfile>",[188,916,917,918,920,921,923],{},"Private key for ",[14,919,881],{}," and ",[14,922,887],{},". Otherwise your SSH config and agent apply.",[10,925,926,920,928,930,931,937,938,942,943,946],{},[14,927,881],{},[14,929,887],{}," need your public key added with ",[650,932,934],{"href":933},"\u002Fcli\u002Fssh-keys",[14,935,936],{},"ssh-keys add",". Detach from tmux with ",[939,940,941],"strong",{},"Ctrl-b d",". Press Enter, then ",[14,944,945],{},"~."," to disconnect SSH.",[948,949,950],"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 .suJrU, html code.shiki .suJrU{--shiki-default:#FF7B72}html pre.shiki code .sZEs4, html code.shiki .sZEs4{--shiki-default:#E6EDF3}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 .sFSAA, html code.shiki .sFSAA{--shiki-default:#79C0FF}",{"title":23,"searchDepth":99,"depth":99,"links":952},[953,954,955,956,957,958,959,960],{"id":62,"depth":99,"text":63},{"id":372,"depth":99,"text":373},{"id":442,"depth":99,"text":443},{"id":466,"depth":99,"text":467},{"id":606,"depth":99,"text":607},{"id":656,"depth":99,"text":657},{"id":711,"depth":99,"text":712},{"id":809,"depth":99,"text":810},"Deploy, control and connect to instances from your terminal.","md",{},true,"\u002Fcli\u002Finstance",{"title":5,"description":961},"cli\u002Finstance","UAfnD2tF7lCYzRCd62ALuLho66MBbGeFChE49jVt3WI",[970,974],{"title":971,"path":972,"description":973},"CLI troubleshooting","\u002Fcli\u002Ftroubleshooting","Fix common CLI errors, from sign-in and permission errors to commands in the wrong organization.",{"title":975,"path":976,"description":977},"exec","\u002Fcli\u002Fexec","Run a script on a remote GPU from your terminal, as if it ran locally.",1794932602200]