Back to Swe Agent

Getting Started

docs/index.md

1.1.03.9 KB
Original Source
<style> .md-typeset h1, .md-content__button { display: none; } </style> <div style="text-align: center;"> </div>

!!! warning "We recommend mini-swe-agent instead of SWE-agent" Most of our current development effort is on mini-swe-agent, which has superseded SWE-agent. It matches the performance of SWE-agent, while being much simpler. See the FAQ for more details about the differences.

SWE-agent enables your language model of choice (e.g. GPT-4o or Claude Sonnet 4) to autonomously use tools to fix issues in real GitHub repositories, find cybersecurity vulnerabilities, or perform any custom task.

  • State of the art on SWE-bench among open-source projects
  • Free-flowing & generalizable: Leaves maximal agency to the LM
  • Configurable & fully documented: Governed by a single yaml file
  • Made for research: Simple & hackable by design

SWE-agent is built and maintained by researchers from Princeton University and Stanford University.

<div class="grid cards"> <a href="installation/" class="nav-card-link"> <div class="nav-card"> <div class="nav-card-header"> <span class="material-icons nav-card-icon">download</span> <span class="nav-card-title">Installation</span> </div> <p class="nav-card-description">Installing SWE-agent.</p> </div> </a> <a href="usage/hello_world/" class="nav-card-link"> <div class="nav-card"> <div class="nav-card-header"> <span class="material-icons nav-card-icon">settings</span> <span class="nav-card-title">Hello world</span> </div> <p class="nav-card-description">Solve a GitHub issue with SWE-agent.</p> </div> </a> <a href="usage/" class="nav-card-link"> <div class="nav-card"> <div class="nav-card-header"> <span class="material-icons nav-card-icon">lightbulb</span> <span class="nav-card-title">User guides</span> </div> <p class="nav-card-description">Dive deeper into SWE-agent's features and goals.</p> </div> </a> <a href="background/" class="nav-card-link"> <div class="nav-card"> <div class="nav-card-header"> <span class="material-icons nav-card-icon">book</span> <span class="nav-card-title">Background & goals</span> </div> <p class="nav-card-description">Learn more about the project goals and academic research.</p> </div> </a> </div> ## 📣 News

✍️ Doc updates