代码
注册 登录
简体中文
简体中文 English
openoker
/
SWE-agent
1
0
收藏 0
文件 工单管理 0 Wiki
目录树: 12ae8ba4d3
分支列表 标签列表

index.html 43 KB
文件历史 原始文件

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619 
  1. 

  2. <!doctype html>
    3. 

  3. <html lang="en" class="no-js">
    4. 

  4.   <head>
    5. 

  5.     
    6. 

  6.       <meta charset="utf-8">
    7. 

  7.       <meta name="viewport" content="width=device-width,initial-scale=1">
    8. 

  8.       
    9. 

  9.       
    10. 

  10.       
    11. 

  11.       
    12. 

  12.         <link rel="prev" href="../config/">
    13. 

  13.       
    14. 

  14.       
    15. 

  15.         <link rel="next" href="../demonstrations/">
    16. 

  16.       
    17. 

  17.       
    18. 

  18.       <link rel="icon" href="../../assets/swe-agent.svg">
    19. 

  19.       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
    20. 

  20.     
    21. 

  21.     
    22. 

  22.       
    23. 

  23.         <title>Command definitions - SWE-agent documentation</title>
    24. 

  24.       
    25. 

  25.     
    26. 

  26.     
    27. 

  27.       <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
    28. 

  28.       
    29. 

  29.         
    30. 

  30.         <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
    31. 

  31.       
    32. 

  32.       
    33. 

  33. 

  34. 

  35.     
    36. 

  36.     
    37. 

  37.       
    38. 

  38.     
    39. 

  39.     
    40. 

  40.       
    41. 

  41.         
    42. 

  42.         
    43. 

  43.         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    44. 

  44.         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
    45. 

  45.         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
    46. 

  46.       
    47. 

  47.     
    48. 

  48.     
    49. 

  49.       <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
    50. 

  50.     
    51. 

  51.       <link rel="stylesheet" href="../../assets/custom.css">
    52. 

  52.     
    53. 

  53.     <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    54. 

  54.     
    55. 

  55.       
    56. 

  56. 

  57.     
    58. 

  58.     
    59. 

  59.     
    60. 

  60.    <link href="../../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
    61. 

  61.     html.glightbox-open { overflow: initial; height: 100%; }
    62. 

  62.     .gslide-title { margin-top: 0px; user-select: text; }
    63. 

  63.     .gslide-desc { color: #666; user-select: text; }
    64. 

  64.     .gslide-image img { background: white; }
    65. 

  65.     .gscrollbar-fixer { padding-right: 15px; }
    66. 

  66.     .gdesc-inner { font-size: 0.75rem; }
    67. 

  67.     body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
    68. 

  68.     body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
    69. 

  69.     body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style> <script src="../../assets/javascripts/glightbox.min.js"></script></head>
    70. 

  70.   
    71. 

  71.   
    72. 

  72.     
    73. 

  73.     
    74. 

  74.       
    75. 

  75.     
    76. 

  76.     
    77. 

  77.     
    78. 

  78.     
    79. 

  79.     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
    80. 

  80.   
    81. 

  81.     
    82. 

  82.     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    83. 

  83.     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    84. 

  84.     <label class="md-overlay" for="__drawer"></label>
    85. 

  85.     <div data-md-component="skip">
    86. 

  86.       
    87. 

  87.         
    88. 

  88.         <a href="#command-configuration" class="md-skip">
    89. 

  89.           Skip to content
    90. 

  90.         </a>
    91. 

  91.       
    92. 

  92.     </div>
    93. 

  93.     <div data-md-component="announce">
    94. 

  94.       
    95. 

  95.         <aside class="md-banner">
    96. 

  96.           <div class="md-banner__inner md-grid md-typeset">
    97. 

  97.             
    98. 

  98.               <button class="md-banner__button md-icon" aria-label="Don't show this again">
    99. 

  99.                 
    100. 

  100.                 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
    101. 

  101.               </button>
    102. 

  102.             
    103. 

  103.             
    104. 

  104. <!-- This link won't work in local preview -->
    105. 

  105. <a href="SWE-agent/background#enigma" class="clickable-banner">
    106. 

  106.     <div>
    107. 

  107.         News: SWE-agent <span class="enigma">EniGMA</span> solves cybersecurity and CTF challanges to achieve <span class="enigma">3x improvement over previous SOTA!</span>
    108. 

  108.     </div>
    109. 

  109. </a>
    110. 

  110. 

  111.           </div>
    112. 

  112.           
    113. 

  113.             <script>var el=document.querySelector("[data-md-component=announce]");if(el){var content=el.querySelector(".md-typeset");__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0)}</script>
    114. 

  114.           
    115. 

  115.         </aside>
    116. 

  116.       
    117. 

  117.     </div>
    118. 

  118.     
    119. 

  119.     
    120. 

  120.       
    121. 

  121. 

  122.   
    123. 

  123. 

  124. <header class="md-header md-header--shadow" data-md-component="header">
    125. 

  125.   <nav class="md-header__inner md-grid" aria-label="Header">
    126. 

  126.     <a href="../.." title="SWE-agent documentation" class="md-header__button md-logo" aria-label="SWE-agent documentation" data-md-component="logo">
    127. 

  127.       
    128. 

  128.   <img src="../../assets/swe-agent.svg" alt="logo">
    129. 

  129. 

  130.     </a>
    131. 

  131.     <label class="md-header__button md-icon" for="__drawer">
    132. 

  132.       
    133. 

  133.       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    134. 

  134.     </label>
    135. 

  135.     <div class="md-header__title" data-md-component="header-title">
    136. 

  136.       <div class="md-header__ellipsis">
    137. 

  137.         <div class="md-header__topic">
    138. 

  138.           <span class="md-ellipsis">
    139. 

  139.             SWE-agent documentation
    140. 

  140.           </span>
    141. 

  141.         </div>
    142. 

  142.         <div class="md-header__topic" data-md-component="header-topic">
    143. 

  143.           <span class="md-ellipsis">
    144. 

  144.             
    145. 

  145.               Command definitions
    146. 

  146.             
    147. 

  147.           </span>
    148. 

  148.         </div>
    149. 

  149.       </div>
    150. 

  150.     </div>
    151. 

  151.     
    152. 

  152.       
    153. 

  153.         <form class="md-header__option" data-md-component="palette">
    154. 

  154.   
    155. 

  155.     
    156. 

  156.     
    157. 

  157.     
    158. 

  158.     <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_0">
    159. 

  159.     
    160. 

  160.       <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
    161. 

  161.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
    162. 

  162.       </label>
    163. 

  163.     
    164. 

  164.   
    165. 

  165.     
    166. 

  166.     
    167. 

  167.     
    168. 

  168.     <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="deep-orange"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_1">
    169. 

  169.     
    170. 

  170.       <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
    171. 

  171.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
    172. 

  172.       </label>
    173. 

  173.     
    174. 

  174.   
    175. 

  175.     
    176. 

  176.     
    177. 

  177.     
    178. 

  178.     <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="deep-orange"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_2">
    179. 

  179.     
    180. 

  180.       <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
    181. 

  181.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
    182. 

  182.       </label>
    183. 

  183.     
    184. 

  184.   
    185. 

  185. </form>
    186. 

  186.       
    187. 

  187.     
    188. 

  188.     
    189. 

  189.       <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    190. 

  190.     
    191. 

  191.     
    192. 

  192.     
    193. 

  193.       <label class="md-header__button md-icon" for="__search">
    194. 

  194.         
    195. 

  195.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
    196. 

  196.       </label>
    197. 

  197.       <div class="md-search" data-md-component="search" role="dialog">
    198. 

  198.   <label class="md-search__overlay" for="__search"></label>
    199. 

  199.   <div class="md-search__inner" role="search">
    200. 

  200.     <form class="md-search__form" name="search">
    201. 

  201.       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
    202. 

  202.       <label class="md-search__icon md-icon" for="__search">
    203. 

  203.         
    204. 

  204.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
    205. 

  205.         
    206. 

  206.         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
    207. 

  207.       </label>
    208. 

  208.       <nav class="md-search__options" aria-label="Search">
    209. 

  209.         
    210. 

  210.         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
    211. 

  211.           
    212. 

  212.           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
    213. 

  213.         </button>
    214. 

  214.       </nav>
    215. 

  215.       
    216. 

  216.     </form>
    217. 

  217.     <div class="md-search__output">
    218. 

  218.       <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
    219. 

  219.         <div class="md-search-result" data-md-component="search-result">
    220. 

  220.           <div class="md-search-result__meta">
    221. 

  221.             Initializing search
    222. 

  222.           </div>
    223. 

  223.           <ol class="md-search-result__list" role="presentation"></ol>
    224. 

  224.         </div>
    225. 

  225.       </div>
    226. 

  226.     </div>
    227. 

  227.   </div>
    228. 

  228. </div>
    229. 

  229.     
    230. 

  230.     
    231. 

  231.       <div class="md-header__source">
    232. 

  232.         <a href="https://github.com/princeton-nlp/SWE-agent" title="Go to repository" class="md-source" data-md-component="source">
    233. 

  233.   <div class="md-source__icon md-icon">
    234. 

  234.     
    235. 

  235.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
    236. 

  236.   </div>
    237. 

  237.   <div class="md-source__repository">
    238. 

  238.     princeton-nlp/SWE-agent
    239. 

  239.   </div>
    240. 

  240. </a>
    241. 

  241.       </div>
    242. 

  242.     
    243. 

  243.   </nav>
    244. 

  244.   
    245. 

  245. </header>
    246. 

  246.     
    247. 

  247.     <div class="md-container" data-md-component="container">
    248. 

  248.       
    249. 

  249.       
    250. 

  250.         
    251. 

  251.           
    252. 

  252.         
    253. 

  253.       
    254. 

  254.       <main class="md-main" data-md-component="main">
    255. 

  255.         <div class="md-main__inner md-grid">
    256. 

  256.           
    257. 

  257.             
    258. 

  258.               
    259. 

  259.               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
    260. 

  260.                 <div class="md-sidebar__scrollwrap">
    261. 

  261.                   <div class="md-sidebar__inner">
    262. 

  262.                     
    263. 

  263. 

  264. 

  265. 

  266. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
    267. 

  267.   <label class="md-nav__title" for="__drawer">
    268. 

  268.     <a href="../.." title="SWE-agent documentation" class="md-nav__button md-logo" aria-label="SWE-agent documentation" data-md-component="logo">
    269. 

  269.       
    270. 

  270.   <img src="../../assets/swe-agent.svg" alt="logo">
    271. 

  271. 

  272.     </a>
    273. 

  273.     SWE-agent documentation
    274. 

  274.   </label>
    275. 

  275.   
    276. 

  276.     <div class="md-nav__source">
    277. 

  277.       <a href="https://github.com/princeton-nlp/SWE-agent" title="Go to repository" class="md-source" data-md-component="source">
    278. 

  278.   <div class="md-source__icon md-icon">
    279. 

  279.     
    280. 

  280.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
    281. 

  281.   </div>
    282. 

  282.   <div class="md-source__repository">
    283. 

  283.     princeton-nlp/SWE-agent
    284. 

  284.   </div>
    285. 

  285. </a>
    286. 

  286.     </div>
    287. 

  287.   
    288. 

  288.   <ul class="md-nav__list" data-md-scrollfix>
    289. 

  289.     
    290. 

  290.       
    291. 

  291.       
    292. 

  292.   
    293. 

  293.   
    294. 

  294.   
    295. 

  295.   
    296. 

  296.     <li class="md-nav__item">
    297. 

  297.       <a href="../.." class="md-nav__link">
    298. 

  298.         
    299. 

  299.   
    300. 

  300.   <span class="md-ellipsis">
    301. 

  301.     Home
    302. 

  302.   </span>
    303. 

  303.   
    304. 

  304. 

  305.       </a>
    306. 

  306.     </li>
    307. 

  307.   
    308. 

  308. 

  309.     
    310. 

  310.       
    311. 

  311.       
    312. 

  312.   
    313. 

  313.   
    314. 

  314.   
    315. 

  315.   
    316. 

  316.     
    317. 

  317.     
    318. 

  318.       
    319. 

  319.         
    320. 

  320.           
    321. 

  321.         
    322. 

  322.       
    323. 

  323.         
    324. 

  324.       
    325. 

  325.         
    326. 

  326.       
    327. 

  327.         
    328. 

  328.       
    329. 

  329.     
    330. 

  330.     
    331. 

  331.     
    332. 

  332.     <li class="md-nav__item md-nav__item--nested">
    333. 

  333.       
    334. 

  334.         
    335. 

  335.         
    336. 

  336.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
    337. 

  337.         
    338. 

  338.           
    339. 

  339.           
    340. 

  340.           <div class="md-nav__link md-nav__container">
    341. 

  341.             <a href="../../background/" class="md-nav__link ">
    342. 

  342.               
    343. 

  343.   
    344. 

  344.   <span class="md-ellipsis">
    345. 

  345.     Project Overview
    346. 

  346.   </span>
    347. 

  347.   
    348. 

  348. 

  349.             </a>
    350. 

  350.             
    351. 

  351.               
    352. 

  352.               <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
    353. 

  353.                 <span class="md-nav__icon md-icon"></span>
    354. 

  354.               </label>
    355. 

  355.             
    356. 

  356.           </div>
    357. 

  357.         
    358. 

  358.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
    359. 

  359.           <label class="md-nav__title" for="__nav_2">
    360. 

  360.             <span class="md-nav__icon md-icon"></span>
    361. 

  361.             Project Overview
    362. 

  362.           </label>
    363. 

  363.           <ul class="md-nav__list" data-md-scrollfix>
    364. 

  364.             
    365. 

  365.               
    366. 

  366.             
    367. 

  367.               
    368. 

  368.                 
    369. 

  369.   
    370. 

  370.   
    371. 

  371.   
    372. 

  372.   
    373. 

  373.     <li class="md-nav__item">
    374. 

  374.       <a href="../../background/aci/" class="md-nav__link">
    375. 

  375.         
    376. 

  376.   
    377. 

  377.   <span class="md-ellipsis">
    378. 

  378.     Agent-Computer Interface
    379. 

  379.   </span>
    380. 

  380.   
    381. 

  381. 

  382.       </a>
    383. 

  383.     </li>
    384. 

  384.   
    385. 

  385. 

  386.               
    387. 

  387.             
    388. 

  388.               
    389. 

  389.                 
    390. 

  390.   
    391. 

  391.   
    392. 

  392.   
    393. 

  393.   
    394. 

  394.     <li class="md-nav__item">
    395. 

  395.       <a href="../../background/iat/" class="md-nav__link">
    396. 

  396.         
    397. 

  397.   
    398. 

  398.   <span class="md-ellipsis">
    399. 

  399.     Interactive Agent Tools
    400. 

  400.   </span>
    401. 

  401.   
    402. 

  402. 

  403.       </a>
    404. 

  404.     </li>
    405. 

  405.   
    406. 

  406. 

  407.               
    408. 

  408.             
    409. 

  409.               
    410. 

  410.                 
    411. 

  411.   
    412. 

  412.   
    413. 

  413.   
    414. 

  414.   
    415. 

  415.     <li class="md-nav__item">
    416. 

  416.       <a href="../../background/architecture/" class="md-nav__link">
    417. 

  417.         
    418. 

  418.   
    419. 

  419.   <span class="md-ellipsis">
    420. 

  420.     Architecture
    421. 

  421.   </span>
    422. 

  422.   
    423. 

  423. 

  424.       </a>
    425. 

  425.     </li>
    426. 

  426.   
    427. 

  427. 

  428.               
    429. 

  429.             
    430. 

  430.           </ul>
    431. 

  431.         </nav>
    432. 

  432.       
    433. 

  433.     </li>
    434. 

  434.   
    435. 

  435. 

  436.     
    437. 

  437.       
    438. 

  438.       
    439. 

  439.   
    440. 

  440.   
    441. 

  441.   
    442. 

  442.   
    443. 

  443.     
    444. 

  444.     
    445. 

  445.       
    446. 

  446.         
    447. 

  447.           
    448. 

  448.         
    449. 

  449.       
    450. 

  450.         
    451. 

  451.       
    452. 

  452.         
    453. 

  453.       
    454. 

  454.         
    455. 

  455.       
    456. 

  456.         
    457. 

  457.       
    458. 

  458.         
    459. 

  459.       
    460. 

  460.         
    461. 

  461.       
    462. 

  462.     
    463. 

  463.     
    464. 

  464.     
    465. 

  465.     <li class="md-nav__item md-nav__item--nested">
    466. 

  466.       
    467. 

  467.         
    468. 

  468.         
    469. 

  469.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
    470. 

  470.         
    471. 

  471.           
    472. 

  472.           
    473. 

  473.           <div class="md-nav__link md-nav__container">
    474. 

  474.             <a href="../../installation/" class="md-nav__link ">
    475. 

  475.               
    476. 

  476.   
    477. 

  477.   <span class="md-ellipsis">
    478. 

  478.     Installation
    479. 

  479.   </span>
    480. 

  480.   
    481. 

  481. 

  482.             </a>
    483. 

  483.             
    484. 

  484.               
    485. 

  485.               <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
    486. 

  486.                 <span class="md-nav__icon md-icon"></span>
    487. 

  487.               </label>
    488. 

  488.             
    489. 

  489.           </div>
    490. 

  490.         
    491. 

  491.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
    492. 

  492.           <label class="md-nav__title" for="__nav_3">
    493. 

  493.             <span class="md-nav__icon md-icon"></span>
    494. 

  494.             Installation
    495. 

  495.           </label>
    496. 

  496.           <ul class="md-nav__list" data-md-scrollfix>
    497. 

  497.             
    498. 

  498.               
    499. 

  499.             
    500. 

  500.               
    501. 

  501.                 
    502. 

  502.   
    503. 

  503.   
    504. 

  504.   
    505. 

  505.   
    506. 

  506.     <li class="md-nav__item">
    507. 

  507.       <a href="../../installation/codespaces/" class="md-nav__link">
    508. 

  508.         
    509. 

  509.   
    510. 

  510.   <span class="md-ellipsis">
    511. 

  511.     Use in-browser
    512. 

  512.   </span>
    513. 

  513.   
    514. 

  514. 

  515.       </a>
    516. 

  516.     </li>
    517. 

  517.   
    518. 

  518. 

  519.               
    520. 

  520.             
    521. 

  521.               
    522. 

  522.                 
    523. 

  523.   
    524. 

  524.   
    525. 

  525.   
    526. 

  526.   
    527. 

  527.     <li class="md-nav__item">
    528. 

  528.       <a href="../../installation/source/" class="md-nav__link">
    529. 

  529.         
    530. 

  530.   
    531. 

  531.   <span class="md-ellipsis">
    532. 

  532.     Install from source
    533. 

  533.   </span>
    534. 

  534.   
    535. 

  535. 

  536.       </a>
    537. 

  537.     </li>
    538. 

  538.   
    539. 

  539. 

  540.               
    541. 

  541.             
    542. 

  542.               
    543. 

  543.                 
    544. 

  544.   
    545. 

  545.   
    546. 

  546.   
    547. 

  547.   
    548. 

  548.     <li class="md-nav__item">
    549. 

  549.       <a href="../../installation/docker/" class="md-nav__link">
    550. 

  550.         
    551. 

  551.   
    552. 

  552.   <span class="md-ellipsis">
    553. 

  553.     Run with docker
    554. 

  554.   </span>
    555. 

  555.   
    556. 

  556. 

  557.       </a>
    558. 

  558.     </li>
    559. 

  559.   
    560. 

  560. 

  561.               
    562. 

  562.             
    563. 

  563.               
    564. 

  564.                 
    565. 

  565.   
    566. 

  566.   
    567. 

  567.   
    568. 

  568.   
    569. 

  569.     <li class="md-nav__item">
    570. 

  570.       <a href="../../installation/keys/" class="md-nav__link">
    571. 

  571.         
    572. 

  572.   
    573. 

  573.   <span class="md-ellipsis">
    574. 

  574.     API keys
    575. 

  575.   </span>
    576. 

  576.   
    577. 

  577. 

  578.       </a>
    579. 

  579.     </li>
    580. 

  580.   
    581. 

  581. 

  582.               
    583. 

  583.             
    584. 

  584.               
    585. 

  585.                 
    586. 

  586.   
    587. 

  587.   
    588. 

  588.   
    589. 

  589.   
    590. 

  590.     <li class="md-nav__item">
    591. 

  591.       <a href="../../installation/tips/" class="md-nav__link">
    592. 

  592.         
    593. 

  593.   
    594. 

  594.   <span class="md-ellipsis">
    595. 

  595.     Installation tips
    596. 

  596.   </span>
    597. 

  597.   
    598. 

  598. 

  599.       </a>
    600. 

  600.     </li>
    601. 

  601.   
    602. 

  602. 

  603.               
    604. 

  604.             
    605. 

  605.               
    606. 

  606.                 
    607. 

  607.   
    608. 

  608.   
    609. 

  609.   
    610. 

  610.   
    611. 

  611.     <li class="md-nav__item">
    612. 

  612.       <a href="../../installation/changelog/" class="md-nav__link">
    613. 

  613.         
    614. 

  614.   
    615. 

  615.   <span class="md-ellipsis">
    616. 

  616.     Changelog
    617. 

  617.   </span>
    618. 

  618.   
    619. 

  619. 

  620.       </a>
    621. 

  621.     </li>
    622. 

  622.   
    623. 

  623. 

  624.               
    625. 

  625.             
    626. 

  626.           </ul>
    627. 

  627.         </nav>
    628. 

  628.       
    629. 

  629.     </li>
    630. 

  630.   
    631. 

  631. 

  632.     
    633. 

  633.       
    634. 

  634.       
    635. 

  635.   
    636. 

  636.   
    637. 

  637.   
    638. 

  638.   
    639. 

  639.     
    640. 

  640.     
    641. 

  641.       
    642. 

  642.         
    643. 

  643.           
    644. 

  644.         
    645. 

  645.       
    646. 

  646.         
    647. 

  647.       
    648. 

  648.         
    649. 

  649.       
    650. 

  650.         
    651. 

  651.       
    652. 

  652.         
    653. 

  653.       
    654. 

  654.         
    655. 

  655.       
    656. 

  656.         
    657. 

  657.       
    658. 

  658.         
    659. 

  659.       
    660. 

  660.         
    661. 

  661.       
    662. 

  662.     
    663. 

  663.     
    664. 

  664.     
    665. 

  665.     <li class="md-nav__item md-nav__item--nested">
    666. 

  666.       
    667. 

  667.         
    668. 

  668.         
    669. 

  669.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
    670. 

  670.         
    671. 

  671.           
    672. 

  672.           
    673. 

  673.           <div class="md-nav__link md-nav__container">
    674. 

  674.             <a href="../../usage/" class="md-nav__link ">
    675. 

  675.               
    676. 

  676.   
    677. 

  677.   <span class="md-ellipsis">
    678. 

  678.     Usage
    679. 

  679.   </span>
    680. 

  680.   
    681. 

  681. 

  682.             </a>
    683. 

  683.             
    684. 

  684.               
    685. 

  685.               <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
    686. 

  686.                 <span class="md-nav__icon md-icon"></span>
    687. 

  687.               </label>
    688. 

  688.             
    689. 

  689.           </div>
    690. 

  690.         
    691. 

  691.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
    692. 

  692.           <label class="md-nav__title" for="__nav_4">
    693. 

  693.             <span class="md-nav__icon md-icon"></span>
    694. 

  694.             Usage
    695. 

  695.           </label>
    696. 

  696.           <ul class="md-nav__list" data-md-scrollfix>
    697. 

  697.             
    698. 

  698.               
    699. 

  699.             
    700. 

  700.               
    701. 

  701.                 
    702. 

  702.   
    703. 

  703.   
    704. 

  704.   
    705. 

  705.   
    706. 

  706.     <li class="md-nav__item">
    707. 

  707.       <a href="../../usage/cl_tutorial/" class="md-nav__link">
    708. 

  708.         
    709. 

  709.   
    710. 

  710.   <span class="md-ellipsis">
    711. 

  711.     Command line usage
    712. 

  712.   </span>
    713. 

  713.   
    714. 

  714. 

  715.       </a>
    716. 

  716.     </li>
    717. 

  717.   
    718. 

  718. 

  719.               
    720. 

  720.             
    721. 

  721.               
    722. 

  722.                 
    723. 

  723.   
    724. 

  724.   
    725. 

  725.   
    726. 

  726.   
    727. 

  727.     <li class="md-nav__item">
    728. 

  728.       <a href="../../usage/enigma/" class="md-nav__link">
    729. 

  729.         
    730. 

  730.   
    731. 

  731.   <span class="md-ellipsis">
    732. 

  732.     EnIGMA usage
    733. 

  733.   </span>
    734. 

  734.   
    735. 

  735. 

  736.       </a>
    737. 

  737.     </li>
    738. 

  738.   
    739. 

  739. 

  740.               
    741. 

  741.             
    742. 

  742.               
    743. 

  743.                 
    744. 

  744.   
    745. 

  745.   
    746. 

  746.   
    747. 

  747.   
    748. 

  748.     <li class="md-nav__item">
    749. 

  749.       <a href="../../usage/coding_challenges/" class="md-nav__link">
    750. 

  750.         
    751. 

  751.   
    752. 

  752.   <span class="md-ellipsis">
    753. 

  753.     Solving coding challenges
    754. 

  754.   </span>
    755. 

  755.   
    756. 

  756. 

  757.       </a>
    758. 

  758.     </li>
    759. 

  759.   
    760. 

  760. 

  761.               
    762. 

  762.             
    763. 

  763.               
    764. 

  764.                 
    765. 

  765.   
    766. 

  766.   
    767. 

  767.   
    768. 

  768.   
    769. 

  769.     <li class="md-nav__item">
    770. 

  770.       <a href="../../usage/web_ui/" class="md-nav__link">
    771. 

  771.         
    772. 

  772.   
    773. 

  773.   <span class="md-ellipsis">
    774. 

  774.     Using the web UI
    775. 

  775.   </span>
    776. 

  776.   
    777. 

  777. 

  778.       </a>
    779. 

  779.     </li>
    780. 

  780.   
    781. 

  781. 

  782.               
    783. 

  783.             
    784. 

  784.               
    785. 

  785.                 
    786. 

  786.   
    787. 

  787.   
    788. 

  788.   
    789. 

  789.   
    790. 

  790.     <li class="md-nav__item">
    791. 

  791.       <a href="../../usage/trajectories/" class="md-nav__link">
    792. 

  792.         
    793. 

  793.   
    794. 

  794.   <span class="md-ellipsis">
    795. 

  795.     Trajectories
    796. 

  796.   </span>
    797. 

  797.   
    798. 

  798. 

  799.       </a>
    800. 

  800.     </li>
    801. 

  801.   
    802. 

  802. 

  803.               
    804. 

  804.             
    805. 

  805.               
    806. 

  806.                 
    807. 

  807.   
    808. 

  808.   
    809. 

  809.   
    810. 

  810.   
    811. 

  811.     <li class="md-nav__item">
    812. 

  812.       <a href="../../usage/inspector/" class="md-nav__link">
    813. 

  813.         
    814. 

  814.   
    815. 

  815.   <span class="md-ellipsis">
    816. 

  816.     Trajectory inspector
    817. 

  817.   </span>
    818. 

  818.   
    819. 

  819. 

  820.       </a>
    821. 

  821.     </li>
    822. 

  822.   
    823. 

  823. 

  824.               
    825. 

  825.             
    826. 

  826.               
    827. 

  827.                 
    828. 

  828.   
    829. 

  829.   
    830. 

  830.   
    831. 

  831.   
    832. 

  832.     <li class="md-nav__item">
    833. 

  833.       <a href="../../usage/usage_faq/" class="md-nav__link">
    834. 

  834.         
    835. 

  835.   
    836. 

  836.   <span class="md-ellipsis">
    837. 

  837.     FAQ
    838. 

  838.   </span>
    839. 

  839.   
    840. 

  840. 

  841.       </a>
    842. 

  842.     </li>
    843. 

  843.   
    844. 

  844. 

  845.               
    846. 

  846.             
    847. 

  847.               
    848. 

  848.                 
    849. 

  849.   
    850. 

  850.   
    851. 

  851.   
    852. 

  852.   
    853. 

  853.     <li class="md-nav__item">
    854. 

  854.       <a href="../../usage/benchmarking/" class="md-nav__link">
    855. 

  855.         
    856. 

  856.   
    857. 

  857.   <span class="md-ellipsis">
    858. 

  858.     Benchmarking
    859. 

  859.   </span>
    860. 

  860.   
    861. 

  861. 

  862.       </a>
    863. 

  863.     </li>
    864. 

  864.   
    865. 

  865. 

  866.               
    867. 

  867.             
    868. 

  868.           </ul>
    869. 

  869.         </nav>
    870. 

  870.       
    871. 

  871.     </li>
    872. 

  872.   
    873. 

  873. 

  874.     
    875. 

  875.       
    876. 

  876.       
    877. 

  877.   
    878. 

  878.   
    879. 

  879.     
    880. 

  880.   
    881. 

  881.   
    882. 

  882.   
    883. 

  883.     
    884. 

  884.     
    885. 

  885.       
    886. 

  886.         
    887. 

  887.       
    888. 

  888.         
    889. 

  889.       
    890. 

  890.         
    891. 

  891.       
    892. 

  892.         
    893. 

  893.       
    894. 

  894.         
    895. 

  895.       
    896. 

  896.         
    897. 

  897.       
    898. 

  898.     
    899. 

  899.     
    900. 

  900.     
    901. 

  901.     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
    902. 

  902.       
    903. 

  903.         
    904. 

  904.         
    905. 

  905.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
    906. 

  906.         
    907. 

  907.           
    908. 

  908.           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
    909. 

  909.             
    910. 

  910.   
    911. 

  911.   <span class="md-ellipsis">
    912. 

  912.     Configuration
    913. 

  913.   </span>
    914. 

  914.   
    915. 

  915. 

  916.             <span class="md-nav__icon md-icon"></span>
    917. 

  917.           </label>
    918. 

  918.         
    919. 

  919.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
    920. 

  920.           <label class="md-nav__title" for="__nav_5">
    921. 

  921.             <span class="md-nav__icon md-icon"></span>
    922. 

  922.             Configuration
    923. 

  923.           </label>
    924. 

  924.           <ul class="md-nav__list" data-md-scrollfix>
    925. 

  925.             
    926. 

  926.               
    927. 

  927.                 
    928. 

  928.   
    929. 

  929.   
    930. 

  930.   
    931. 

  931.   
    932. 

  932.     <li class="md-nav__item">
    933. 

  933.       <a href="../config/" class="md-nav__link">
    934. 

  934.         
    935. 

  935.   
    936. 

  936.   <span class="md-ellipsis">
    937. 

  937.     Config files
    938. 

  938.   </span>
    939. 

  939.   
    940. 

  940. 

  941.       </a>
    942. 

  942.     </li>
    943. 

  943.   
    944. 

  944. 

  945.               
    946. 

  946.             
    947. 

  947.               
    948. 

  948.                 
    949. 

  949.   
    950. 

  950.   
    951. 

  951.     
    952. 

  952.   
    953. 

  953.   
    954. 

  954.   
    955. 

  955.     <li class="md-nav__item md-nav__item--active">
    956. 

  956.       
    957. 

  957.       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
    958. 

  958.       
    959. 

  959.       
    960. 

  960.         
    961. 

  961.       
    962. 

  962.       
    963. 

  963.         <label class="md-nav__link md-nav__link--active" for="__toc">
    964. 

  964.           
    965. 

  965.   
    966. 

  966.   <span class="md-ellipsis">
    967. 

  967.     Command definitions
    968. 

  968.   </span>
    969. 

  969.   
    970. 

  970. 

  971.           <span class="md-nav__icon md-icon"></span>
    972. 

  972.         </label>
    973. 

  973.       
    974. 

  974.       <a href="./" class="md-nav__link md-nav__link--active">
    975. 

  975.         
    976. 

  976.   
    977. 

  977.   <span class="md-ellipsis">
    978. 

  978.     Command definitions
    979. 

  979.   </span>
    980. 

  980.   
    981. 

  981. 

  982.       </a>
    983. 

  983.       
    984. 

  984.         
    985. 

  985. 

  986. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
    987. 

  987.   
    988. 

  988.   
    989. 

  989.   
    990. 

  990.     
    991. 

  991.   
    992. 

  992.   
    993. 

  993.     <label class="md-nav__title" for="__toc">
    994. 

  994.       <span class="md-nav__icon md-icon"></span>
    995. 

  995.       Table of contents
    996. 

  996.     </label>
    997. 

  997.     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
    998. 

  998.       
    999. 

  999.         <li class="md-nav__item">
    1000. 

  1000.   <a href="#scaffolding" class="md-nav__link">
    1001. 

  1001.     <span class="md-ellipsis">
    1002. 

  1002.       Scaffolding
    1003. 

  1003.     </span>
    1004. 

  1004.   </a>
    1005. 

  1005.   
    1006. 

  1006. </li>
    1007. 

  1007.       
    1008. 

  1008.         <li class="md-nav__item">
    1009. 

  1009.   <a href="#displaying-the-command-to-swe-agent" class="md-nav__link">
    1010. 

  1010.     <span class="md-ellipsis">
    1011. 

  1011.       Displaying the Command to SWE-agent
    1012. 

  1012.     </span>
    1013. 

  1013.   </a>
    1014. 

  1014.   
    1015. 

  1015. </li>
    1016. 

  1016.       
    1017. 

  1017.     </ul>
    1018. 

  1018.   
    1019. 

  1019. </nav>
    1020. 

  1020.       
    1021. 

  1021.     </li>
    1022. 

  1022.   
    1023. 

  1023. 

  1024.               
    1025. 

  1025.             
    1026. 

  1026.               
    1027. 

  1027.                 
    1028. 

  1028.   
    1029. 

  1029.   
    1030. 

  1030.   
    1031. 

  1031.   
    1032. 

  1032.     <li class="md-nav__item">
    1033. 

  1033.       <a href="../demonstrations/" class="md-nav__link">
    1034. 

  1034.         
    1035. 

  1035.   
    1036. 

  1036.   <span class="md-ellipsis">
    1037. 

  1037.     Demonstrations
    1038. 

  1038.   </span>
    1039. 

  1039.   
    1040. 

  1040. 

  1041.       </a>
    1042. 

  1042.     </li>
    1043. 

  1043.   
    1044. 

  1044. 

  1045.               
    1046. 

  1046.             
    1047. 

  1047.               
    1048. 

  1048.                 
    1049. 

  1049.   
    1050. 

  1050.   
    1051. 

  1051.   
    1052. 

  1052.   
    1053. 

  1053.     <li class="md-nav__item">
    1054. 

  1054.       <a href="../env/" class="md-nav__link">
    1055. 

  1055.         
    1056. 

  1056.   
    1057. 

  1057.   <span class="md-ellipsis">
    1058. 

  1058.     Environment variables
    1059. 

  1059.   </span>
    1060. 

  1060.   
    1061. 

  1061. 

  1062.       </a>
    1063. 

  1063.     </li>
    1064. 

  1064.   
    1065. 

  1065. 

  1066.               
    1067. 

  1067.             
    1068. 

  1068.               
    1069. 

  1069.                 
    1070. 

  1070.   
    1071. 

  1071.   
    1072. 

  1072.   
    1073. 

  1073.   
    1074. 

  1074.     <li class="md-nav__item">
    1075. 

  1075.       <a href="../docker/" class="md-nav__link">
    1076. 

  1076.         
    1077. 

  1077.   
    1078. 

  1078.   <span class="md-ellipsis">
    1079. 

  1079.     Docker images
    1080. 

  1080.   </span>
    1081. 

  1081.   
    1082. 

  1082. 

  1083.       </a>
    1084. 

  1084.     </li>
    1085. 

  1085.   
    1086. 

  1086. 

  1087.               
    1088. 

  1088.             
    1089. 

  1089.               
    1090. 

  1090.                 
    1091. 

  1091.   
    1092. 

  1092.   
    1093. 

  1093.   
    1094. 

  1094.   
    1095. 

  1095.     <li class="md-nav__item">
    1096. 

  1096.       <a href="../summarizers/" class="md-nav__link">
    1097. 

  1097.         
    1098. 

  1098.   
    1099. 

  1099.   <span class="md-ellipsis">
    1100. 

  1100.     Summarizers
    1101. 

  1101.   </span>
    1102. 

  1102.   
    1103. 

  1103. 

  1104.       </a>
    1105. 

  1105.     </li>
    1106. 

  1106.   
    1107. 

  1107. 

  1108.               
    1109. 

  1109.             
    1110. 

  1110.           </ul>
    1111. 

  1111.         </nav>
    1112. 

  1112.       
    1113. 

  1113.     </li>
    1114. 

  1114.   
    1115. 

  1115. 

  1116.     
    1117. 

  1117.       
    1118. 

  1118.       
    1119. 

  1119.   
    1120. 

  1120.   
    1121. 

  1121.   
    1122. 

  1122.   
    1123. 

  1123.     
    1124. 

  1124.     
    1125. 

  1125.       
    1126. 

  1126.         
    1127. 

  1127.       
    1128. 

  1128.         
    1129. 

  1129.       
    1130. 

  1130.     
    1131. 

  1131.     
    1132. 

  1132.     
    1133. 

  1133.     <li class="md-nav__item md-nav__item--nested">
    1134. 

  1134.       
    1135. 

  1135.         
    1136. 

  1136.         
    1137. 

  1137.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
    1138. 

  1138.         
    1139. 

  1139.           
    1140. 

  1140.           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
    1141. 

  1141.             
    1142. 

  1142.   
    1143. 

  1143.   <span class="md-ellipsis">
    1144. 

  1144.     Development
    1145. 

  1145.   </span>
    1146. 

  1146.   
    1147. 

  1147. 

  1148.             <span class="md-nav__icon md-icon"></span>
    1149. 

  1149.           </label>
    1150. 

  1150.         
    1151. 

  1151.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
    1152. 

  1152.           <label class="md-nav__title" for="__nav_6">
    1153. 

  1153.             <span class="md-nav__icon md-icon"></span>
    1154. 

  1154.             Development
    1155. 

  1155.           </label>
    1156. 

  1156.           <ul class="md-nav__list" data-md-scrollfix>
    1157. 

  1157.             
    1158. 

  1158.               
    1159. 

  1159.                 
    1160. 

  1160.   
    1161. 

  1161.   
    1162. 

  1162.   
    1163. 

  1163.   
    1164. 

  1164.     <li class="md-nav__item">
    1165. 

  1165.       <a href="../../dev/contribute/" class="md-nav__link">
    1166. 

  1166.         
    1167. 

  1167.   
    1168. 

  1168.   <span class="md-ellipsis">
    1169. 

  1169.     Contribution guide
    1170. 

  1170.   </span>
    1171. 

  1171.   
    1172. 

  1172. 

  1173.       </a>
    1174. 

  1174.     </li>
    1175. 

  1175.   
    1176. 

  1176. 

  1177.               
    1178. 

  1178.             
    1179. 

  1179.               
    1180. 

  1180.                 
    1181. 

  1181.   
    1182. 

  1182.   
    1183. 

  1183.   
    1184. 

  1184.   
    1185. 

  1185.     <li class="md-nav__item">
    1186. 

  1186.       <a href="../../dev/formatting_conflicts/" class="md-nav__link">
    1187. 

  1187.         
    1188. 

  1188.   
    1189. 

  1189.   <span class="md-ellipsis">
    1190. 

  1190.     Formatting conflicts
    1191. 

  1191.   </span>
    1192. 

  1192.   
    1193. 

  1193. 

  1194.       </a>
    1195. 

  1195.     </li>
    1196. 

  1196.   
    1197. 

  1197. 

  1198.               
    1199. 

  1199.             
    1200. 

  1200.           </ul>
    1201. 

  1201.         </nav>
    1202. 

  1202.       
    1203. 

  1203.     </li>
    1204. 

  1204.   
    1205. 

  1205. 

  1206.     
    1207. 

  1207.       
    1208. 

  1208.       
    1209. 

  1209.   
    1210. 

  1210.   
    1211. 

  1211.   
    1212. 

  1212.   
    1213. 

  1213.     
    1214. 

  1214.     
    1215. 

  1215.       
    1216. 

  1216.         
    1217. 

  1217.           
    1218. 

  1218.         
    1219. 

  1219.       
    1220. 

  1220.         
    1221. 

  1221.       
    1222. 

  1222.         
    1223. 

  1223.       
    1224. 

  1224.         
    1225. 

  1225.       
    1226. 

  1226.         
    1227. 

  1227.       
    1228. 

  1228.     
    1229. 

  1229.     
    1230. 

  1230.     
    1231. 

  1231.     <li class="md-nav__item md-nav__item--nested">
    1232. 

  1232.       
    1233. 

  1233.         
    1234. 

  1234.         
    1235. 

  1235.         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
    1236. 

  1236.         
    1237. 

  1237.           
    1238. 

  1238.           
    1239. 

  1239.           <div class="md-nav__link md-nav__container">
    1240. 

  1240.             <a href="../../reference/" class="md-nav__link ">
    1241. 

  1241.               
    1242. 

  1242.   
    1243. 

  1243.   <span class="md-ellipsis">
    1244. 

  1244.     Reference
    1245. 

  1245.   </span>
    1246. 

  1246.   
    1247. 

  1247. 

  1248.             </a>
    1249. 

  1249.             
    1250. 

  1250.               
    1251. 

  1251.               <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
    1252. 

  1252.                 <span class="md-nav__icon md-icon"></span>
    1253. 

  1253.               </label>
    1254. 

  1254.             
    1255. 

  1255.           </div>
    1256. 

  1256.         
    1257. 

  1257.         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
    1258. 

  1258.           <label class="md-nav__title" for="__nav_7">
    1259. 

  1259.             <span class="md-nav__icon md-icon"></span>
    1260. 

  1260.             Reference
    1261. 

  1261.           </label>
    1262. 

  1262.           <ul class="md-nav__list" data-md-scrollfix>
    1263. 

  1263.             
    1264. 

  1264.               
    1265. 

  1265.             
    1266. 

  1266.               
    1267. 

  1267.                 
    1268. 

  1268.   
    1269. 

  1269.   
    1270. 

  1270.   
    1271. 

  1271.   
    1272. 

  1272.     <li class="md-nav__item">
    1273. 

  1273.       <a href="../../reference/agent/" class="md-nav__link">
    1274. 

  1274.         
    1275. 

  1275.   
    1276. 

  1276.   <span class="md-ellipsis">
    1277. 

  1277.     Agent
    1278. 

  1278.   </span>
    1279. 

  1279.   
    1280. 

  1280. 

  1281.       </a>
    1282. 

  1282.     </li>
    1283. 

  1283.   
    1284. 

  1284. 

  1285.               
    1286. 

  1286.             
    1287. 

  1287.               
    1288. 

  1288.                 
    1289. 

  1289.   
    1290. 

  1290.   
    1291. 

  1291.   
    1292. 

  1292.   
    1293. 

  1293.     <li class="md-nav__item">
    1294. 

  1294.       <a href="../../reference/models/" class="md-nav__link">
    1295. 

  1295.         
    1296. 

  1296.   
    1297. 

  1297.   <span class="md-ellipsis">
    1298. 

  1298.     Models
    1299. 

  1299.   </span>
    1300. 

  1300.   
    1301. 

  1301. 

  1302.       </a>
    1303. 

  1303.     </li>
    1304. 

  1304.   
    1305. 

  1305. 

  1306.               
    1307. 

  1307.             
    1308. 

  1308.               
    1309. 

  1309.                 
    1310. 

  1310.   
    1311. 

  1311.   
    1312. 

  1312.   
    1313. 

  1313.   
    1314. 

  1314.     <li class="md-nav__item">
    1315. 

  1315.       <a href="../../reference/env/" class="md-nav__link">
    1316. 

  1316.         
    1317. 

  1317.   
    1318. 

  1318.   <span class="md-ellipsis">
    1319. 

  1319.     Environment
    1320. 

  1320.   </span>
    1321. 

  1321.   
    1322. 

  1322. 

  1323.       </a>
    1324. 

  1324.     </li>
    1325. 

  1325.   
    1326. 

  1326. 

  1327.               
    1328. 

  1328.             
    1329. 

  1329.               
    1330. 

  1330.                 
    1331. 

  1331.   
    1332. 

  1332.   
    1333. 

  1333.   
    1334. 

  1334.   
    1335. 

  1335.     <li class="md-nav__item">
    1336. 

  1336.       <a href="../../reference/env_utils/" class="md-nav__link">
    1337. 

  1337.         
    1338. 

  1338.   
    1339. 

  1339.   <span class="md-ellipsis">
    1340. 

  1340.     Environment utils
    1341. 

  1341.   </span>
    1342. 

  1342.   
    1343. 

  1343. 

  1344.       </a>
    1345. 

  1345.     </li>
    1346. 

  1346.   
    1347. 

  1347. 

  1348.               
    1349. 

  1349.             
    1350. 

  1350.           </ul>
    1351. 

  1351.         </nav>
    1352. 

  1352.       
    1353. 

  1353.     </li>
    1354. 

  1354.   
    1355. 

  1355. 

  1356.     
    1357. 

  1357.       
    1358. 

  1358.       
    1359. 

  1359.   
    1360. 

  1360.   
    1361. 

  1361.   
    1362. 

  1362.   
    1363. 

  1363.     <li class="md-nav__item">
    1364. 

  1364.       <a href="../../faq/" class="md-nav__link">
    1365. 

  1365.         
    1366. 

  1366.   
    1367. 

  1367.   <span class="md-ellipsis">
    1368. 

  1368.     FAQ
    1369. 

  1369.   </span>
    1370. 

  1370.   
    1371. 

  1371. 

  1372.       </a>
    1373. 

  1373.     </li>
    1374. 

  1374.   
    1375. 

  1375. 

  1376.     
    1377. 

  1377.   </ul>
    1378. 

  1378. </nav>
    1379. 

  1379.                   </div>
    1380. 

  1380.                 </div>
    1381. 

  1381.               </div>
    1382. 

  1382.             
    1383. 

  1383.             
    1384. 

  1384.               
    1385. 

  1385.               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
    1386. 

  1386.                 <div class="md-sidebar__scrollwrap">
    1387. 

  1387.                   <div class="md-sidebar__inner">
    1388. 

  1388.                     
    1389. 

  1389. 

  1390. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
    1391. 

  1391.   
    1392. 

  1392.   
    1393. 

  1393.   
    1394. 

  1394.     
    1395. 

  1395.   
    1396. 

  1396.   
    1397. 

  1397.     <label class="md-nav__title" for="__toc">
    1398. 

  1398.       <span class="md-nav__icon md-icon"></span>
    1399. 

  1399.       Table of contents
    1400. 

  1400.     </label>
    1401. 

  1401.     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
    1402. 

  1402.       
    1403. 

  1403.         <li class="md-nav__item">
    1404. 

  1404.   <a href="#scaffolding" class="md-nav__link">
    1405. 

  1405.     <span class="md-ellipsis">
    1406. 

  1406.       Scaffolding
    1407. 

  1407.     </span>
    1408. 

  1408.   </a>
    1409. 

  1409.   
    1410. 

  1410. </li>
    1411. 

  1411.       
    1412. 

  1412.         <li class="md-nav__item">
    1413. 

  1413.   <a href="#displaying-the-command-to-swe-agent" class="md-nav__link">
    1414. 

  1414.     <span class="md-ellipsis">
    1415. 

  1415.       Displaying the Command to SWE-agent
    1416. 

  1416.     </span>
    1417. 

  1417.   </a>
    1418. 

  1418.   
    1419. 

  1419. </li>
    1420. 

  1420.       
    1421. 

  1421.     </ul>
    1422. 

  1422.   
    1423. 

  1423. </nav>
    1424. 

  1424.                   </div>
    1425. 

  1425.                 </div>
    1426. 

  1426.               </div>
    1427. 

  1427.             
    1428. 

  1428.           
    1429. 

  1429.           
    1430. 

  1430.             <div class="md-content" data-md-component="content">
    1431. 

  1431.               <article class="md-content__inner md-typeset">
    1432. 

  1432.                 
    1433. 

  1433.                   
    1434. 

  1434. 

  1435.   
    1436. 

  1436.     <a href="https://github.com/princeton-nlp/SWE-agent/edit/main/docs/config/commands.md" title="Edit this page" class="md-content__button md-icon">
    1437. 

  1437.       
    1438. 

  1438.       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
    1439. 

  1439.     </a>
    1440. 

  1440.   
    1441. 

  1441.   
    1442. 

  1442. 

  1443. 

  1444. <h1 id="command-configuration">Command Configuration</h1>
    1445. 

  1445. <p>In this document, we describe how to implement your own commands for the SWE-agent ACI.
    1446. 

  1446. To see examples of command implementations, open the <code>.sh</code> and <code>.py</code> files in the
    1447. 

  1447. <a href="https://github.com/princeton-nlp/SWE-agent/tree/main/config/commands"><code>config/commands</code></a> folder.</p>
    1448. 

  1448. <h2 id="scaffolding">Scaffolding</h2>
    1449. 

  1449. <p>Every command subscribes to the following skeleton code.</p>
    1450. 

  1450. <div class="highlight"><pre><span></span><code><span class="c1"># @yaml</span>
    1451. 

  1451. <span class="c1"># signature: [command] [argument(s)]</span>
    1452. 

  1452. <span class="c1"># docstring: [Brief description of what your command does.]</span>
    1453. 

  1453. <span class="c1"># arguments:</span>
    1454. 

  1454. <span class="c1">#   [argument 1 name]:</span>
    1455. 

  1455. <span class="c1">#       type: [type (i.e. integer, string)]</span>
    1456. 

  1456. <span class="c1">#       description: [Brief description of this argument]</span>
    1457. 

  1457. <span class="c1">#       required: [true|false]</span>
    1458. 

  1458. <span class="c1">#   [argument 2 name]:</span>
    1459. 

  1459. <span class="c1">#       ...</span>
    1460. 

  1460. <span class="o">[</span>command<span class="o">]()</span><span class="w"> </span><span class="o">{</span>
    1461. 

  1461. <span class="w">    </span><span class="c1"># Implementation here</span>
    1462. 

  1462. <span class="o">}</span>
    1463. 

  1463. </code></pre></div>
    1464. 

  1464. <ul>
    1465. 

  1465. <li>If a command takes in arguments, reference them via positional parameters notation (i.e. <code>$1</code>).</li>
    1466. 

  1466. <li>If there are no arguments, omit the <code>arguments</code> section.</li>
    1467. 

  1467. <li>The implementation for your command is unconstrained. There are no limitations on the form of the underlying command code.</li>
    1468. 

  1468. <li>The minimal documentation requirements are <code>signature</code> and <code>docstring</code>.</li>
    1469. 

  1469. <li>If you'd like multiple commands to make modifications to a similar body of functions, we recommend using global variables.<ul>
    1470. 

  1470. <li>For instance, in <code>config/commands/default.sh</code>, you'll see we define the <code>CURRENT_LINE</code> variable for the file viewer. This variable is modified across multiple commands, including <code>open</code>, <code>goto</code>, <code>scroll_up</code>, <code>scroll_down</code>, and <code>edit</code>.</li>
    1471. 

  1471. <li>You can also leverage third party libraries (check out how we do linting enabled <code>edit</code> in <code>config/commands/edit_linting.sh</code>).</li>
    1472. 

  1472. </ul>
    1473. 

  1473. </li>
    1474. 

  1474. <li>To show effects of the command, print to standard output (i.e. <code>echo</code>). SWE-agent is implemented such that it does not look for a return value from these commands.</li>
    1475. 

  1475. <li>The following environment variables are used to persist information between commands:<ul>
    1476. 

  1476. <li><code>CURRENT_FILE</code>: File that is currently open</li>
    1477. 

  1477. <li><code>CURRENT_LINE</code>: First line of the window that is currently being shown/edited</li>
    1478. 

  1478. <li><code>WINDOW</code> (start line to end line): Part of the file that is currently shown/edited</li>
    1479. 

  1479. <li><code>START_CURSOR</code>, <code>END_CURSOR</code>: Only used for the <code>cursors_*</code> commands.</li>
    1480. 

  1480. </ul>
    1481. 

  1481. </li>
    1482. 

  1482. <li>You can also use environment variables to set parameters for your commands. For this, edit the <code>env_vars</code> section of the <a href="../config/">config</a>.
    1483. 

  1483.   For example, the <code>WINDOW</code> setting controls the number of context lines shown when editing a file.</li>
    1484. 

  1484. </ul>
    1485. 

  1485. <h2 id="displaying-the-command-to-swe-agent">Displaying the Command to SWE-agent</h2>
    1486. 

  1486. <p>After you define a command, there are a small set of additional steps to making it available for the agent to use.</p>
    1487. 

  1487. <p>First, within your config file...</p>
    1488. 

  1488. <ul>
    1489. 

  1489. <li>Add <code>config/commands/&lt;file name&gt;.sh</code> file to the <code>command_files</code> field.</li>
    1490. 

  1490. <li>Set the <code>parse_command</code> field to <code>ParseCommandBash</code> or <code>ParseCommandDetailed</code>. This key points to the functionality that generates how command documentation is shown to the agent.</li>
    1491. 

  1491. <li>Decide which template(s) you want to show the <code>{command_docs}</code> in.<ul>
    1492. 

  1492. <li>We strongly recommend including <code>{command_docs}</code> in the <code>system_template</code>, which is the first message shown to the agent for every task instance episode.</li>
    1493. 

  1493. <li>You might also consider adding <code>{command_docs}</code> to the <code>format_error_template</code>, which is shown if the response provided by a model is malformed.</li>
    1494. 

  1494. </ul>
    1495. 

  1495. </li>
    1496. 

  1496. <li>(Optional) Including a demonstration that uses a command is helpful to showcase proper use + increases the frequency with which the agent uses the command. If you'd like to add a demonstration...<ul>
    1497. 

  1497. <li>Create a demonstration manually (i.e. <code>python run.py --model human_thought ...</code>) or automatically (i.e. <code>python run_replay --traj_path ...</code>)</li>
    1498. 

  1498. <li>Add/Update the demonstration to the <code>demonstrations</code> argument.</li>
    1499. 

  1499. <li>Update <code>demonstration_template</code> to control how the demonstration is displayed to the agent.</li>
    1500. 

  1500. </ul>
    1501. 

  1501. </li>
    1502. 

  1502. </ul>
    1503. 

  1503. <div class="admonition tip">
    1504. 

  1504. <p class="admonition-title">Config files</p>
    1505. 

  1505. <p>If you're not familiar with how SWE-agent configuration files work, we recommend checking out the <a href="../config/"><code>config</code> documentation</a>.</p>
    1506. 

  1506. </div>
    1507. 

  1507. <p>Next, run your configuration and see how your agent uses the commands!
    1508. 

  1508. <div class="highlight"><pre><span></span><code>python<span class="w"> </span>run.py<span class="w"> </span>--config_file<span class="w"> </span>config/<span class="o">[</span>your<span class="w"> </span>config<span class="o">]</span>.yaml<span class="w"> </span>...
    1509. 

  1509. </code></pre></div></p>
    1510. 

  1510. <!-- BEGIN INCLUDE ../_footer.md -->
    1511. 

  1511. <div class="grid cards">
    1512. 

  1512. <ul>
    1513. 

  1513. <li>
    1514. 

  1514. <p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a6 6 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6 6 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20z"/></svg></span> <strong>Something broken?</strong>
    1515. 

  1515.     <a href="https://github.com/princeton-nlp/SWE-agent/issues/new?template=bug_report.yml"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg></span> Report bug</a></p>
    1516. 

  1516. </li>
    1517. 

  1517. <li>
    1518. 

  1518. <p><span class="twemoji lg middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 19h3v3h-3zm2-17c5.35.22 7.68 5.62 4.5 9.67-.83 1-2.17 1.66-2.83 2.5C13 15 13 16 13 17h-3c0-1.67 0-3.08.67-4.08.66-1 2-1.59 2.83-2.25C15.92 8.43 15.32 5.26 12 5a3 3 0 0 0-3 3H6a6 6 0 0 1 6-6"/></svg></span> <strong>Something unclear?</strong>
    1519. 

  1519.     <a href="https://github.com/princeton-nlp/SWE-agent/issues/new?template=question.yml"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg></span> Ask question</a></p>
    1520. 

  1520. </li>
    1521. 

  1521. </ul>
    1522. 

  1522. </div>
    1523. 

  1523. <!-- END INCLUDE -->
    1524. 

  1524. 

  1525. 

  1526. 

  1527. 

  1528. 

  1529. 

  1530. 

  1531. 

  1532. 

  1533. 

  1534. 

  1535. 

  1536.                 
    1537. 

  1537.               </article>
    1538. 

  1538.             </div>
    1539. 

  1539.           
    1540. 

  1540.           
    1541. 

  1541. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
    1542. 

  1542.         </div>
    1543. 

  1543.         
    1544. 

  1544.       </main>
    1545. 

  1545.       
    1546. 

  1546.         <footer class="md-footer">
    1547. 

  1547.   
    1548. 

  1548.     
    1549. 

  1549.       
    1550. 

  1550.       <nav class="md-footer__inner md-grid" aria-label="Footer" >
    1551. 

  1551.         
    1552. 

  1552.           
    1553. 

  1553.           <a href="../config/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Config files">
    1554. 

  1554.             <div class="md-footer__button md-icon">
    1555. 

  1555.               
    1556. 

  1556.               <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
    1557. 

  1557.             </div>
    1558. 

  1558.             <div class="md-footer__title">
    1559. 

  1559.               <span class="md-footer__direction">
    1560. 

  1560.                 Previous
    1561. 

  1561.               </span>
    1562. 

  1562.               <div class="md-ellipsis">
    1563. 

  1563.                 Config files
    1564. 

  1564.               </div>
    1565. 

  1565.             </div>
    1566. 

  1566.           </a>
    1567. 

  1567.         
    1568. 

  1568.         
    1569. 

  1569.           
    1570. 

  1570.           <a href="../demonstrations/" class="md-footer__link md-footer__link--next" aria-label="Next: Demonstrations">
    1571. 

  1571.             <div class="md-footer__title">
    1572. 

  1572.               <span class="md-footer__direction">
    1573. 

  1573.                 Next
    1574. 

  1574.               </span>
    1575. 

  1575.               <div class="md-ellipsis">
    1576. 

  1576.                 Demonstrations
    1577. 

  1577.               </div>
    1578. 

  1578.             </div>
    1579. 

  1579.             <div class="md-footer__button md-icon">
    1580. 

  1580.               
    1581. 

  1581.               <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
    1582. 

  1582.             </div>
    1583. 

  1583.           </a>
    1584. 

  1584.         
    1585. 

  1585.       </nav>
    1586. 

  1586.     
    1587. 

  1587.   
    1588. 

  1588.   <div class="md-footer-meta md-typeset">
    1589. 

  1589.     <div class="md-footer-meta__inner md-grid">
    1590. 

  1590.       <div class="md-copyright">
    1591. 

  1591.   
    1592. 

  1592.   
    1593. 

  1593.     Made with
    1594. 

  1594.     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
    1595. 

  1595.       Material for MkDocs
    1596. 

  1596.     </a>
    1597. 

  1597.   
    1598. 

  1598. </div>
    1599. 

  1599.       
    1600. 

  1600.     </div>
    1601. 

  1601.   </div>
    1602. 

  1602. </footer>
    1603. 

  1603.       
    1604. 

  1604.     </div>
    1605. 

  1605.     <div class="md-dialog" data-md-component="dialog">
    1606. 

  1606.       <div class="md-dialog__inner md-typeset"></div>
    1607. 

  1607.     </div>
    1608. 

  1608.     
    1609. 

  1609.     
    1610. 

  1610.     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes", "content.action.edit", "navigation.footer", "content.code.copy", "content.footnote.tooltips", "header.autohide", "announce.dismiss"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    1611. 

  1611.     
    1612. 

  1612.     
    1613. 

  1613.       <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
    1614. 

  1614.       
    1615. 

  1615.     
    1616. 

  1616.   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
    1617. 

  1617. document$.subscribe(() => { lightbox.reload() });
    1618. 

  1618. </script></body>
    1619. 

  1619. </html>
    1620.