[{"data":1,"prerenderedAt":544},["ShallowReactive",2],{"navigation_en":3,"-docs-configuration-editors":153,"-docs-configuration-editors-surround":541},{"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":149,"body":155,"description":532,"extension":533,"links":534,"meta":535,"navigation":536,"path":150,"seo":537,"stem":151,"__hash__":540},"docs_configuration\u002Fdocs\u002Fconfiguration\u002F05.editors.md",{"type":156,"value":157,"toc":523},"minimark",[158,170,193,196,225,230,371,381,394,398,412,424,434,439,457,469,478,482,488,507,519],[159,160,161,165,166,169],"p",{},[162,163,164],"code",{},"uxd \u003Cproject> \u003Cref> code"," opens the workspace in the editor configured for that\nproject, falling back to ",[162,167,168],{},"defaults.editor",".",[171,172,178],"pre",{"className":173,"code":174,"filename":175,"language":176,"meta":177,"style":177},"language-toml shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","editor = \"zed\"\n","~\u002F.uxd\u002Fmy-project.toml","toml","",[162,179,180],{"__ignoreMap":177},[181,182,185,189],"span",{"class":183,"line":184},"line",1,[181,186,188],{"class":187},"s7iLA","editor = ",[181,190,192],{"class":191},"semJd","\"zed\"\n",[159,194,195],{},"Override for one invocation:",[171,197,201],{"className":198,"code":199,"language":200,"meta":177,"style":177},"language-bash shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","uxd my-project 42 code --editor vim\n","bash",[162,202,203],{"__ignoreMap":177},[181,204,205,209,212,216,219,222],{"class":183,"line":184},[181,206,208],{"class":207},"szw1H","uxd",[181,210,211],{"class":191}," my-project",[181,213,215],{"class":214},"ssYy9"," 42",[181,217,218],{"class":191}," code",[181,220,221],{"class":214}," --editor",[181,223,224],{"class":191}," vim\n",[226,227,229],"h2",{"id":228},"presets","Presets",[231,232,233,249],"table",{},[234,235,236],"thead",{},[237,238,239,243,246],"tr",{},[240,241,242],"th",{},"Preset",[240,244,245],{},"Launches",[240,247,248],{},"uxd waits?",[250,251,252,268,281,295,309,333,356],"tbody",{},[237,253,254,260,265],{},[255,256,257],"td",{},[162,258,259],{},"zed",[255,261,262],{},[162,263,264],{},"zed \u003Cpath>",[255,266,267],{},"no",[237,269,270,274,279],{},[255,271,272],{},[162,273,162],{},[255,275,276],{},[162,277,278],{},"code --new-window \u003Cpath>",[255,280,267],{},[237,282,283,288,293],{},[255,284,285],{},[162,286,287],{},"cursor",[255,289,290],{},[162,291,292],{},"cursor --new-window \u003Cpath>",[255,294,267],{},[237,296,297,302,307],{},[255,298,299],{},[162,300,301],{},"windsurf",[255,303,304],{},[162,305,306],{},"windsurf \u003Cpath>",[255,308,267],{},[237,310,311,326,331],{},[255,312,313,316,317,316,320,316,323],{},[162,314,315],{},"idea"," · ",[162,318,319],{},"webstorm",[162,321,322],{},"phpstorm",[162,324,325],{},"goland",[255,327,328],{},[162,329,330],{},"\u003Cname> \u003Cpath>",[255,332,267],{},[237,334,335,349,353],{},[255,336,337,316,340,316,343,316,346],{},[162,338,339],{},"vim",[162,341,342],{},"nvim",[162,344,345],{},"helix",[162,347,348],{},"hx",[255,350,351],{},[162,352,330],{},[255,354,355],{},"yes",[237,357,358,363,369],{},[255,359,360],{},[162,361,362],{},"terminal",[255,364,365,368],{},[162,366,367],{},"$SHELL",", with the workspace as the working directory",[255,370,355],{},[159,372,373,374,377,378,380],{},"GUI presets are detached, so ",[162,375,376],{},"uxd code"," returns immediately. Terminal editors\nand ",[162,379,362],{}," stay in the foreground until they exit.",[382,383,384,387,388,391,392,169],"note",{},[162,385,386],{},"uxd doctor"," checks that the configured editor's binary is on ",[162,389,390],{},"PATH"," and warns\nwhen it is not — the failure would otherwise only show up the first time you run\n",[162,393,162],{},[226,395,397],{"id":396},"custom-templates","Custom templates",[159,399,400,401,404,405,408,409,411],{},"Anything that is not a preset name is treated as a template and must contain\n",[162,402,403],{},"{path}",". It runs through ",[162,406,407],{},"bash -c",", with ",[162,410,403],{}," shell-escaped for you:",[171,413,415],{"className":173,"code":414,"language":176,"meta":177,"style":177},"editor = \"emacsclient -n {path}\"\n",[162,416,417],{"__ignoreMap":177},[181,418,419,421],{"class":183,"line":184},[181,420,188],{"class":187},[181,422,423],{"class":191},"\"emacsclient -n {path}\"\n",[159,425,426,427,431,432,169],{},"All the usual ",[428,429,430],"a",{"href":146},"template variables","\nare available, not just ",[162,433,403],{},[435,436,438],"h3",{"id":437},"staying-in-the-foreground","Staying in the foreground",[159,440,441,442,445,446,450,451,453,454,456],{},"Append ",[162,443,444],{},":wait"," to a ",[447,448,449],"strong",{},"template"," to keep ",[162,452,208],{}," running until the editor exits —\nuseful when ",[162,455,376],{}," is part of a script.",[171,458,460],{"className":173,"code":459,"language":176,"meta":177,"style":177},"editor = \"kak {path}:wait\"\n",[162,461,462],{"__ignoreMap":177},[181,463,464,466],{"class":183,"line":184},[181,465,188],{"class":187},[181,467,468],{"class":191},"\"kak {path}:wait\"\n",[159,470,471,472,474,475,477],{},"Without ",[162,473,444],{},", a template is launched detached and ",[162,476,208],{}," returns immediately.\nPresets carry their own waiting behaviour, shown in the table above.",[226,479,481],{"id":480},"checking-what-would-launch","Checking what would launch",[159,483,484,487],{},[162,485,486],{},"--dry-run"," prints the exact argv without opening anything:",[171,489,491],{"className":198,"code":490,"language":200,"meta":177,"style":177},"uxd my-project feat\u002Flogin code --dry-run\n",[162,492,493],{"__ignoreMap":177},[181,494,495,497,499,502,504],{"class":183,"line":184},[181,496,208],{"class":207},[181,498,211],{"class":191},[181,500,501],{"class":191}," feat\u002Flogin",[181,503,218],{"class":191},[181,505,506],{"class":214}," --dry-run\n",[159,508,509,512,513,515,516,169],{},[162,510,511],{},"--json"," is not supported for ",[162,514,162],{}," — it opens a program rather than producing\ndata, and asking for both exits ",[162,517,518],{},"2",[520,521,522],"style",{},"html pre.shiki code .s7iLA, html code.shiki .s7iLA{--shiki-light:#0E1116;--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html pre.shiki code .semJd, html code.shiki .semJd{--shiki-light:#032563;--shiki-default:#032563;--shiki-dark:#ADDCFF}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 .szw1H, html code.shiki .szw1H{--shiki-light:#702C00;--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .ssYy9, html code.shiki .ssYy9{--shiki-light:#023B95;--shiki-default:#023B95;--shiki-dark:#91CBFF}",{"title":177,"searchDepth":524,"depth":524,"links":525},2,[526,527,531],{"id":228,"depth":524,"text":229},{"id":396,"depth":524,"text":397,"children":528},[529],{"id":437,"depth":530,"text":438},3,{"id":480,"depth":524,"text":481},"Configure which editor uxd code opens, using a preset name or a custom template.","md",null,{},{"icon":152},{"title":538,"description":539},"uxd Editor Configuration","Set the uxd editor with a preset (zed, code, cursor, vim, nvim, helix, terminal, JetBrains IDEs) or a custom template containing {path}, with :wait support.","JARsZcfGbO8JiAS9z_QNLUIPV6h7OIAzThJCwCIwd10",[542,534],{"title":145,"path":146,"stem":147,"description":543,"icon":76,"children":-1},"The {port} family of template variables, where they can be used, and the UXD_* variables every child process receives.",1784975262845]