[{"data":1,"prerenderedAt":645},["ShallowReactive",2],{"navigation_en":3,"-docs-getting-started-installation":153,"-docs-getting-started-installation-surround":640},{"gettingStarted":4,"guides":41,"cli":87,"configuration":123},[5],{"title":6,"icon":7,"path":8,"stem":9,"children":10,"page":7},"Getting Started",false,"\u002Fdocs\u002Fgetting-started","docs\u002Fgetting-started",[11,16,21,26,31,36],{"title":12,"path":13,"stem":14,"icon":15},"Introduction","\u002Fdocs\u002Fgetting-started\u002Fintroduction","docs\u002Fgetting-started\u002F01.introduction","i-lucide-house",{"title":17,"path":18,"stem":19,"icon":20},"Installation","\u002Fdocs\u002Fgetting-started\u002Finstallation","docs\u002Fgetting-started\u002F02.installation","i-lucide-download",{"title":22,"path":23,"stem":24,"icon":25},"Quick Start","\u002Fdocs\u002Fgetting-started\u002Fquick-start","docs\u002Fgetting-started\u002F03.quick-start","i-lucide-zap",{"title":27,"path":28,"stem":29,"icon":30},"How It Works","\u002Fdocs\u002Fgetting-started\u002Fhow-it-works","docs\u002Fgetting-started\u002F04.how-it-works","i-lucide-workflow",{"title":32,"path":33,"stem":34,"icon":35},"Refs","\u002Fdocs\u002Fgetting-started\u002Frefs","docs\u002Fgetting-started\u002F05.refs","i-lucide-git-branch",{"title":37,"path":38,"stem":39,"icon":40},"Workspaces & Worktrees","\u002Fdocs\u002Fgetting-started\u002Fworkspaces","docs\u002Fgetting-started\u002F06.workspaces","i-lucide-folder-tree",[42],{"title":43,"icon":7,"path":44,"stem":45,"children":46,"page":7},"Guides","\u002Fdocs\u002Fguides","docs\u002Fguides",[47,52,57,62,67,72,77,82],{"title":48,"path":49,"stem":50,"icon":51},"Review a Pull Request","\u002Fdocs\u002Fguides\u002Freview-a-pull-request","docs\u002Fguides\u002F01.review-a-pull-request","i-lucide-git-pull-request",{"title":53,"path":54,"stem":55,"icon":56},"Run Dev Servers in Parallel","\u002Fdocs\u002Fguides\u002Frun-dev-servers-in-parallel","docs\u002Fguides\u002F02.run-dev-servers-in-parallel","i-lucide-plug",{"title":58,"path":59,"stem":60,"icon":61},"Seed Local Files","\u002Fdocs\u002Fguides\u002Fseed-local-files","docs\u002Fguides\u002F03.seed-local-files","i-lucide-sprout",{"title":63,"path":64,"stem":65,"icon":66},"Refresh a Workspace","\u002Fdocs\u002Fguides\u002Frefresh-a-workspace","docs\u002Fguides\u002F04.refresh-a-workspace","i-lucide-refresh-cw",{"title":68,"path":69,"stem":70,"icon":71},"Clean Up Workspaces","\u002Fdocs\u002Fguides\u002Fclean-up-workspaces","docs\u002Fguides\u002F05.clean-up-workspaces","i-lucide-trash-2",{"title":73,"path":74,"stem":75,"icon":76},"Script with uxd","\u002Fdocs\u002Fguides\u002Fscript-with-uxd","docs\u002Fguides\u002F06.script-with-uxd","i-lucide-braces",{"title":78,"path":79,"stem":80,"icon":81},"Install Shell Completions","\u002Fdocs\u002Fguides\u002Fshell-completions","docs\u002Fguides\u002F07.shell-completions","i-lucide-keyboard",{"title":83,"path":84,"stem":85,"icon":86},"Troubleshooting","\u002Fdocs\u002Fguides\u002Ftroubleshooting","docs\u002Fguides\u002F08.troubleshooting","i-lucide-stethoscope",[88],{"title":89,"icon":7,"path":90,"stem":91,"children":92,"page":7},"CLI Reference","\u002Fdocs\u002Fcli","docs\u002Fcli",[93,98,103,108,113,118],{"title":94,"path":95,"stem":96,"icon":97},"Command Grammar","\u002Fdocs\u002Fcli\u002Foverview","docs\u002Fcli\u002F01.overview","i-lucide-terminal",{"title":99,"path":100,"stem":101,"icon":102},"Workspace Verbs","\u002Fdocs\u002Fcli\u002Fworkspace-verbs","docs\u002Fcli\u002F02.workspace-verbs","i-lucide-folder-git-2",{"title":104,"path":105,"stem":106,"icon":107},"Project Verbs","\u002Fdocs\u002Fcli\u002Fproject-verbs","docs\u002Fcli\u002F03.project-verbs","i-lucide-boxes",{"title":109,"path":110,"stem":111,"icon":112},"Top-Level Verbs","\u002Fdocs\u002Fcli\u002Ftop-level-verbs","docs\u002Fcli\u002F04.top-level-verbs","i-lucide-wrench",{"title":114,"path":115,"stem":116,"icon":117},"Global Flags","\u002Fdocs\u002Fcli\u002Fglobal-flags","docs\u002Fcli\u002F05.global-flags","i-lucide-flag",{"title":119,"path":120,"stem":121,"icon":122},"Exit Codes","\u002Fdocs\u002Fcli\u002Fexit-codes","docs\u002Fcli\u002F06.exit-codes","i-lucide-circle-alert",[124],{"title":125,"icon":7,"path":126,"stem":127,"children":128,"page":7},"Configuration","\u002Fdocs\u002Fconfiguration","docs\u002Fconfiguration",[129,134,139,144,148],{"title":130,"path":131,"stem":132,"icon":133},"Overview","\u002Fdocs\u002Fconfiguration\u002Foverview","docs\u002Fconfiguration\u002F01.overview","i-lucide-settings",{"title":135,"path":136,"stem":137,"icon":138},"Project File","\u002Fdocs\u002Fconfiguration\u002Fproject-file","docs\u002Fconfiguration\u002F02.project-file","i-lucide-file-code",{"title":140,"path":141,"stem":142,"icon":143},"Commands & Hooks","\u002Fdocs\u002Fconfiguration\u002Fcommands-and-hooks","docs\u002Fconfiguration\u002F03.commands-and-hooks","i-lucide-play",{"title":145,"path":146,"stem":147,"icon":76},"Environment & Templates","\u002Fdocs\u002Fconfiguration\u002Fenvironment-and-templates","docs\u002Fconfiguration\u002F04.environment-and-templates",{"title":149,"path":150,"stem":151,"icon":152},"Editors","\u002Fdocs\u002Fconfiguration\u002Feditors","docs\u002Fconfiguration\u002F05.editors","i-lucide-app-window",{"id":154,"title":17,"body":155,"description":632,"extension":633,"links":634,"meta":635,"navigation":636,"path":18,"seo":637,"stem":19,"__hash__":639},"docs_gettingStarted\u002Fdocs\u002Fgetting-started\u002F02.installation.md",{"type":156,"value":157,"toc":621},"minimark",[158,163,237,244,262,266,285,351,354,366,386,390,406,535,557,561,564,596,606,610,617],[159,160,162],"h2",{"id":161},"requirements","Requirements",[164,165,166,182],"table",{},[167,168,169],"thead",{},[170,171,172,176,179],"tr",{},[173,174,175],"th",{},"Tool",[173,177,178],{},"Version",[173,180,181],{},"Required",[183,184,185,203,216],"tbody",{},[170,186,187,197,200],{},[188,189,190],"td",{},[191,192,196],"a",{"href":193,"rel":194},"https:\u002F\u002Fnodejs.org",[195],"nofollow","Node.js",[188,198,199],{},"≥ 18",[188,201,202],{},"Yes",[170,204,205,211,214],{},[188,206,207],{},[208,209,210],"code",{},"git",[188,212,213],{},"≥ 2.38",[188,215,202],{},[170,217,218,227,230],{},[188,219,220],{},[191,221,224],{"href":222,"rel":223},"https:\u002F\u002Fcli.github.com",[195],[208,225,226],{},"gh",[188,228,229],{},"any",[188,231,232,233,236],{},"No — enables PR metadata, ",[208,234,235],{},"gh pr diff",", and fork push-back",[238,239,240,243],"p",{},[208,241,242],{},"uxd"," runs on stock Node. No Bun, Deno, or other runtime is required, and any\npackage manager installs it.",[245,246,247,248,250,251,253,254,257,258,261],"note",{},"Every ",[208,249,226],{}," feature degrades gracefully when ",[208,252,226],{}," is missing or unauthenticated.\nPR checkout, ",[208,255,256],{},"diff",", and ",[208,259,260],{},"clean"," all fall back to plain git.",[159,263,265],{"id":264},"global-install","Global install",[238,267,268,270,271,277,278,280,281,284],{},[208,269,242],{}," publishes to npm as ",[272,273,274],"strong",{},[208,275,276],{},"@uxfront\u002Fuxd"," and installs a ",[208,279,242],{}," binary onto\nyour ",[208,282,283],{},"PATH",". This is the recommended install.",[286,287,288,317,334],"code-group",{},[289,290,296],"pre",{"className":291,"code":292,"filename":293,"language":294,"meta":295,"style":295},"language-bash shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","npm i -g @uxfront\u002Fuxd\n","npm","bash","",[208,297,298],{"__ignoreMap":295},[299,300,303,306,310,314],"span",{"class":301,"line":302},"line",1,[299,304,293],{"class":305},"szw1H",[299,307,309],{"class":308},"semJd"," i",[299,311,313],{"class":312},"ssYy9"," -g",[299,315,316],{"class":308}," @uxfront\u002Fuxd\n",[289,318,321],{"className":291,"code":319,"filename":320,"language":294,"meta":295,"style":295},"pnpm add -g @uxfront\u002Fuxd\n","pnpm",[208,322,323],{"__ignoreMap":295},[299,324,325,327,330,332],{"class":301,"line":302},[299,326,320],{"class":305},[299,328,329],{"class":308}," add",[299,331,313],{"class":312},[299,333,316],{"class":308},[289,335,338],{"className":291,"code":336,"filename":337,"language":294,"meta":295,"style":295},"yarn global add @uxfront\u002Fuxd\n","yarn",[208,339,340],{"__ignoreMap":295},[299,341,342,344,347,349],{"class":301,"line":302},[299,343,337],{"class":305},[299,345,346],{"class":308}," global",[299,348,329],{"class":308},[299,350,316],{"class":308},[238,352,353],{},"Confirm it landed:",[289,355,357],{"className":291,"code":356,"language":294,"meta":295,"style":295},"uxd version\n",[208,358,359],{"__ignoreMap":295},[299,360,361,363],{"class":301,"line":302},[299,362,242],{"class":305},[299,364,365],{"class":308}," version\n",[367,368,370,371,373,374,377,378,381,382,385],"tip",{"title":369},"uxd: command not found","Your package manager's global bin directory is not on your ",[208,372,283],{},". Add\n",[208,375,376],{},"$(npm prefix -g)\u002Fbin"," (npm), ",[208,379,380],{},"$(pnpm bin -g)"," (pnpm), or ",[208,383,384],{},"$(yarn global bin)","\n(yarn) to it.",[159,387,389],{"id":388},"install-from-a-clone","Install from a clone",[238,391,392,393,395,396,398,399,402,403,405],{},"Working on ",[208,394,242],{}," itself? ",[208,397,242],{}," ships as compiled JavaScript, so a clone install\nhas two steps — install dependencies, then build the ",[208,400,401],{},"dist\u002F"," output the CLI\nruns from — before you link it onto your ",[208,404,283],{},".",[407,408,410,415,462,466,521,525],"steps",{"level":409},"3",[411,412,414],"h3",{"id":413},"clone-and-build","Clone and build",[289,416,418],{"className":291,"code":417,"language":294,"meta":295,"style":295},"git clone git@github.com:uxfront-com\u002Fuxd.git\ncd uxd\nnpm install\nnpm run build           # emits dist\u002Fbin\u002Fuxd.js (the linked bin points here)\n",[208,419,420,430,439,447],{"__ignoreMap":295},[299,421,422,424,427],{"class":301,"line":302},[299,423,210],{"class":305},[299,425,426],{"class":308}," clone",[299,428,429],{"class":308}," git@github.com:uxfront-com\u002Fuxd.git\n",[299,431,433,436],{"class":301,"line":432},2,[299,434,435],{"class":312},"cd",[299,437,438],{"class":308}," uxd\n",[299,440,442,444],{"class":301,"line":441},3,[299,443,293],{"class":305},[299,445,446],{"class":308}," install\n",[299,448,450,452,455,458],{"class":301,"line":449},4,[299,451,293],{"class":305},[299,453,454],{"class":308}," run",[299,456,457],{"class":308}," build",[299,459,461],{"class":460},"sq92B","           # emits dist\u002Fbin\u002Fuxd.js (the linked bin points here)\n",[411,463,465],{"id":464},"link-it-onto-your-path","Link it onto your PATH",[286,467,468,480,498],{},[289,469,471],{"className":291,"code":470,"filename":293,"language":294,"meta":295,"style":295},"npm link\n",[208,472,473],{"__ignoreMap":295},[299,474,475,477],{"class":301,"line":302},[299,476,293],{"class":305},[299,478,479],{"class":308}," link\n",[289,481,483],{"className":291,"code":482,"filename":320,"language":294,"meta":295,"style":295},"pnpm link --global      # run `pnpm setup` once first\n",[208,484,485],{"__ignoreMap":295},[299,486,487,489,492,495],{"class":301,"line":302},[299,488,320],{"class":305},[299,490,491],{"class":308}," link",[299,493,494],{"class":312}," --global",[299,496,497],{"class":460},"      # run `pnpm setup` once first\n",[289,499,501],{"className":291,"code":500,"filename":337,"language":294,"meta":295,"style":295},"yarn global add \"file:$PWD\"\n",[208,502,503],{"__ignoreMap":295},[299,504,505,507,509,511,514,518],{"class":301,"line":302},[299,506,337],{"class":305},[299,508,346],{"class":308},[299,510,329],{"class":308},[299,512,513],{"class":308}," \"file:",[299,515,517],{"class":516},"s7iLA","$PWD",[299,519,520],{"class":308},"\"\n",[411,522,524],{"id":523},"verify","Verify",[289,526,527],{"className":291,"code":356,"language":294,"meta":295,"style":295},[208,528,529],{"__ignoreMap":295},[299,530,531,533],{"class":301,"line":302},[299,532,242],{"class":305},[299,534,365],{"class":308},[536,537,539,542,543,545,546,548,549,552,553,556],"warning",{"title":538},"Rebuild after pulling",[208,540,541],{},"npm link"," points ",[208,544,242],{}," at your clone's ",[208,547,401],{},", and the CLI runs compiled\noutput. Re-run ",[208,550,551],{},"npm run build"," after every ",[208,554,555],{},"git pull"," or your changes will not\ntake effect.",[159,558,560],{"id":559},"run-without-installing","Run without installing",[238,562,563],{},"Skip the global step and call the built entrypoint from the clone:",[289,565,567],{"className":291,"code":566,"language":294,"meta":295,"style":295},"npm install && npm run build\nnode dist\u002Fbin\u002Fuxd.js version\n",[208,568,569,586],{"__ignoreMap":295},[299,570,571,573,576,579,581,583],{"class":301,"line":302},[299,572,293],{"class":305},[299,574,575],{"class":308}," install",[299,577,578],{"class":516}," && ",[299,580,293],{"class":305},[299,582,454],{"class":308},[299,584,585],{"class":308}," build\n",[299,587,588,591,594],{"class":301,"line":432},[299,589,590],{"class":305},"node",[299,592,593],{"class":308}," dist\u002Fbin\u002Fuxd.js",[299,595,365],{"class":308},[238,597,598,599,601,602,605],{},"The rest of these docs write ",[208,600,242],{},". Substitute ",[208,603,604],{},"node dist\u002Fbin\u002Fuxd.js"," if you\nhave not linked it globally.",[159,607,609],{"id":608},"next","Next",[238,611,612,613,616],{},"Head to the ",[191,614,615],{"href":23},"quick start"," to configure your\nfirst project and materialize a workspace.",[618,619,620],"style",{},"html pre.shiki code .szw1H, html code.shiki .szw1H{--shiki-light:#702C00;--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .semJd, html code.shiki .semJd{--shiki-light:#032563;--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .ssYy9, html code.shiki .ssYy9{--shiki-light:#023B95;--shiki-default:#023B95;--shiki-dark:#91CBFF}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 .sq92B, html code.shiki .sq92B{--shiki-light:#66707B;--shiki-default:#66707B;--shiki-dark:#BDC4CC}html pre.shiki code .s7iLA, html code.shiki .s7iLA{--shiki-light:#0E1116;--shiki-default:#0E1116;--shiki-dark:#F0F3F6}",{"title":295,"searchDepth":432,"depth":432,"links":622},[623,624,625,630,631],{"id":161,"depth":432,"text":162},{"id":264,"depth":432,"text":265},{"id":388,"depth":432,"text":389,"children":626},[627,628,629],{"id":413,"depth":441,"text":414},{"id":464,"depth":441,"text":465},{"id":523,"depth":441,"text":524},{"id":559,"depth":432,"text":560},{"id":608,"depth":432,"text":609},"Install the uxd CLI globally, from a clone, or run it without installing.","md",null,{},{"icon":20},{"title":17,"description":638},"Requirements and install methods for the uxd CLI — global package manager install, install from a clone, or run the built entrypoint directly.","76TYywH_IpzZFdnnwhDt5Orb8Q1doZBrll9ezzuODBk",[641,643],{"title":12,"path":13,"stem":14,"description":642,"icon":15,"children":-1},"uxd materializes any git ref of a configured project into an isolated, runnable local workspace with one command.",{"title":22,"path":23,"stem":24,"description":644,"icon":25,"children":-1},"Go from a fresh install to a running workspace — configure a project, materialize a branch, run its dev server, and clean up.",1784975261264]