[{"data":1,"prerenderedAt":920},["ShallowReactive",2],{"navigation_docs":3,"-command-line-getting-started":170,"-command-line-getting-started-surround":915},[4,25,102,122,152],{"title":5,"path":6,"stem":7,"children":8,"page":24},"Getting Started","/getting-started","1.getting-started",[9,14,19],{"title":10,"path":11,"stem":12,"icon":13},"What is Refbox?","/getting-started/what-is-refbox","1.getting-started/1.what-is-refbox","i-lucide-lightbulb",{"title":15,"path":16,"stem":17,"icon":18},"The Fundamentals","/getting-started/fundamentals","1.getting-started/2.fundamentals","i-lucide-brain",{"title":20,"path":21,"stem":22,"icon":23},"Your First Box","/getting-started/first-box","1.getting-started/3.first-box","i-lucide-rocket",false,{"title":26,"path":27,"stem":28,"children":29,"page":24},"Core Concepts","/core-concepts","2.core-concepts",[30,35,40,45,50],{"title":31,"path":32,"stem":33,"icon":34},"Boxes","/core-concepts/boxes","2.core-concepts/1.boxes","i-lucide-panel-left",{"title":36,"path":37,"stem":38,"icon":39},"Toolbar","/core-concepts/toolbar","2.core-concepts/1.toolbar","i-lucide-zap",{"title":41,"path":42,"stem":43,"icon":44},"Assets","/core-concepts/assets","2.core-concepts/2.assets","i-lucide-file",{"title":46,"path":47,"stem":48,"icon":49},"Gallery View","/core-concepts/gallery","2.core-concepts/3.gallery","i-lucide-images",{"title":51,"path":52,"stem":53,"children":54,"icon":56},"Frames","/core-concepts/frames","2.core-concepts/4.frames/index",[55,57,62,67,72,77,82,87,92,97],{"title":51,"path":52,"stem":53,"icon":56},"i-lucide-frame",{"title":58,"path":59,"stem":60,"icon":61},"Image","/core-concepts/frames/image-frames","2.core-concepts/4.frames/1.image-frames","i-lucide-image",{"title":63,"path":64,"stem":65,"icon":66},"Video","/core-concepts/frames/video-frames","2.core-concepts/4.frames/2.video-frames","i-lucide-video",{"title":68,"path":69,"stem":70,"icon":71},"Text","/core-concepts/frames/text-frames","2.core-concepts/4.frames/3.text-frames","i-lucide-type",{"title":73,"path":74,"stem":75,"icon":76},"Audio","/core-concepts/frames/audio-frames","2.core-concepts/4.frames/4.audio-frames","i-lucide-audio-lines",{"title":78,"path":79,"stem":80,"icon":81},"3D","/core-concepts/frames/3d-frames","2.core-concepts/4.frames/5.3d-frames","i-lucide-box",{"title":83,"path":84,"stem":85,"icon":86},"PDF","/core-concepts/frames/pdf-frames","2.core-concepts/4.frames/6.pdf-frames","i-lucide-file-text",{"title":88,"path":89,"stem":90,"icon":91},"Sketch","/core-concepts/frames/sketch-frames","2.core-concepts/4.frames/7.sketch-frames","i-lucide-pencil-line",{"title":93,"path":94,"stem":95,"icon":96},"Palette","/core-concepts/frames/palette-frames","2.core-concepts/4.frames/8.palette-frames","i-lucide-palette",{"title":98,"path":99,"stem":100,"icon":101},"Group","/core-concepts/frames/group-frames","2.core-concepts/4.frames/9.group-frames","i-lucide-layers",{"title":103,"path":104,"stem":105,"children":106,"page":24},"Command Line","/command-line","4.command-line",[107,112,117],{"title":108,"path":109,"stem":110,"icon":111},"Command Line Access","/command-line/getting-started","4.command-line/1.getting-started","i-lucide-terminal",{"title":113,"path":114,"stem":115,"icon":116},"CLI Reference","/command-line/cli-reference","4.command-line/2.cli-reference","i-lucide-list",{"title":118,"path":119,"stem":120,"icon":121},"MCP Setup","/command-line/mcp","4.command-line/3.mcp","i-lucide-plug",{"title":123,"path":124,"stem":125,"children":126,"page":24},"Reference","/reference","5.reference",[127,132,137,142,147],{"title":128,"path":129,"stem":130,"icon":131},"Shortcuts","/reference/shortcuts","5.reference/1.shortcuts","i-lucide-keyboard",{"title":133,"path":134,"stem":135,"icon":136},"Settings","/reference/settings","5.reference/2.settings","i-lucide-settings",{"title":138,"path":139,"stem":140,"icon":141},"FAQs","/reference/faq","5.reference/3.faq","i-lucide-help-circle",{"title":143,"path":144,"stem":145,"icon":146},"Troubleshooting","/reference/troubleshooting","5.reference/4.troubleshooting","i-lucide-wrench",{"title":148,"path":149,"stem":150,"icon":151},"Changelog","/reference/changelog","5.reference/5.changelog","i-lucide-history",{"title":153,"path":154,"stem":155,"children":156,"page":24},"Workflows","/workflows","5.workflows",[157,161,166],{"title":158,"path":159,"stem":160,"icon":96},"Digital Art","/workflows/digital-art","5.workflows/1.digital-art",{"title":162,"path":163,"stem":164,"icon":165},"UI/UX Design","/workflows/design-mockups","5.workflows/2.design-mockups","i-lucide-grid",{"title":167,"path":168,"stem":169,"icon":66},"Video & Motion","/workflows/video-editing","5.workflows/3.video-editing",{"id":171,"title":108,"body":172,"description":906,"extension":907,"links":908,"meta":909,"navigation":910,"path":109,"seo":911,"stem":110,"__hash__":914},"docs/4.command-line/1.getting-started.md",{"type":173,"value":174,"toc":887},"minimark",[175,184,189,246,256,260,263,305,312,338,345,368,372,375,417,424,428,432,472,486,490,493,539,542,546,629,636,640,701,721,725,732,735,782,788,792,795,813,820,824,827,834,838,848,854,873,883],[176,177,178,179,183],"p",{},"Command Line Access lets a terminal, script, or local agent read and change your Refbox data. The ",[180,181,182],"code",{},"refbox"," command connects only to the Refbox app running on your computer.",[185,186,188],"h2",{"id":187},"enable-the-cli","Enable the CLI",[190,191,192,197,204,208,218,222,225],"steps",{},[193,194,196],"h3",{"id":195},"open-settings","Open Settings",[176,198,199,200,203],{},"Open ",[180,201,202],{},"Settings > Data > Access Control",".",[193,205,207],{"id":206},"turn-on-command-line-access","Turn on Command Line Access",[176,209,210,211,214,215,217],{},"Enable ",[212,213,108],"strong",{},". Refbox installs the ",[180,216,182],{}," command on your PATH.",[193,219,221],{"id":220},"restart-your-terminal","Restart Your Terminal",[176,223,224],{},"Close and reopen any terminal windows that were already open. Then verify the connection:",[226,227,232],"pre",{"className":228,"code":229,"language":230,"meta":231,"style":231},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","refbox status\n","bash","",[180,233,234],{"__ignoreMap":231},[235,236,239,242],"span",{"class":237,"line":238},"line",1,[235,240,182],{"class":241},"sBMFI",[235,243,245],{"class":244},"sfazB"," status\n",[176,247,248,249,251,252,255],{},"Refbox must remain open and ",[212,250,108],{}," must remain enabled. If the command is missing or points to an older copy of Refbox, the setting shows a repair message and a ",[212,253,254],{},"Try again"," action.",[185,257,259],{"id":258},"first-commands","First Commands",[176,261,262],{},"Start by listing Boxes, then use the returned IDs to inspect their contents:",[226,264,266],{"className":228,"code":265,"language":230,"meta":231,"style":231},"refbox box list\nrefbox box show 3\nrefbox asset show 41\n",[180,267,268,278,292],{"__ignoreMap":231},[235,269,270,272,275],{"class":237,"line":238},[235,271,182],{"class":241},[235,273,274],{"class":244}," box",[235,276,277],{"class":244}," list\n",[235,279,281,283,285,288],{"class":237,"line":280},2,[235,282,182],{"class":241},[235,284,274],{"class":244},[235,286,287],{"class":244}," show",[235,289,291],{"class":290},"sbssI"," 3\n",[235,293,295,297,300,302],{"class":237,"line":294},3,[235,296,182],{"class":241},[235,298,299],{"class":244}," asset",[235,301,287],{"class":244},[235,303,304],{"class":290}," 41\n",[176,306,307,308,311],{},"Most commands that take a Box ID also accept an exact Box name with ",[180,309,310],{},"--name",":",[226,313,315],{"className":228,"code":314,"language":230,"meta":231,"style":231},"refbox box show --name \"Album art\"\n",[180,316,317],{"__ignoreMap":231},[235,318,319,321,323,325,328,332,335],{"class":237,"line":238},[235,320,182],{"class":241},[235,322,274],{"class":244},[235,324,287],{"class":244},[235,326,327],{"class":244}," --name",[235,329,331],{"class":330},"sMK4o"," \"",[235,333,334],{"class":244},"Album art",[235,336,337],{"class":330},"\"\n",[176,339,340,341,344],{},"Use ",[180,342,343],{},"--help"," for the current command list, or add it to one command for its arguments and examples:",[226,346,348],{"className":228,"code":347,"language":230,"meta":231,"style":231},"refbox --help\nrefbox asset move --help\n",[180,349,350,357],{"__ignoreMap":231},[235,351,352,354],{"class":237,"line":238},[235,353,182],{"class":241},[235,355,356],{"class":244}," --help\n",[235,358,359,361,363,366],{"class":237,"line":280},[235,360,182],{"class":241},[235,362,299],{"class":244},[235,364,365],{"class":244}," move",[235,367,356],{"class":244},[185,369,371],{"id":370},"json-output","JSON Output",[176,373,374],{},"Every successful command writes one JSON value to standard output. You do not\nneed an output-format flag:",[226,376,378],{"className":228,"code":377,"language":230,"meta":231,"style":231},"refbox box list\nrefbox search \"sunset\"\nrefbox asset path 41 --thumb\n",[180,379,380,388,402],{"__ignoreMap":231},[235,381,382,384,386],{"class":237,"line":238},[235,383,182],{"class":241},[235,385,274],{"class":244},[235,387,277],{"class":244},[235,389,390,392,395,397,400],{"class":237,"line":280},[235,391,182],{"class":241},[235,393,394],{"class":244}," search",[235,396,331],{"class":330},[235,398,399],{"class":244},"sunset",[235,401,337],{"class":330},[235,403,404,406,408,411,414],{"class":237,"line":294},[235,405,182],{"class":241},[235,407,299],{"class":244},[235,409,410],{"class":244}," path",[235,412,413],{"class":290}," 41",[235,415,416],{"class":244}," --thumb\n",[176,418,419,420,423],{},"Every failure writes one JSON error object to standard error and exits with a\nnon-zero code. ",[180,421,422],{},"refbox --help"," remains readable command help rather than a\ncommand result.",[185,425,427],{"id":426},"common-workflows","Common Workflows",[193,429,431],{"id":430},"find-and-inspect-an-asset","Find and inspect an Asset",[226,433,435],{"className":228,"code":434,"language":230,"meta":231,"style":231},"refbox search \"moodboard\"\nrefbox asset show 41\nrefbox asset path 41 --thumb\n",[180,436,437,450,460],{"__ignoreMap":231},[235,438,439,441,443,445,448],{"class":237,"line":238},[235,440,182],{"class":241},[235,442,394],{"class":244},[235,444,331],{"class":330},[235,446,447],{"class":244},"moodboard",[235,449,337],{"class":330},[235,451,452,454,456,458],{"class":237,"line":280},[235,453,182],{"class":241},[235,455,299],{"class":244},[235,457,287],{"class":244},[235,459,304],{"class":290},[235,461,462,464,466,468,470],{"class":237,"line":294},[235,463,182],{"class":241},[235,465,299],{"class":244},[235,467,410],{"class":244},[235,469,413],{"class":290},[235,471,416],{"class":244},[176,473,474,477,478,481,482,485],{},[180,475,476],{},"asset path --thumb"," returns an object whose ",[180,479,480],{},"path"," points to a 512 px\nderivative when one exists. It falls back to the source file when no derivative\nis available. The ",[180,483,484],{},"thumbnailKind"," field states which path was returned.",[193,487,489],{"id":488},"add-files-to-a-box","Add files to a Box",[176,491,492],{},"Preview a bulk change before you run it:",[226,494,496],{"className":228,"code":495,"language":230,"meta":231,"style":231},"refbox asset add 3 '*.png' --dry-run\nrefbox asset add 3 '*.png'\n",[180,497,498,522],{"__ignoreMap":231},[235,499,500,502,504,507,510,513,516,519],{"class":237,"line":238},[235,501,182],{"class":241},[235,503,299],{"class":244},[235,505,506],{"class":244}," add",[235,508,509],{"class":290}," 3",[235,511,512],{"class":330}," '",[235,514,515],{"class":244},"*.png",[235,517,518],{"class":330},"'",[235,520,521],{"class":244}," --dry-run\n",[235,523,524,526,528,530,532,534,536],{"class":237,"line":280},[235,525,182],{"class":241},[235,527,299],{"class":244},[235,529,506],{"class":244},[235,531,509],{"class":290},[235,533,512],{"class":330},[235,535,515],{"class":244},[235,537,538],{"class":330},"'\n",[176,540,541],{},"The command accepts local file paths, web-image URLs, and quoted file patterns.",[193,543,545],{"id":544},"create-or-update-a-note","Create or update a Note",[226,547,549],{"className":228,"code":548,"language":230,"meta":231,"style":231},"refbox note create 3 --text \"warm palette, low contrast\"\nrefbox note create 3 --markdown --text \"- [ ] frame the shot\"\nrefbox note read 12\nrefbox note update 12 --text \"warm palette, high contrast\"\n",[180,550,551,573,595,607],{"__ignoreMap":231},[235,552,553,555,558,561,563,566,568,571],{"class":237,"line":238},[235,554,182],{"class":241},[235,556,557],{"class":244}," note",[235,559,560],{"class":244}," create",[235,562,509],{"class":290},[235,564,565],{"class":244}," --text",[235,567,331],{"class":330},[235,569,570],{"class":244},"warm palette, low contrast",[235,572,337],{"class":330},[235,574,575,577,579,581,583,586,588,590,593],{"class":237,"line":280},[235,576,182],{"class":241},[235,578,557],{"class":244},[235,580,560],{"class":244},[235,582,509],{"class":290},[235,584,585],{"class":244}," --markdown",[235,587,565],{"class":244},[235,589,331],{"class":330},[235,591,592],{"class":244},"- [ ] frame the shot",[235,594,337],{"class":330},[235,596,597,599,601,604],{"class":237,"line":294},[235,598,182],{"class":241},[235,600,557],{"class":244},[235,602,603],{"class":244}," read",[235,605,606],{"class":290}," 12\n",[235,608,610,612,614,617,620,622,624,627],{"class":237,"line":609},4,[235,611,182],{"class":241},[235,613,557],{"class":244},[235,615,616],{"class":244}," update",[235,618,619],{"class":290}," 12",[235,621,565],{"class":244},[235,623,331],{"class":330},[235,625,626],{"class":244},"warm palette, high contrast",[235,628,337],{"class":330},[176,630,631,632,635],{},"If ",[180,633,634],{},"--text"," is absent, Note commands read standard input. An update replaces the complete Note; it does not append text.",[193,637,639],{"id":638},"create-or-update-a-palette","Create or update a Palette",[226,641,643],{"className":228,"code":642,"language":230,"meta":231,"style":231},"refbox palette create 3 --colors \"#F2EB8C, #DAFA10\"\nrefbox palette read 12\nrefbox palette update 12 --format hsl --colors \"#F2EB8C\"\n",[180,644,645,666,676],{"__ignoreMap":231},[235,646,647,649,652,654,656,659,661,664],{"class":237,"line":238},[235,648,182],{"class":241},[235,650,651],{"class":244}," palette",[235,653,560],{"class":244},[235,655,509],{"class":290},[235,657,658],{"class":244}," --colors",[235,660,331],{"class":330},[235,662,663],{"class":244},"#F2EB8C, #DAFA10",[235,665,337],{"class":330},[235,667,668,670,672,674],{"class":237,"line":280},[235,669,182],{"class":241},[235,671,651],{"class":244},[235,673,603],{"class":244},[235,675,606],{"class":290},[235,677,678,680,682,684,686,689,692,694,696,699],{"class":237,"line":294},[235,679,182],{"class":241},[235,681,651],{"class":244},[235,683,616],{"class":244},[235,685,619],{"class":290},[235,687,688],{"class":244}," --format",[235,690,691],{"class":244}," hsl",[235,693,658],{"class":244},[235,695,331],{"class":330},[235,697,698],{"class":244},"#F2EB8C",[235,700,337],{"class":330},[176,702,631,703,706,707,710,711,710,714,717,718,203],{},[180,704,705],{},"--colors"," is absent, Palette commands read standard input. An update replaces the complete color list. Valid formats are ",[180,708,709],{},"hex",", ",[180,712,713],{},"hexNoHash",[180,715,716],{},"rgb",", and ",[180,719,720],{},"hsl",[185,722,724],{"id":723},"safe-changes-and-the-trash","Safe Changes and the Trash",[176,726,727,728,731],{},"Commands that can affect many Assets support ",[180,729,730],{},"--dry-run",". Use it first to print the planned change without writing anything.",[176,733,734],{},"Deleting a Box or Asset sends it to the Trash:",[226,736,738],{"className":228,"code":737,"language":230,"meta":231,"style":231},"refbox asset delete 41 --dry-run\nrefbox asset delete 41\nrefbox trash list\nrefbox restore asset:41\n",[180,739,740,753,763,772],{"__ignoreMap":231},[235,741,742,744,746,749,751],{"class":237,"line":238},[235,743,182],{"class":241},[235,745,299],{"class":244},[235,747,748],{"class":244}," delete",[235,750,413],{"class":290},[235,752,521],{"class":244},[235,754,755,757,759,761],{"class":237,"line":280},[235,756,182],{"class":241},[235,758,299],{"class":244},[235,760,748],{"class":244},[235,762,304],{"class":290},[235,764,765,767,770],{"class":237,"line":294},[235,766,182],{"class":241},[235,768,769],{"class":244}," trash",[235,771,277],{"class":244},[235,773,774,776,779],{"class":237,"line":609},[235,775,182],{"class":241},[235,777,778],{"class":244}," restore",[235,780,781],{"class":244}," asset:41\n",[176,783,784,787],{},[180,785,786],{},"refbox trash empty"," permanently removes all Trash contents. It cannot be undone.",[185,789,791],{"id":790},"read-only-tokens","Read-Only Tokens",[176,793,794],{},"The default CLI connection can read and change data. Create a read-only token when a tool or agent must only inspect Refbox:",[226,796,798],{"className":228,"code":797,"language":230,"meta":231,"style":231},"refbox token issue --read-only\n",[180,799,800],{"__ignoreMap":231},[235,801,802,804,807,810],{"class":237,"line":238},[235,803,182],{"class":241},[235,805,806],{"class":244}," token",[235,808,809],{"class":244}," issue",[235,811,812],{"class":244}," --read-only\n",[176,814,815,816,819],{},"Pass the token through the ",[180,817,818],{},"REFBOX_TOKEN"," environment variable for that tool. A read-only token cannot run write commands.",[185,821,823],{"id":822},"scope-and-limits","Scope and Limits",[176,825,826],{},"The CLI works with Boxes, Sections, and Assets. It can read and update Notes and Palettes. It does not expose Groups, canvas Frames, or the position of an Asset on the canvas.",[176,828,829,830,833],{},"Opening a Box with ",[180,831,832],{},"refbox box open"," changes the Box shown in Refbox, but it does not bring the Refbox window to the front.",[185,835,837],{"id":836},"connection-problems","Connection Problems",[176,839,840,841,844,845,847],{},"Exit code ",[180,842,843],{},"3"," means that Refbox is not running or ",[212,846,108],{}," is off.",[176,849,850,851,853],{},"If your shell reports that ",[180,852,182],{}," was not found:",[855,856,857,861,864],"ol",{},[858,859,860],"li",{},"Confirm that Command Line Access is enabled.",[858,862,863],{},"Restart the terminal.",[858,865,866,867,869,870,872],{},"Return to ",[180,868,202],{}," and use ",[212,871,254],{}," if Refbox offers it.",[176,874,875,876,879,880,882],{},"See the ",[877,878,113],"a",{"href":114}," for every command and the ",[877,881,118],{"href":119}," page for clients that use Model Context Protocol.",[884,885,886],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}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 .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}",{"title":231,"searchDepth":280,"depth":280,"links":888},[889,894,895,896,902,903,904,905],{"id":187,"depth":280,"text":188,"children":890},[891,892,893],{"id":195,"depth":294,"text":196},{"id":206,"depth":294,"text":207},{"id":220,"depth":294,"text":221},{"id":258,"depth":280,"text":259},{"id":370,"depth":280,"text":371},{"id":426,"depth":280,"text":427,"children":897},[898,899,900,901],{"id":430,"depth":294,"text":431},{"id":488,"depth":294,"text":489},{"id":544,"depth":294,"text":545},{"id":638,"depth":294,"text":639},{"id":723,"depth":280,"text":724},{"id":790,"depth":280,"text":791},{"id":822,"depth":280,"text":823},{"id":836,"depth":280,"text":837},"Install and use the Refbox CLI to read and change Boxes from a terminal or local agent.","md",null,{},{"icon":111},{"title":912,"description":913},"Refbox Command Line Access","Enable the Refbox CLI, use JSON output, work safely with IDs and the Trash, and troubleshoot local connections.","Wy3kXO3vUJ3sOAidvIZlBJmcRGfJ11T-utk3M0Eci9M",[916,918],{"title":98,"path":99,"stem":100,"description":917,"icon":101,"children":-1},"Display multiple Assets together in a single Frame.",{"title":113,"path":114,"stem":115,"description":919,"icon":116,"children":-1},"Complete command, argument, flag, and exit-code reference for the Refbox CLI.",1786820274507]