Skip to main content

💻 OpenDevin

OpenDevin is an autonomous AI software engineer capable of executing complex engineering tasks and collaborating actively with users on software development projects. This project is fully open-source, so you can use and modify it however you like.

tip

Explore the codebase of OpenDevin on GitHub or join one of our communities!

ContributorsForksStargazersIssues
MIT License
Join our Slack communityJoin our Discord community

🛠️ Getting Started

The easiest way to run OpenDevin is inside a Docker container.

To start the app, run these commands, replacing $(pwd)/workspace with the directory you want OpenDevin to work with.

# Your OpenAI API key, or any other LLM API key
export LLM_API_KEY="sk-..."
# The directory you want OpenDevin to modify.
# MUST be an absolute path!
export WORKSPACE_BASE=$(pwd)/workspace
warning

OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine. But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.

docker run \
-it \
--pull=always \
-e LLM_API_KEY \
-e SANDBOX_USER_ID=$(id -u) \
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
-v $WORKSPACE_BASE:/opt/workspace_base \
-v /var/run/docker.sock:/var/run/docker.sock \
-p 3000:3000 \
--add-host host.docker.internal:host-gateway \
ghcr.io/opendevin/opendevin:0.5

You'll find opendevin running at http://localhost:3000.

tip

If you want to use the (unstable!) bleeding edge, you can use ghcr.io/opendevin/opendevin:main as the image (last line).

See Development.md for instructions on running OpenDevin without Docker.

Having trouble? Check out our Troubleshooting Guide.

warning

OpenDevin is currently a work in progress, but you can already run the alpha version to see the end-to-end system in action.