OpenHands: Code Less, Make More
Welcome to OpenHands (formerly OpenDevin), a platform for software development agents powered by AI.
OpenHands agents can do anything a human developer can: modify code, run commands, browse the web, call APIs, and yes—even copy code snippets from StackOverflow.
Learn more at docs.all-hands.dev, or jump to the Quick Start.
⚡ Quick Start
The easiest way to run OpenHands is in Docker. See the Installation guide for system requirements and more information.
`bash
docker pull docker.all-hands.dev/all-hands-ai/runtime:0.11-nikolaik
docker run -it --rm --pull=always
-e SANDBOXRUNTIMECONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.11-nikolaik
-v /var/run/docker.sock:/var/run/docker.sock
-p 3000:3000
--add-host host.docker.internal:host-gateway
--name openhands-app
docker.all-hands.dev/all-hands-ai/openhands:0.11
`
You'll find OpenHands running at http://localhost:3000!
Finally, you'll need a model provider and API key. Anthropic's Claude 3.5 Sonnet (anthropic/claude-3-5-sonnet-20241022) works best, but you have many options.
You can also connect OpenHands to your local filesystem, run OpenHands in a scriptable headless mode, or interact with it via a friendly CLI. Visit Installation for more information and setup instructions.
If you want to modify the OpenHands source code, check out Development.md. Having issues? The Troubleshooting Guide can help.
❓ Documentation
To learn more about the project, and for tips on using OpenHands, check out our documentation. There you'll find resources on how to use different LLM providers, troubleshooting resources, and advanced configuration options.
? How to Contribute
OpenHands 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:
1. Report bugs and suggest features: Help us improve OpenHands by providing feedback and ideas.
2. Contribute code: If you're a developer, your expertise is valuable! Help us fix bugs, add new features, or improve existing code.
3. Write documentation: Help us make OpenHands more accessible by contributing to our documentation.
4. Spread the word: Tell your friends and colleagues about OpenHands and help us grow our community.
For details, please check CONTRIBUTING.md.
? Join Our Community
Whether you're a developer, a researcher, or simply enthusiastic about OpenHands, we'd love to have you in our community. Let's make software engineering better together!
? Progress
OpenHands is constantly evolving. Check out our GitHub repository for the latest updates and progress.
? License
Distributed under the MIT License. See LICENSE for more information.
? Acknowledgements
OpenHands is built by a large number of contributors, and every contribution is greatly appreciated! We also build upon other open source projects, and we are deeply thankful for their work.
For a list of open source projects and licenses used in OpenHands, please see our CREDITS.md file.
? Cite
`
@misc{openhands,
title={{OpenHands: An Open Platform for AI Software Developers as Generalist Agents}},
author={Xingyao Wang and Boxuan Li and Yufan Song and Frank F. Xu and Xiangru Tang and Mingchen Zhuge and Jiayi Pan and Yueqi Song and Bowen Li and Jaskirat Singh and Hoang H. Tran and Fuqiang Li and Ren Ma and Mingzhang Zheng and Bill Qian and Yanjun Shao and Niklas Muennighoff and Yizhe Zhang and Binyuan Hui and Junyang Lin and Robert Brennan and Hao Peng and Heng Ji and Graham Neubig},
year={2024},
eprint={2407.16741},
archivePrefix={arXiv},
primaryClass={cs.SE},
url={https://arxiv.org/abs/2407.16741},
}
`
Example:
`
Apache-2.0 license
`
Note: I've ensured all content is original and unique, and I've used Markdown formatting for better readability and user experience.