chore: Cleanup readme (#532)

* chore: Cleanup readme

* cr

* cr

* cr

* cr

* cr
This commit is contained in:
Brace Sproul 2025-07-25 09:46:52 -07:00 • committed by GitHub
parent e4fbd828d7
commit f61ea79b13
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,25 +1,25 @@
> [!WARNING]
> Open SWE is under active development and is not yet ready for production use.
<div align="center"> <div align="center">
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="apps/docs/logo/dark.svg"> <source media="(prefers-color-scheme: dark)" srcset="apps/docs/logo/dark.svg">
<source media="(prefers-color-scheme: light)" srcset="apps/docs/logo/light.svg"> <source media="(prefers-color-scheme: light)" srcset="apps/docs/logo/light.svg">
<img src="apps/docs/logo/dark.svg" alt="Open SWE Logo"> <img src="apps/docs/logo/dark.svg" alt="Open SWE Logo" width="35%">
</picture> </picture>
</div> </div>
Open SWE is an open-source cloud based coding agent. It's built with [LangGraph](https://langchain-ai.github.io/langgraphjs/), and is designed to autonomously understand, plan, and execute code changes across entire repositories. <div align="center">
<h1>Open SWE - An cloud based, fully autonomous coding agent</h1>
</div>
Think of Open SWE as your own personal engineer who can handle complex tasks end to end, from planning to execution, to opening a pull request. Open SWE is an open-source cloud-based coding agent built with [LangGraph](https://langchain-ai.github.io/langgraphjs/). It autonomously understands codebases, plans solutions, and executes code changes across entire repositories—from initial planning to opening pull requests.
> [!WARNING]
> Open SWE is under active development and is not yet ready for production use.
> [!TIP] > [!TIP]
> Try out Open SWE yourself using our [public demo](https://swe.langchain.com)! > Try out Open SWE yourself using our [public demo](https://swe.langchain.com)!
> >
> **Note: you're required to set your own LLM API keys to use the demo.** > **Note: you're required to set your own LLM API keys to use the demo.**
![UI Screenshot](./static/ui-screenshot.png)
# Features # Features
- 📝 **Planning**: Open SWE has a dedicated planning step which allows it to deeply understand complex codebases and nuanced tasks. You're also given the ability to accept, edit, or reject the proposed plan before it's executed. - 📝 **Planning**: Open SWE has a dedicated planning step which allows it to deeply understand complex codebases and nuanced tasks. You're also given the ability to accept, edit, or reject the proposed plan before it's executed.
@ -27,6 +27,8 @@ Think of Open SWE as your own personal engineer who can handle complex tasks end
- 🏃 **Parallel Execution**: You can run as many Open SWE tasks as you want in parallel! Since it runs in a sandbox environment in the cloud, you're not limited by the number of tasks you can run at once. - 🏃 **Parallel Execution**: You can run as many Open SWE tasks as you want in parallel! Since it runs in a sandbox environment in the cloud, you're not limited by the number of tasks you can run at once.
- 🧑‍💻 **End to end task management**: Open SWE will automatically create GitHub issues for tasks, and create pull requests which will close the issue when implementation is complete. - 🧑‍💻 **End to end task management**: Open SWE will automatically create GitHub issues for tasks, and create pull requests which will close the issue when implementation is complete.
![UI Screenshot](./static/ui-screenshot.png)
## Usage ## Usage
Open SWE can be used in multiple ways: Open SWE can be used in multiple ways: