OpenHands: Your Guide to AI-Powered Software Development Agents - Code Less, Make More!

Tired of endless coding? Discover OpenHands, the innovative platform leveraging AI agents to automate software development. This guide will walk you through everything from getting started with OpenHands Cloud to contributing to the open-source community. Let's dive in!

What is OpenHands and How Can It Help Me?

OpenHands (formerly OpenDevin) provides AI-powered agents that handle various software development tasks. Imagine an AI developer that can:

• Modify code automatically.
• Run commands and execute tasks.
• Browse the web for solutions and information.
• Utilize APIs seamlessly.
• Even learn from and adapt snippets from resources like StackOverflow!

This allows you to focus on high-level strategy and innovation, significantly boosting your productivity. Learn more about AI-powered software development at docs.all-hands.dev!

Effortless Start: OpenHands Cloud

Want the simplest way to experience OpenHands?

• One-click setup: Get going instantly without complex configurations.
• Free credits: New users receive $50 in free credits to explore the platform.
• Full functionality: Access all features of OpenHands through an intuitive interface.

Embrace the future of AI software development today!

Running OpenHands Locally: Complete Guide

Prefer running OpenHands on your own machine? Here's how:

1. Docker Installation: Ensure you have Docker installed on your system.
2. Run the Command: Use the provided Docker command to pull and run the OpenHands image:

docker pull docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik
docker run -it --rm --pull=always \
 -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.34-nikolaik \
 -e LOG_ALL_EVENTS=true \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v ~/.openhands-state:/.openhands-state \
 -p 3000:3000 \
 --add-host host.docker.internal:host-gateway \
 --name openhands-app \
 docker.all-hands.dev/all-hands-ai/openhands:0.34

3. Access: Open OpenHands in your browser at http://localhost:3000.

For detailed instructions and system requirements, consult the comprehensive Running OpenHands guide.

Security Note for Public Networks

• Harden your Docker installation: Follow the Hardened Docker Installation Guide to restrict network binding and implement additional security measures when using OpenHands on a public network.
• Protect your data: Secure your setup to prevent unauthorized access and ensure data integrity.

LLM Provider Selection & API Keys

Upon opening OpenHands, you'll need to select an LLM provider and enter your API key. Anthropic's Claude 3.5 Sonnet is highly recommended. The large selection allows you to experiment with the best model for your project.

Important Considerations: Single-User Local Workstation

• Designed for individual use: OpenHands is intended for use by a single user on their local machine.
• Not suitable for multi-tenant environments: It lacks built-in authentication, isolation, and scalability features.
• Advanced deployment options: Contact us for multi-tenant setups!

More Ways to Integrate OpenHands

• Local filesystem integration: Connect OpenHands directly to your files.
• Scriptable headless mode: Automate tasks through scripting.
• Friendly CLI: Interact with OpenHands via command line.
• GitHub Actions: Run on tagged issues.

Find detailed instructions and setup information on running OpenHands.

Need Help? Comprehensive Documentation & Troubleshooting

Explore the extensive documentation for in-depth information about OpenHands:

• LLM provider guides: Detailed instructions for various Language Model providers.
• Troubleshooting resources: Solutions to common problems and errors.
• Advanced configuration options: Customize OpenHands to your exact needs.

Having issues? The Troubleshooting Guide is your go-to resource.

Join the OpenHands Community Today

OpenHands thrives on community contributions. Get involved and shape the future of AI-driven software development!

• Slack: Join our Slack workspace for discussions about research, architecture, and future development.
• Discord: Connect on our community-run Discord server for general questions, feedback, and support.
• GitHub Issues: Contribute to ongoing projects or suggest new features through GitHub Issues.
• Details on contributing can be found in CONTRIBUTING.md.

Stay Updated: Monthly Roadmap

Track the project's progress and future plans in the monthly OpenHands roadmap. This roadmap is updated after the maintainer's meeting at the end of each month.

License Information

OpenHands is distributed under the MIT License. See LICENSE for more information.

Open Source Projects

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.

Key Takeaways

OpenHands offers a transformative approach to software development. By leveraging AI agents, developers can drastically reduce coding time, automate repetitive tasks, and focus on innovation. Whether through OpenHands Cloud or local installations, the platform is designed to enhance productivity and streamline workflows. The vibrant and collaborative community ensures continuous improvement and support, making OpenHands an essential tool for modern software development.