[{"data":1,"prerenderedAt":543},["ShallowReactive",2],{"navigation_en":3,"-docs-uxd-configuration-editors":150,"-docs-uxd-configuration-editors-surround":538},{"docs":4},[5,41,86,121],{"title":6,"icon":7,"path":8,"stem":9,"children":10,"page":7},"Getting Started",false,"\u002Fdocs\u002Fuxd\u002Fgetting-started","docs\u002Fuxd\u002Fgetting-started",[11,16,21,26,31,36],{"title":12,"path":13,"stem":14,"icon":15},"Introduction","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Fintroduction","docs\u002Fuxd\u002Fgetting-started\u002F01.introduction","i-lucide-house",{"title":17,"path":18,"stem":19,"icon":20},"Installation","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Finstallation","docs\u002Fuxd\u002Fgetting-started\u002F02.installation","i-lucide-download",{"title":22,"path":23,"stem":24,"icon":25},"Quick Start","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Fquick-start","docs\u002Fuxd\u002Fgetting-started\u002F03.quick-start","i-lucide-zap",{"title":27,"path":28,"stem":29,"icon":30},"How It Works","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Fhow-it-works","docs\u002Fuxd\u002Fgetting-started\u002F04.how-it-works","i-lucide-workflow",{"title":32,"path":33,"stem":34,"icon":35},"Refs","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Frefs","docs\u002Fuxd\u002Fgetting-started\u002F05.refs","i-lucide-git-branch",{"title":37,"path":38,"stem":39,"icon":40},"Workspaces & Worktrees","\u002Fdocs\u002Fuxd\u002Fgetting-started\u002Fworkspaces","docs\u002Fuxd\u002Fgetting-started\u002F06.workspaces","i-lucide-folder-tree",{"title":42,"icon":7,"path":43,"stem":44,"children":45,"page":7},"Guides","\u002Fdocs\u002Fuxd\u002Fguides","docs\u002Fuxd\u002Fguides",[46,51,56,61,66,71,76,81],{"title":47,"path":48,"stem":49,"icon":50},"Review a Pull Request","\u002Fdocs\u002Fuxd\u002Fguides\u002Freview-a-pull-request","docs\u002Fuxd\u002Fguides\u002F01.review-a-pull-request","i-lucide-git-pull-request",{"title":52,"path":53,"stem":54,"icon":55},"Run Dev Servers in Parallel","\u002Fdocs\u002Fuxd\u002Fguides\u002Frun-dev-servers-in-parallel","docs\u002Fuxd\u002Fguides\u002F02.run-dev-servers-in-parallel","i-lucide-plug",{"title":57,"path":58,"stem":59,"icon":60},"Seed Local Files","\u002Fdocs\u002Fuxd\u002Fguides\u002Fseed-local-files","docs\u002Fuxd\u002Fguides\u002F03.seed-local-files","i-lucide-sprout",{"title":62,"path":63,"stem":64,"icon":65},"Refresh a Workspace","\u002Fdocs\u002Fuxd\u002Fguides\u002Frefresh-a-workspace","docs\u002Fuxd\u002Fguides\u002F04.refresh-a-workspace","i-lucide-refresh-cw",{"title":67,"path":68,"stem":69,"icon":70},"Clean Up Workspaces","\u002Fdocs\u002Fuxd\u002Fguides\u002Fclean-up-workspaces","docs\u002Fuxd\u002Fguides\u002F05.clean-up-workspaces","i-lucide-trash-2",{"title":72,"path":73,"stem":74,"icon":75},"Script with uxd","\u002Fdocs\u002Fuxd\u002Fguides\u002Fscript-with-uxd","docs\u002Fuxd\u002Fguides\u002F06.script-with-uxd","i-lucide-braces",{"title":77,"path":78,"stem":79,"icon":80},"Install Shell Completions","\u002Fdocs\u002Fuxd\u002Fguides\u002Fshell-completions","docs\u002Fuxd\u002Fguides\u002F07.shell-completions","i-lucide-keyboard",{"title":82,"path":83,"stem":84,"icon":85},"Troubleshooting","\u002Fdocs\u002Fuxd\u002Fguides\u002Ftroubleshooting","docs\u002Fuxd\u002Fguides\u002F08.troubleshooting","i-lucide-stethoscope",{"title":87,"icon":7,"path":88,"stem":89,"children":90,"page":7},"CLI Reference","\u002Fdocs\u002Fuxd\u002Fcli","docs\u002Fuxd\u002Fcli",[91,96,101,106,111,116],{"title":92,"path":93,"stem":94,"icon":95},"Command Grammar","\u002Fdocs\u002Fuxd\u002Fcli\u002Foverview","docs\u002Fuxd\u002Fcli\u002F01.overview","i-lucide-terminal",{"title":97,"path":98,"stem":99,"icon":100},"Workspace Verbs","\u002Fdocs\u002Fuxd\u002Fcli\u002Fworkspace-verbs","docs\u002Fuxd\u002Fcli\u002F02.workspace-verbs","i-lucide-folder-git-2",{"title":102,"path":103,"stem":104,"icon":105},"Project Verbs","\u002Fdocs\u002Fuxd\u002Fcli\u002Fproject-verbs","docs\u002Fuxd\u002Fcli\u002F03.project-verbs","i-lucide-boxes",{"title":107,"path":108,"stem":109,"icon":110},"Top-Level Verbs","\u002Fdocs\u002Fuxd\u002Fcli\u002Ftop-level-verbs","docs\u002Fuxd\u002Fcli\u002F04.top-level-verbs","i-lucide-wrench",{"title":112,"path":113,"stem":114,"icon":115},"Global Flags","\u002Fdocs\u002Fuxd\u002Fcli\u002Fglobal-flags","docs\u002Fuxd\u002Fcli\u002F05.global-flags","i-lucide-flag",{"title":117,"path":118,"stem":119,"icon":120},"Exit Codes","\u002Fdocs\u002Fuxd\u002Fcli\u002Fexit-codes","docs\u002Fuxd\u002Fcli\u002F06.exit-codes","i-lucide-circle-alert",{"title":122,"icon":7,"path":123,"stem":124,"children":125,"page":7},"Configuration","\u002Fdocs\u002Fuxd\u002Fconfiguration","docs\u002Fuxd\u002Fconfiguration",[126,131,136,141,145],{"title":127,"path":128,"stem":129,"icon":130},"Overview","\u002Fdocs\u002Fuxd\u002Fconfiguration\u002Foverview","docs\u002Fuxd\u002Fconfiguration\u002F01.overview","i-lucide-settings",{"title":132,"path":133,"stem":134,"icon":135},"Project File","\u002Fdocs\u002Fuxd\u002Fconfiguration\u002Fproject-file","docs\u002Fuxd\u002Fconfiguration\u002F02.project-file","i-lucide-file-code",{"title":137,"path":138,"stem":139,"icon":140},"Commands & Hooks","\u002Fdocs\u002Fuxd\u002Fconfiguration\u002Fcommands-and-hooks","docs\u002Fuxd\u002Fconfiguration\u002F03.commands-and-hooks","i-lucide-play",{"title":142,"path":143,"stem":144,"icon":75},"Environment & Templates","\u002Fdocs\u002Fuxd\u002Fconfiguration\u002Fenvironment-and-templates","docs\u002Fuxd\u002Fconfiguration\u002F04.environment-and-templates",{"title":146,"path":147,"stem":148,"icon":149},"Editors","\u002Fdocs\u002Fuxd\u002Fconfiguration\u002Feditors","docs\u002Fuxd\u002Fconfiguration\u002F05.editors","i-lucide-app-window",{"id":151,"title":146,"body":152,"description":529,"extension":530,"links":531,"meta":532,"navigation":533,"path":147,"seo":534,"stem":148,"__hash__":537},"docs_docs\u002Fdocs\u002Fuxd\u002Fconfiguration\u002F05.editors.md",{"type":153,"value":154,"toc":520},"minimark",[155,167,190,193,222,227,368,378,391,395,409,421,431,436,454,466,475,479,485,504,516],[156,157,158,162,163,166],"p",{},[159,160,161],"code",{},"uxd \u003Cproject> \u003Cref> code"," opens the workspace in the editor configured for that\nproject, falling back to ",[159,164,165],{},"defaults.editor",".",[168,169,175],"pre",{"className":170,"code":171,"filename":172,"language":173,"meta":174,"style":174},"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","",[159,176,177],{"__ignoreMap":174},[178,179,182,186],"span",{"class":180,"line":181},"line",1,[178,183,185],{"class":184},"s7iLA","editor = ",[178,187,189],{"class":188},"semJd","\"zed\"\n",[156,191,192],{},"Override for one invocation:",[168,194,198],{"className":195,"code":196,"language":197,"meta":174,"style":174},"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",[159,199,200],{"__ignoreMap":174},[178,201,202,206,209,213,216,219],{"class":180,"line":181},[178,203,205],{"class":204},"szw1H","uxd",[178,207,208],{"class":188}," my-project",[178,210,212],{"class":211},"ssYy9"," 42",[178,214,215],{"class":188}," code",[178,217,218],{"class":211}," --editor",[178,220,221],{"class":188}," vim\n",[223,224,226],"h2",{"id":225},"presets","Presets",[228,229,230,246],"table",{},[231,232,233],"thead",{},[234,235,236,240,243],"tr",{},[237,238,239],"th",{},"Preset",[237,241,242],{},"Launches",[237,244,245],{},"uxd waits?",[247,248,249,265,278,292,306,330,353],"tbody",{},[234,250,251,257,262],{},[252,253,254],"td",{},[159,255,256],{},"zed",[252,258,259],{},[159,260,261],{},"zed \u003Cpath>",[252,263,264],{},"no",[234,266,267,271,276],{},[252,268,269],{},[159,270,159],{},[252,272,273],{},[159,274,275],{},"code --new-window \u003Cpath>",[252,277,264],{},[234,279,280,285,290],{},[252,281,282],{},[159,283,284],{},"cursor",[252,286,287],{},[159,288,289],{},"cursor --new-window \u003Cpath>",[252,291,264],{},[234,293,294,299,304],{},[252,295,296],{},[159,297,298],{},"windsurf",[252,300,301],{},[159,302,303],{},"windsurf \u003Cpath>",[252,305,264],{},[234,307,308,323,328],{},[252,309,310,313,314,313,317,313,320],{},[159,311,312],{},"idea"," · ",[159,315,316],{},"webstorm",[159,318,319],{},"phpstorm",[159,321,322],{},"goland",[252,324,325],{},[159,326,327],{},"\u003Cname> \u003Cpath>",[252,329,264],{},[234,331,332,346,350],{},[252,333,334,313,337,313,340,313,343],{},[159,335,336],{},"vim",[159,338,339],{},"nvim",[159,341,342],{},"helix",[159,344,345],{},"hx",[252,347,348],{},[159,349,327],{},[252,351,352],{},"yes",[234,354,355,360,366],{},[252,356,357],{},[159,358,359],{},"terminal",[252,361,362,365],{},[159,363,364],{},"$SHELL",", with the workspace as the working directory",[252,367,352],{},[156,369,370,371,374,375,377],{},"GUI presets are detached, so ",[159,372,373],{},"uxd code"," returns immediately. Terminal editors\nand ",[159,376,359],{}," stay in the foreground until they exit.",[379,380,381,384,385,388,389,166],"note",{},[159,382,383],{},"uxd doctor"," checks that the configured editor's binary is on ",[159,386,387],{},"PATH"," and warns\nwhen it is not — the failure would otherwise only show up the first time you run\n",[159,390,159],{},[223,392,394],{"id":393},"custom-templates","Custom templates",[156,396,397,398,401,402,405,406,408],{},"Anything that is not a preset name is treated as a template and must contain\n",[159,399,400],{},"{path}",". It runs through ",[159,403,404],{},"bash -c",", with ",[159,407,400],{}," shell-escaped for you:",[168,410,412],{"className":170,"code":411,"language":173,"meta":174,"style":174},"editor = \"emacsclient -n {path}\"\n",[159,413,414],{"__ignoreMap":174},[178,415,416,418],{"class":180,"line":181},[178,417,185],{"class":184},[178,419,420],{"class":188},"\"emacsclient -n {path}\"\n",[156,422,423,424,428,429,166],{},"All the usual ",[425,426,427],"a",{"href":143},"template variables","\nare available, not just ",[159,430,400],{},[432,433,435],"h3",{"id":434},"staying-in-the-foreground","Staying in the foreground",[156,437,438,439,442,443,447,448,450,451,453],{},"Append ",[159,440,441],{},":wait"," to a ",[444,445,446],"strong",{},"template"," to keep ",[159,449,205],{}," running until the editor exits —\nuseful when ",[159,452,373],{}," is part of a script.",[168,455,457],{"className":170,"code":456,"language":173,"meta":174,"style":174},"editor = \"kak {path}:wait\"\n",[159,458,459],{"__ignoreMap":174},[178,460,461,463],{"class":180,"line":181},[178,462,185],{"class":184},[178,464,465],{"class":188},"\"kak {path}:wait\"\n",[156,467,468,469,471,472,474],{},"Without ",[159,470,441],{},", a template is launched detached and ",[159,473,205],{}," returns immediately.\nPresets carry their own waiting behaviour, shown in the table above.",[223,476,478],{"id":477},"checking-what-would-launch","Checking what would launch",[156,480,481,484],{},[159,482,483],{},"--dry-run"," prints the exact argv without opening anything:",[168,486,488],{"className":195,"code":487,"language":197,"meta":174,"style":174},"uxd my-project feat\u002Flogin code --dry-run\n",[159,489,490],{"__ignoreMap":174},[178,491,492,494,496,499,501],{"class":180,"line":181},[178,493,205],{"class":204},[178,495,208],{"class":188},[178,497,498],{"class":188}," feat\u002Flogin",[178,500,215],{"class":188},[178,502,503],{"class":211}," --dry-run\n",[156,505,506,509,510,512,513,166],{},[159,507,508],{},"--json"," is not supported for ",[159,511,159],{}," — it opens a program rather than producing\ndata, and asking for both exits ",[159,514,515],{},"2",[517,518,519],"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":174,"searchDepth":521,"depth":521,"links":522},2,[523,524,528],{"id":225,"depth":521,"text":226},{"id":393,"depth":521,"text":394,"children":525},[526],{"id":434,"depth":527,"text":435},3,{"id":477,"depth":521,"text":478},"Configure which editor uxd code opens, using a preset name or a custom template.","md",null,{},{"icon":149},{"title":535,"description":536},"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.","q9gWCB1f_B0JHuZUri_P_JHE6CtXt_1tXUA62WNn4I4",[539,541],{"title":142,"path":143,"stem":144,"description":540,"icon":75,"children":-1},"The {port} family of template variables, where they can be used, and the UXD_* variables every child process receives.",{"title":12,"path":13,"stem":14,"description":542,"icon":15,"children":-1},"uxd materializes any git ref of a configured project into an isolated, runnable local workspace with one command.",1789131073989]