OpenHands

OpenDevin: Code Less, Make More

🗂️ Table of Contents

1. 🐚 About OpenDevin
   • 🚧 Project Status
2. 🚀 Get Started
   • 1. Build and Setup
   • 2. Run the Application
   • 3. Individual Server Startup
   • 4. Help
3. ⭐️ Research Strategy
4. 🤝 How to Contribute
5. 🤖 Join Our Community
6. 🛠️ Built With
7. 📜 License

🎯 Mission

Project Demo Video

Welcome to OpenDevin, an open-source project aiming to replicate Devin, an autonomous AI software engineer who is capable of executing complex engineering tasks and collaborating actively with users on software development projects. This project aspires to replicate, enhance, and innovate upon Devin through the power of the open-source community.

↑ Back to Top ↑

🤔 What is Devin?

Devin represents a cutting-edge autonomous agent designed to navigate the complexities of software engineering. It leverages a combination of tools such as a shell, code editor, and web browser, showcasing the untapped potential of LLMs in software development. Our goal is to explore and expand upon Devin's capabilities, identifying both its strengths and areas for improvement, to guide the progress of open code models.

↑ Back to Top ↑

🐚 Why OpenDevin?

The OpenDevin project is born out of a desire to replicate, enhance, and innovate beyond the original Devin model. By engaging the open-source community, we aim to tackle the challenges faced by Code LLMs in practical scenarios, producing works that significantly contribute to the community and pave the way for future advancements.

↑ Back to Top ↑

🚧 Project Status

OpenDevin is currently a work in progress, but you can already run the alpha version to see the end-to-end system in action. The project team is actively working on the following key milestones:

• UI: Developing a user-friendly interface, including a chat interface, a shell demonstrating commands, and a web browser.
• Architecture: Building a stable agent framework with a robust backend that can read, write, and run simple commands.
• Agent Capabilities: Enhancing the agent's abilities to generate bash scripts, run tests, and perform other software engineering tasks.
• Evaluation: Establishing a minimal evaluation pipeline that is consistent with Devin's evaluation criteria.

After completing the MVP, the team will focus on research in various areas, including foundation models, specialist capabilities, evaluation, and agent studies.

↑ Back to Top ↑

🚀 Get Started

Getting started with the OpenDevin project is incredibly easy. Follow these simple steps to set up and run OpenDevin on your system:

1. Requirements

• Linux, Mac OS, or WSL on Windows
• Docker
• Python >= 3.11
• NodeJS >= 14.8

2. Build and Setup

• Build the Project: Begin by building the project, which includes setting up the environment and installing dependencies. This step ensures that OpenDevin is ready to run smoothly on your system.

  make build
  

• Setup the Environment: With just one command, configure OpenDevin by providing essential details such as the LLM API key, LLM Model name, and workspace directory. This straightforward setup process ensures that OpenDevin is tailored to your specific requirements.

  make setup-config
  

3. Run the Application

• Run the Application: Once the setup is complete, launching OpenDevin is as simple as running a single command. This command starts both the backend and frontend servers seamlessly, allowing you to interact with OpenDevin without any hassle.

  make run
  

4. Individual Server Startup

• Start the Backend Server: If you prefer, you can start the backend server independently to focus on backend-related tasks or configurations.

  make start-backend
  

• Start the Frontend Server: Similarly, you can start the frontend server on its own to work on frontend-related components or interface enhancements.

  make start-frontend
  

5. Help

• Get Some Help: Need assistance or information on available targets and commands? The help command provides all the necessary guidance to ensure a smooth experience with OpenDevin.

  make help
  

↑ Back to Top ↑

⭐️ Research Strategy

Achieving full replication of production-grade applications with LLMs is a complex endeavor. Our strategy involves:

1. Core Technical Research: Focusing on foundational research to understand and improve the technical aspects of code generation and handling.
2. Specialist Abilities: Enhancing the effectiveness of core components through data curation, training methods, and more.
3. Task Planning: Developing capabilities for bug detection, codebase management, and optimization.
4. Evaluation: Establishing comprehensive evaluation metrics to better understand and improve our models.

↑ Back to Top ↑

🤝 How to Contribute

OpenDevin is a community-driven project, and we welcome contributions from everyone. Whether you're a developer, a researcher, or simply enthusiastic about advancing the field of software engineering with AI, there are many ways to get involved:

• Code Contributions: Help us develop the core functionalities, frontend interface, or sandboxing solutions.
• Research and Evaluation: Contribute to our understanding of LLMs in software engineering, participate in evaluating the models, or suggest improvements.
• Feedback and Testing: Use the OpenDevin toolset, report bugs, suggest features, or provide feedback on usability.

For details, please check this document.

↑ Back to Top ↑

🤖 Join Our Community

Join our Slack workspace by filling out the form. Stay updated on OpenDevin's progress, share ideas, and collaborate with fellow enthusiasts and experts. Let's simplify software engineering together!

🐚 Code less, make more with OpenDevin.

🛠️ Built With

OpenDevin is built using a combination of powerful frameworks and libraries, providing a robust foundation for its development. Here are the key technologies used in the project:

Please note that the selection of these technologies is in progress, and additional technologies may be added or existing ones may be removed as the project evolves. We strive to adopt the most suitable and efficient tools to enhance the capabilities of OpenDevin.

↑ Back to Top ↑

📜 License

Distributed under the MIT License. See LICENSE for more information.

↑ Back to Top ↑