---
title: "Getting Started"
---
<style>
  .md-typeset h1,
  .md-content__button {
    display: none;
  }
</style>

<div style="text-align: center;">
    <img class="light-mode-only" src="assets/readme_assets/swe-agent-banner-light.svg" alt="SWE-agent banner" style="height: 10em;">
    <img class="dark-mode-only" src="assets/readme_assets/swe-agent-banner-dark.svg" alt="SWE-agent banner" style="height: 10em;">
</div>

!!! warning "We recommend mini-swe-agent instead of SWE-agent"
    Most of our current development effort is on [mini-swe-agent](https://github.com/SWE-agent/mini-swe-agent/),
    which has superseded SWE-agent. It matches the performance of SWE-agent, while being
    much simpler.
    See the [FAQ](https://mini-swe-agent.com/latest/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](https://swe-agent.com/latest/usage/hello_world),
[find cybersecurity vulnerabilities](https://enigma-agent.com/), or
[perform any custom task](https://swe-agent.com/latest/usage/coding_challenges).

* ✅ **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

* July 24: [Mini-SWE-Agent](https://github.com/SWE-agent/mini-SWE-agent) achieves 65% on SWE-bench verified in 100 lines of python!
* July 9: [Multimodal support for SWE-agent](usage/multimodal.md) - Process images from GitHub issues with vision-capable AI models
* May 2: [SWE-agent-LM-32b](https://swesmith.com) achieves open-weights SOTA on SWE-bench
* Feb 28: [SWE-agent 1.0 + Claude 3.7 is SoTA on SWE-Bench full](https://x.com/KLieret/status/1895487966409298067)
* Feb 25: [SWE-agent 1.0 + Claude 3.7 is SoTA on SWE-bench verified](https://x.com/KLieret/status/1894408819670733158)
* Feb 13: [Releasing SWE-agent 1.0: SoTA on SWE-bench light & tons of new features](https://x.com/KLieret/status/1890048205448220849)
* Dec 7: [An interview with the SWE-agent & SWE-bench team](https://www.youtube.com/watch?v=fcr8WzeEXyk)

## ✍️ Doc updates

* June 26: [Adding custom tools](usage/adding_custom_tools.md)
* Apr 8: [Running SWE-agent competitively](usage/competitive_runs.md)
* Mar 7: [Updated SWE-agent architecture diagram of 1.0](background/architecture.md)